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 in all subsequent file inclusions. FIXME: This inclusion can now
27 be removed from all files that include defs.h */
31 /* We could use the EXFUN macro in ansidecl.h to handle prototypes, but
32 the name is misleading the the result is ugly. So just define a simple
33 macro to handle the parameter lists. */
36 #define PARAMS(paramlist) paramlist
38 #define PARAMS(paramlist) ()
41 /* An address in the program being debugged. Host byte order. */
42 typedef unsigned int CORE_ADDR;
44 #define min(a, b) ((a) < (b) ? (a) : (b))
45 #define max(a, b) ((a) > (b) ? (a) : (b))
47 /* The character C++ uses to build identifiers that must be unique from
48 the program's identifiers (such as $this and $$vptr). */
49 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
51 #include <errno.h> /* System call error return status */
54 extern int immediate_quit;
59 #define QUIT { if (quit_flag) quit (); }
61 /* Notes on classes: class_alias is for alias commands which are not
62 abbreviations of the original command. */
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
74 /* the cleanup list records things that have to be undone
75 if an error happens (descriptors to be closed, memory to be freed, etc.)
76 Each link in the chain records a function to call and an
79 Use make_cleanup to add an element to the cleanup chain.
80 Use do_cleanups to do all cleanup actions back to a given
81 point in the chain. Use discard_cleanups to remove cleanups
82 from the chain back to a given point, not doing them. */
87 void (*function) PARAMS ((PTR));
91 /* From blockframe.c */
94 inside_entry_func PARAMS ((CORE_ADDR));
97 inside_entry_file PARAMS ((CORE_ADDR addr));
100 inside_main_func PARAMS ((CORE_ADDR pc));
102 /* From cplus-dem.c */
105 cplus_demangle PARAMS ((const char *, int));
108 cplus_mangle_opname PARAMS ((char *, int));
110 /* From libmmalloc.a (memory mapped malloc library) */
113 mmalloc_attach PARAMS ((int, PTR));
116 mmalloc_detach PARAMS ((PTR));
119 mmalloc PARAMS ((PTR, long));
122 mrealloc PARAMS ((PTR, PTR, long));
125 mfree PARAMS ((PTR, PTR));
128 mmalloc_setkey PARAMS ((PTR, int, PTR));
131 mmalloc_getkey PARAMS ((PTR, int));
136 demangle_and_match PARAMS ((const char *, const char *, int));
139 strcmp_iw PARAMS ((const char *, const char *));
142 safe_strerror PARAMS ((int));
145 safe_strsignal PARAMS ((int));
148 init_malloc PARAMS ((PTR));
151 request_quit PARAMS ((int));
154 do_cleanups PARAMS ((struct cleanup *));
157 discard_cleanups PARAMS ((struct cleanup *));
159 /* The bare make_cleanup function is one of those rare beasts that
160 takes almost any type of function as the first arg and anything that
161 will fit in a "void *" as the second arg.
163 Should be, once all calls and called-functions are cleaned up:
164 extern struct cleanup *
165 make_cleanup PARAMS ((void (*function) (PTR), PTR));
167 Until then, lint and/or various type-checking compiler options will
168 complain about make_cleanup calls. It'd be wrong to just cast things,
169 since the type actually passed when the function is called would be
172 extern struct cleanup *
175 extern struct cleanup *
176 save_cleanups PARAMS ((void));
179 restore_cleanups PARAMS ((struct cleanup *));
182 free_current_contents PARAMS ((char **));
185 null_cleanup PARAMS ((char **));
188 myread PARAMS ((int, char *, int));
194 wrap_here PARAMS ((char *));
197 reinitialize_more_filter PARAMS ((void));
200 print_insn PARAMS ((CORE_ADDR, FILE *));
203 fputs_filtered PARAMS ((const char *, FILE *));
206 puts_filtered PARAMS ((char *));
215 print_spaces PARAMS ((int, FILE *));
218 print_spaces_filtered PARAMS ((int, FILE *));
221 n_spaces PARAMS ((int));
224 printchar PARAMS ((int, FILE *, int));
227 fprint_symbol PARAMS ((FILE *, char *));
230 fputs_demangled PARAMS ((char *, FILE *, int));
233 perror_with_name PARAMS ((char *));
236 print_sys_errmsg PARAMS ((char *, int));
241 re_comp PARAMS ((char *));
246 symbol_file_command PARAMS ((char *, int));
251 skip_quoted PARAMS ((char *));
254 gdb_readline PARAMS ((char *));
257 command_line_input PARAMS ((char *, int));
260 print_prompt PARAMS ((void));
263 batch_mode PARAMS ((void));
266 input_from_terminal_p PARAMS ((void));
269 catch_errors PARAMS ((int (*) (char *), char *, char *));
271 /* From printcmd.c */
274 set_next_address PARAMS ((CORE_ADDR));
277 print_address_symbolic PARAMS ((CORE_ADDR, FILE *, int, char *));
280 print_address PARAMS ((CORE_ADDR, FILE *));
285 openp PARAMS ((char *, int, char *, int, int, char **));
288 mod_path PARAMS ((char *, char **));
291 directory_command PARAMS ((char *, int));
294 init_source_path PARAMS ((void));
299 read_relative_register_raw_bytes PARAMS ((int, char *));
301 /* From readline (but not in any readline .h files). */
304 tilde_expand PARAMS ((char *));
306 /* Structure for saved commands lines
307 (for breakpoints, defined commands, etc). */
311 struct command_line *next;
315 extern struct command_line *
316 read_command_lines PARAMS ((void));
319 free_command_lines PARAMS ((struct command_line **));
321 /* String containing the current directory (what getwd would return). */
323 extern char *current_directory;
325 /* Default radixes for input and output. Only some values supported. */
326 extern unsigned input_radix;
327 extern unsigned output_radix;
329 /* Baud rate specified for communication with serial target systems. */
330 extern char *baud_rate;
332 /* Languages represented in the symbol table and elsewhere. */
336 language_unknown, /* Language not known */
337 language_auto, /* Placeholder for automatic setting */
339 language_cplus, /* C++ */
340 language_m2 /* Modula-2 */
343 /* Return a format string for printf that will print a number in the local
344 (language-specific) hexadecimal format. Result is static and is
345 overwritten by the next call. local_hex_format_custom takes printf
346 options like "08" or "l" (to produce e.g. %08x or %lx). */
348 #define local_hex_format() (current_language->la_hex_format)
351 local_hex_format_custom PARAMS ((char *)); /* language.c */
353 /* Return a string that contains a number formatted in the local
354 (language-specific) hexadecimal format. Result is static and is
355 overwritten by the next call. local_hex_string_custom takes printf
356 options like "08" or "l". */
359 local_hex_string PARAMS ((int)); /* language.c */
362 local_hex_string_custom PARAMS ((int, char *)); /* language.c */
365 /* Host machine definition. This will be a symlink to one of the
366 xm-*.h files, built by the `configure' script. */
370 /* If the xm.h file did not define the mode string used to open the
371 files, assume that binary files are opened the same way as text
374 #include "fopen-same.h"
378 * Allow things in gdb to be declared "const". If compiling ANSI, it
379 * just works. If compiling with gcc but non-ansi, redefine to __const__.
380 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
381 * objects be read-write rather than read-only.
387 # define const __const__
389 # define const /*nothing*/
397 # define volatile __volatile__
399 # define volatile /*nothing*/
402 #endif /* volatile */
404 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
405 declarations of functions that never return (exit for instance) as
406 "volatile void". For such compilers "NORETURN" can be defined away
407 to keep them happy */
410 # define NORETURN volatile
413 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
415 #if !defined (UINT_MAX)
416 #define UINT_MAX 0xffffffff
419 #if !defined (LONG_MAX)
420 #define LONG_MAX 0x7fffffff
423 #if !defined (INT_MAX)
424 #define INT_MAX 0x7fffffff
427 #if !defined (INT_MIN)
428 /* Two's complement, 32 bit. */
429 #define INT_MIN -0x80000000
432 /* Number of bits in a char or unsigned char for the target machine.
433 Just like CHAR_BIT in <limits.h> but describes the target machine. */
434 #if !defined (TARGET_CHAR_BIT)
435 #define TARGET_CHAR_BIT 8
438 /* Number of bits in a short or unsigned short for the target machine. */
439 #if !defined (TARGET_SHORT_BIT)
440 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
443 /* Number of bits in an int or unsigned int for the target machine. */
444 #if !defined (TARGET_INT_BIT)
445 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
448 /* Number of bits in a long or unsigned long for the target machine. */
449 #if !defined (TARGET_LONG_BIT)
450 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
453 /* Number of bits in a long long or unsigned long long for the target machine. */
454 #if !defined (TARGET_LONG_LONG_BIT)
455 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
458 /* Number of bits in a float for the target machine. */
459 #if !defined (TARGET_FLOAT_BIT)
460 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
463 /* Number of bits in a double for the target machine. */
464 #if !defined (TARGET_DOUBLE_BIT)
465 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
468 /* Number of bits in a long double for the target machine. */
469 #if !defined (TARGET_LONG_DOUBLE_BIT)
470 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
473 /* Number of bits in a "complex" for the target machine. */
474 #if !defined (TARGET_COMPLEX_BIT)
475 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
478 /* Number of bits in a "double complex" for the target machine. */
479 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
480 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
483 /* Number of bits in a pointer for the target machine */
484 #if !defined (TARGET_PTR_BIT)
485 #define TARGET_PTR_BIT TARGET_INT_BIT
488 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
489 of arguments to a function, number in a value history, register
490 number, etc.) where the value must not be larger than can fit
492 #if !defined (longest_to_int)
493 #if defined (LONG_LONG)
494 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
495 ? error ("Value out of range.") : (int) (x))
496 #else /* No LONG_LONG. */
497 /* Assume sizeof (int) == sizeof (long). */
498 #define longest_to_int(x) ((int) (x))
499 #endif /* No LONG_LONG. */
500 #endif /* No longest_to_int. */
502 /* This should not be a typedef, because "unsigned LONGEST" needs
503 to work. LONG_LONG is defined if the host has "long long". */
507 # define LONGEST long long
509 # define LONGEST long
513 /* Assorted functions we can declare, now that const and volatile are
517 savestring PARAMS ((const char *, int));
520 msavestring PARAMS ((void *, const char *, int));
523 strsave PARAMS ((const char *));
526 mstrsave PARAMS ((void *, const char *));
529 concat PARAMS ((char *, ...));
532 xmalloc PARAMS ((long));
535 xrealloc PARAMS ((PTR, long));
538 xmmalloc PARAMS ((PTR, long));
541 xmrealloc PARAMS ((PTR, PTR, long));
544 mmalloc PARAMS ((PTR, long));
547 mrealloc PARAMS ((PTR, PTR, long));
550 mfree PARAMS ((PTR, PTR));
553 mmcheck PARAMS ((PTR, void (*) (void)));
556 mmtrace PARAMS ((void));
559 parse_escape PARAMS ((char **));
561 extern char *reg_names[];
563 extern NORETURN void /* Does not return to the caller. */
566 extern NORETURN void /* Does not return to the caller. */
569 extern NORETURN void /* Not specified as volatile in ... */
570 exit PARAMS ((int)); /* 4.10.4.3 */
572 extern NORETURN void /* Does not return to the caller. */
573 nomem PARAMS ((long));
575 extern NORETURN void /* Does not return to the caller. */
576 return_to_top_level PARAMS ((void));
579 warning_setup PARAMS ((void));
584 /* Global functions from other, non-gdb GNU thingies (libiberty for
588 basename PARAMS ((char *));
591 getenv PARAMS ((CONST char *));
594 buildargv PARAMS ((char *));
597 freeargv PARAMS ((char **));
600 strerrno PARAMS ((int));
603 strsigno PARAMS ((int));
606 errno_max PARAMS ((void));
609 signo_max PARAMS ((void));
612 strtoerrno PARAMS ((char *));
615 strtosigno PARAMS ((char *));
618 strsignal PARAMS ((int));
620 /* From other system libraries */
622 #ifndef PSIGNAL_IN_SIGNAL_H
624 psignal PARAMS ((unsigned, char *));
627 /* For now, we can't include <stdlib.h> because it conflicts with
628 "../include/getopt.h". (FIXME)
630 However, if a function is defined in the ANSI C standard and a prototype
631 for that function is defined and visible in any header file in an ANSI
632 conforming environment, then that prototype must match the definition in
633 the ANSI standard. So we can just duplicate them here without conflict,
634 since they must be the same in all conforming ANSI environments. If
635 these cause problems, then the environment is not ANSI conformant. */
642 fclose PARAMS ((FILE *stream)); /* 4.9.5.1 */
645 perror PARAMS ((const char *)); /* 4.9.10.4 */
648 atof PARAMS ((const char *nptr)); /* 4.10.1.1 */
650 #ifndef MALLOC_INCOMPATIBLE
653 malloc PARAMS ((size_t size)); /* 4.10.3.3 */
656 realloc PARAMS ((void *ptr, size_t size)); /* 4.10.3.4 */
659 free PARAMS ((void *)); /* 4.10.3.2 */
661 #endif /* MALLOC_INCOMPATIBLE */
664 qsort PARAMS ((void *base, size_t nmemb, /* 4.10.5.2 */
666 int (*comp)(const void *, const void *)));
669 strchr PARAMS ((const char *, int)); /* 4.11.5.2 */
672 strrchr PARAMS ((const char *, int)); /* 4.11.5.5 */
675 strstr PARAMS ((const char *, const char *)); /* 4.11.5.7 */
678 strtok PARAMS ((char *, const char *)); /* 4.11.5.8 */
681 strerror PARAMS ((int)); /* 4.11.6.2 */
683 /* Various possibilities for alloca. */
686 # define alloca __builtin_alloca
691 extern char *alloca ();
695 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER should be defined to one of these. */
697 #if !defined (BIG_ENDIAN)
698 #define BIG_ENDIAN 4321
701 #if !defined (LITTLE_ENDIAN)
702 #define LITTLE_ENDIAN 1234
705 /* Target-system-dependent parameters for GDB.
707 The standard thing is to include defs.h. However, files that are
708 specific to a particular target can define TM_FILE_OVERRIDE before
709 including defs.h, then can include any particular tm-file they desire. */
711 /* Target machine definition. This will be a symlink to one of the
712 tm-*.h files, built by the `configure' script. */
714 #ifndef TM_FILE_OVERRIDE
718 /* The bit byte-order has to do just with numbering of bits in
719 debugging symbols and such. Conceptually, it's quite separate
720 from byte/word byte order. */
722 #if !defined (BITS_BIG_ENDIAN)
723 #if TARGET_BYTE_ORDER == BIG_ENDIAN
724 #define BITS_BIG_ENDIAN 1
725 #endif /* Big endian. */
727 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
728 #define BITS_BIG_ENDIAN 0
729 #endif /* Little endian. */
730 #endif /* BITS_BIG_ENDIAN not defined. */
732 /* Swap LEN bytes at BUFFER between target and host byte-order. */
733 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
734 #define SWAP_TARGET_AND_HOST(buffer,len)
735 #else /* Target and host byte order differ. */
736 #define SWAP_TARGET_AND_HOST(buffer,len) \
739 char *p = (char *)(buffer); \
740 char *q = ((char *)(buffer)) + len - 1; \
741 for (; p < q; p++, q--) \
748 #endif /* Target and host byte order differ. */
750 /* On some machines there are bits in addresses which are not really
751 part of the address, but are used by the kernel, the hardware, etc.
752 for special purposes. ADDR_BITS_REMOVE takes out any such bits
753 so we get a "real" address such as one would find in a symbol
754 table. ADDR_BITS_SET sets those bits the way the system wants
756 #if !defined (ADDR_BITS_REMOVE)
757 #define ADDR_BITS_REMOVE(addr) (addr)
758 #define ADDR_BITS_SET(addr) (addr)
759 #endif /* No ADDR_BITS_REMOVE. */
764 push_bytes PARAMS ((CORE_ADDR, char *, int));
766 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
767 must avoid prototyping this function for now. FIXME. Should be:
769 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
774 #endif /* !defined (DEFS_H) */