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 /* Notes on classes: class_alias is for alias commands which are not
51 abbreviations of the original command. */
55 /* Special args to help_list */
56 all_classes = -2, all_commands = -1,
57 /* Classes of commands */
58 no_class = -1, class_run = 0, class_vars, class_stack,
59 class_files, class_support, class_info, class_breakpoint,
60 class_alias, class_obscure, class_user, class_maintenance
63 /* the cleanup list records things that have to be undone
64 if an error happens (descriptors to be closed, memory to be freed, etc.)
65 Each link in the chain records a function to call and an
68 Use make_cleanup to add an element to the cleanup chain.
69 Use do_cleanups to do all cleanup actions back to a given
70 point in the chain. Use discard_cleanups to remove cleanups
71 from the chain back to a given point, not doing them. */
76 void (*function) PARAMS ((PTR));
80 /* From blockframe.c */
83 inside_entry_func PARAMS ((CORE_ADDR));
86 inside_entry_file PARAMS ((CORE_ADDR addr));
89 inside_main_func PARAMS ((CORE_ADDR pc));
91 /* From cplus-dem.c */
94 cplus_demangle PARAMS ((const char *, int));
97 cplus_mangle_opname PARAMS ((char *, int));
99 /* From libmmalloc.a (memory mapped malloc library) */
102 mmalloc_attach PARAMS ((int, PTR));
105 mmalloc_detach PARAMS ((PTR));
108 mmalloc PARAMS ((PTR, long));
111 mrealloc PARAMS ((PTR, PTR, long));
114 mfree PARAMS ((PTR, PTR));
117 mmalloc_setkey PARAMS ((PTR, int, PTR));
120 mmalloc_getkey PARAMS ((PTR, int));
125 demangle_and_match PARAMS ((const char *, const char *, int));
128 strcmp_iw PARAMS ((const char *, const char *));
131 safe_strerror PARAMS ((int));
134 safe_strsignal PARAMS ((int));
137 init_malloc PARAMS ((PTR));
140 request_quit PARAMS ((int));
143 do_cleanups PARAMS ((struct cleanup *));
146 discard_cleanups PARAMS ((struct cleanup *));
148 /* The bare make_cleanup function is one of those rare beasts that
149 takes almost any type of function as the first arg and anything that
150 will fit in a "void *" as the second arg.
152 Should be, once all calls and called-functions are cleaned up:
153 extern struct cleanup *
154 make_cleanup PARAMS ((void (*function) (PTR), PTR));
156 Until then, lint and/or various type-checking compiler options will
157 complain about make_cleanup calls. It'd be wrong to just cast things,
158 since the type actually passed when the function is called would be
161 extern struct cleanup *
164 extern struct cleanup *
165 save_cleanups PARAMS ((void));
168 restore_cleanups PARAMS ((struct cleanup *));
171 free_current_contents PARAMS ((char **));
174 null_cleanup PARAMS ((char **));
177 myread PARAMS ((int, char *, int));
183 wrap_here PARAMS ((char *));
186 reinitialize_more_filter PARAMS ((void));
189 print_insn PARAMS ((CORE_ADDR, FILE *));
192 fputs_filtered PARAMS ((const char *, FILE *));
195 puts_filtered PARAMS ((char *));
198 vfprintf_filtered ();
204 fprintfi_filtered ();
213 print_spaces PARAMS ((int, FILE *));
216 print_spaces_filtered PARAMS ((int, FILE *));
219 n_spaces PARAMS ((int));
222 printchar PARAMS ((int, FILE *, int));
225 strdup_demangled PARAMS ((const char *));
228 fprint_symbol PARAMS ((FILE *, char *));
231 fputs_demangled PARAMS ((char *, FILE *, int));
234 perror_with_name PARAMS ((char *));
237 print_sys_errmsg PARAMS ((char *, int));
242 re_comp PARAMS ((char *));
247 symbol_file_command PARAMS ((char *, int));
252 skip_quoted PARAMS ((char *));
255 gdb_readline PARAMS ((char *));
258 command_line_input PARAMS ((char *, int));
261 print_prompt PARAMS ((void));
264 batch_mode PARAMS ((void));
267 input_from_terminal_p PARAMS ((void));
270 catch_errors PARAMS ((int (*) (char *), char *, char *));
272 /* From printcmd.c */
275 set_next_address PARAMS ((CORE_ADDR));
278 print_address_symbolic PARAMS ((CORE_ADDR, FILE *, int, char *));
281 print_address PARAMS ((CORE_ADDR, FILE *));
286 openp PARAMS ((char *, int, char *, int, int, char **));
289 mod_path PARAMS ((char *, char **));
292 directory_command PARAMS ((char *, int));
295 init_source_path PARAMS ((void));
300 read_relative_register_raw_bytes PARAMS ((int, char *));
302 /* From readline (but not in any readline .h files). */
305 tilde_expand PARAMS ((char *));
307 /* Structure for saved commands lines
308 (for breakpoints, defined commands, etc). */
312 struct command_line *next;
316 extern struct command_line *
317 read_command_lines PARAMS ((void));
320 free_command_lines PARAMS ((struct command_line **));
322 /* String containing the current directory (what getwd would return). */
324 extern char *current_directory;
326 /* Default radixes for input and output. Only some values supported. */
327 extern unsigned input_radix;
328 extern unsigned output_radix;
330 /* Baud rate specified for communication with serial target systems. */
331 extern char *baud_rate;
333 /* Languages represented in the symbol table and elsewhere. */
337 language_unknown, /* Language not known */
338 language_auto, /* Placeholder for automatic setting */
340 language_cplus, /* C++ */
341 language_m2 /* Modula-2 */
344 /* Return a format string for printf that will print a number in the local
345 (language-specific) hexadecimal format. Result is static and is
346 overwritten by the next call. local_hex_format_custom takes printf
347 options like "08" or "l" (to produce e.g. %08x or %lx). */
349 #define local_hex_format() (current_language->la_hex_format)
352 local_hex_format_custom PARAMS ((char *)); /* language.c */
354 /* Return a string that contains a number formatted in the local
355 (language-specific) hexadecimal format. Result is static and is
356 overwritten by the next call. local_hex_string_custom takes printf
357 options like "08" or "l". */
360 local_hex_string PARAMS ((int)); /* language.c */
363 local_hex_string_custom PARAMS ((int, char *)); /* language.c */
366 /* Host machine definition. This will be a symlink to one of the
367 xm-*.h files, built by the `configure' script. */
371 /* If the xm.h file did not define the mode string used to open the
372 files, assume that binary files are opened the same way as text
375 #include "fopen-same.h"
379 * Allow things in gdb to be declared "const". If compiling ANSI, it
380 * just works. If compiling with gcc but non-ansi, redefine to __const__.
381 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
382 * objects be read-write rather than read-only.
388 # define const __const__
390 # define const /*nothing*/
398 # define volatile __volatile__
400 # define volatile /*nothing*/
403 #endif /* volatile */
405 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
406 declarations of functions that never return (exit for instance) as
407 "volatile void". For such compilers "NORETURN" can be defined away
408 to keep them happy */
412 # define NORETURN /*nothing*/
414 # define NORETURN volatile
418 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
420 #if !defined (UINT_MAX)
421 #define UINT_MAX 0xffffffff
424 #if !defined (LONG_MAX)
425 #define LONG_MAX 0x7fffffff
428 #if !defined (INT_MAX)
429 #define INT_MAX 0x7fffffff
432 #if !defined (INT_MIN)
433 /* Two's complement, 32 bit. */
434 #define INT_MIN -0x80000000
437 /* Number of bits in a char or unsigned char for the target machine.
438 Just like CHAR_BIT in <limits.h> but describes the target machine. */
439 #if !defined (TARGET_CHAR_BIT)
440 #define TARGET_CHAR_BIT 8
443 /* Number of bits in a short or unsigned short for the target machine. */
444 #if !defined (TARGET_SHORT_BIT)
445 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
448 /* Number of bits in an int or unsigned int for the target machine. */
449 #if !defined (TARGET_INT_BIT)
450 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
453 /* Number of bits in a long or unsigned long for the target machine. */
454 #if !defined (TARGET_LONG_BIT)
455 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
458 /* Number of bits in a long long or unsigned long long for the target machine. */
459 #if !defined (TARGET_LONG_LONG_BIT)
460 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
463 /* Number of bits in a float for the target machine. */
464 #if !defined (TARGET_FLOAT_BIT)
465 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
468 /* Number of bits in a double for the target machine. */
469 #if !defined (TARGET_DOUBLE_BIT)
470 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
473 /* Number of bits in a long double for the target machine. */
474 #if !defined (TARGET_LONG_DOUBLE_BIT)
475 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
478 /* Number of bits in a "complex" for the target machine. */
479 #if !defined (TARGET_COMPLEX_BIT)
480 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
483 /* Number of bits in a "double complex" for the target machine. */
484 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
485 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
488 /* Number of bits in a pointer for the target machine */
489 #if !defined (TARGET_PTR_BIT)
490 #define TARGET_PTR_BIT TARGET_INT_BIT
493 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
494 of arguments to a function, number in a value history, register
495 number, etc.) where the value must not be larger than can fit
497 #if !defined (longest_to_int)
498 #if defined (LONG_LONG)
499 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
500 ? (error ("Value out of range."),0) : (int) (x))
501 #else /* No LONG_LONG. */
502 /* Assume sizeof (int) == sizeof (long). */
503 #define longest_to_int(x) ((int) (x))
504 #endif /* No LONG_LONG. */
505 #endif /* No longest_to_int. */
507 /* This should not be a typedef, because "unsigned LONGEST" needs
508 to work. LONG_LONG is defined if the host has "long long". */
512 # define LONGEST long long
514 # define LONGEST long
518 /* Assorted functions we can declare, now that const and volatile are
522 savestring PARAMS ((const char *, int));
525 msavestring PARAMS ((void *, const char *, int));
528 strsave PARAMS ((const char *));
531 mstrsave PARAMS ((void *, const char *));
534 concat PARAMS ((char *, ...));
537 xmalloc PARAMS ((long));
540 xrealloc PARAMS ((PTR, long));
543 xmmalloc PARAMS ((PTR, long));
546 xmrealloc PARAMS ((PTR, PTR, long));
549 mmalloc PARAMS ((PTR, long));
552 mrealloc PARAMS ((PTR, PTR, long));
555 mfree PARAMS ((PTR, PTR));
558 mmcheck PARAMS ((PTR, void (*) (void)));
561 mmtrace PARAMS ((void));
564 parse_escape PARAMS ((char **));
566 extern const char * const reg_names[];
568 extern NORETURN void /* Does not return to the caller. */
571 extern NORETURN void /* Does not return to the caller. */
574 extern NORETURN void /* Not specified as volatile in ... */
575 exit PARAMS ((int)); /* 4.10.4.3 */
577 extern NORETURN void /* Does not return to the caller. */
578 nomem PARAMS ((long));
580 extern NORETURN void /* Does not return to the caller. */
581 return_to_top_level PARAMS ((void));
584 warning_setup PARAMS ((void));
589 /* Global functions from other, non-gdb GNU thingies (libiberty for
593 basename PARAMS ((char *));
596 getenv PARAMS ((const char *));
599 buildargv PARAMS ((char *));
602 freeargv PARAMS ((char **));
605 strerrno PARAMS ((int));
608 strsigno PARAMS ((int));
611 errno_max PARAMS ((void));
614 signo_max PARAMS ((void));
617 strtoerrno PARAMS ((char *));
620 strtosigno PARAMS ((char *));
623 strsignal PARAMS ((int));
625 /* From other system libraries */
627 #ifndef PSIGNAL_IN_SIGNAL_H
629 psignal PARAMS ((unsigned, char *));
632 /* For now, we can't include <stdlib.h> because it conflicts with
633 "../include/getopt.h". (FIXME)
635 However, if a function is defined in the ANSI C standard and a prototype
636 for that function is defined and visible in any header file in an ANSI
637 conforming environment, then that prototype must match the definition in
638 the ANSI standard. So we can just duplicate them here without conflict,
639 since they must be the same in all conforming ANSI environments. If
640 these cause problems, then the environment is not ANSI conformant. */
647 fclose PARAMS ((FILE *stream)); /* 4.9.5.1 */
650 perror PARAMS ((const char *)); /* 4.9.10.4 */
653 atof PARAMS ((const char *nptr)); /* 4.10.1.1 */
656 atoi PARAMS ((const char *)); /* 4.10.1.2 */
658 #ifndef MALLOC_INCOMPATIBLE
661 malloc PARAMS ((size_t size)); /* 4.10.3.3 */
664 realloc PARAMS ((void *ptr, size_t size)); /* 4.10.3.4 */
667 free PARAMS ((void *)); /* 4.10.3.2 */
669 #endif /* MALLOC_INCOMPATIBLE */
672 qsort PARAMS ((void *base, size_t nmemb, /* 4.10.5.2 */
674 int (*comp)(const void *, const void *)));
676 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
678 memcpy PARAMS ((void *, const void *, size_t)); /* 4.11.2.1 */
682 memcmp PARAMS ((const void *, const void *, size_t)); /* 4.11.4.1 */
685 strchr PARAMS ((const char *, int)); /* 4.11.5.2 */
688 strrchr PARAMS ((const char *, int)); /* 4.11.5.5 */
691 strstr PARAMS ((const char *, const char *)); /* 4.11.5.7 */
694 strtok PARAMS ((char *, const char *)); /* 4.11.5.8 */
696 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
698 memset PARAMS ((void *, int, size_t)); /* 4.11.6.1 */
702 strerror PARAMS ((int)); /* 4.11.6.2 */
704 /* Various possibilities for alloca. */
707 # define alloca __builtin_alloca
710 # include <alloca.h> /* NOTE: Doesn't declare alloca() */
713 extern void *alloca (size_t);
714 # else /* __STDC__ */
715 extern char *alloca ();
720 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these. */
722 #if !defined (BIG_ENDIAN)
723 #define BIG_ENDIAN 4321
726 #if !defined (LITTLE_ENDIAN)
727 #define LITTLE_ENDIAN 1234
730 /* Target-system-dependent parameters for GDB.
732 The standard thing is to include defs.h. However, files that are
733 specific to a particular target can define TM_FILE_OVERRIDE before
734 including defs.h, then can include any particular tm-file they desire. */
736 /* Target machine definition. This will be a symlink to one of the
737 tm-*.h files, built by the `configure' script. */
739 #ifndef TM_FILE_OVERRIDE
743 /* The bit byte-order has to do just with numbering of bits in
744 debugging symbols and such. Conceptually, it's quite separate
745 from byte/word byte order. */
747 #if !defined (BITS_BIG_ENDIAN)
748 #if TARGET_BYTE_ORDER == BIG_ENDIAN
749 #define BITS_BIG_ENDIAN 1
750 #endif /* Big endian. */
752 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
753 #define BITS_BIG_ENDIAN 0
754 #endif /* Little endian. */
755 #endif /* BITS_BIG_ENDIAN not defined. */
757 /* Swap LEN bytes at BUFFER between target and host byte-order. */
758 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
759 #define SWAP_TARGET_AND_HOST(buffer,len)
760 #else /* Target and host byte order differ. */
761 #define SWAP_TARGET_AND_HOST(buffer,len) \
764 char *p = (char *)(buffer); \
765 char *q = ((char *)(buffer)) + len - 1; \
766 for (; p < q; p++, q--) \
773 #endif /* Target and host byte order differ. */
775 /* On some machines there are bits in addresses which are not really
776 part of the address, but are used by the kernel, the hardware, etc.
777 for special purposes. ADDR_BITS_REMOVE takes out any such bits
778 so we get a "real" address such as one would find in a symbol
779 table. ADDR_BITS_SET sets those bits the way the system wants
781 #if !defined (ADDR_BITS_REMOVE)
782 #define ADDR_BITS_REMOVE(addr) (addr)
783 #define ADDR_BITS_SET(addr) (addr)
784 #endif /* No ADDR_BITS_REMOVE. */
789 push_bytes PARAMS ((CORE_ADDR, char *, int));
791 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
792 must avoid prototyping this function for now. FIXME. Should be:
794 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
799 /* Some parts of gdb might be considered optional, in the sense that they
800 are not essential for being able to build a working, usable debugger
801 for a specific environment. For example, the maintenance commands
802 are there for the benefit of gdb maintainers. As another example,
803 some environments really don't need gdb's that are able to read N
804 different object file formats. In order to make it possible (but
805 not necessarily recommended) to build "stripped down" versions of
806 gdb, the following defines control selective compilation of those
807 parts of gdb which can be safely left out when necessary. Note that
808 the default is to include everything. */
810 #ifndef MAINTENANCE_CMDS
811 #define MAINTENANCE_CMDS 1
814 #include "energize.h"
816 #endif /* !defined (DEFS_H) */