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 strdup_demangled PARAMS ((const char *));
230 fprint_symbol PARAMS ((FILE *, char *));
233 fputs_demangled PARAMS ((char *, FILE *, int));
236 perror_with_name PARAMS ((char *));
239 print_sys_errmsg PARAMS ((char *, int));
244 re_comp PARAMS ((char *));
249 symbol_file_command PARAMS ((char *, int));
254 skip_quoted PARAMS ((char *));
257 gdb_readline PARAMS ((char *));
260 command_line_input PARAMS ((char *, int));
263 print_prompt PARAMS ((void));
266 batch_mode PARAMS ((void));
269 input_from_terminal_p PARAMS ((void));
272 catch_errors PARAMS ((int (*) (char *), char *, char *));
274 /* From printcmd.c */
277 set_next_address PARAMS ((CORE_ADDR));
280 print_address_symbolic PARAMS ((CORE_ADDR, FILE *, int, char *));
283 print_address PARAMS ((CORE_ADDR, FILE *));
288 openp PARAMS ((char *, int, char *, int, int, char **));
291 mod_path PARAMS ((char *, char **));
294 directory_command PARAMS ((char *, int));
297 init_source_path PARAMS ((void));
302 read_relative_register_raw_bytes PARAMS ((int, char *));
304 /* From readline (but not in any readline .h files). */
307 tilde_expand PARAMS ((char *));
309 /* Structure for saved commands lines
310 (for breakpoints, defined commands, etc). */
314 struct command_line *next;
318 extern struct command_line *
319 read_command_lines PARAMS ((void));
322 free_command_lines PARAMS ((struct command_line **));
324 /* String containing the current directory (what getwd would return). */
326 extern char *current_directory;
328 /* Default radixes for input and output. Only some values supported. */
329 extern unsigned input_radix;
330 extern unsigned output_radix;
332 /* Baud rate specified for communication with serial target systems. */
333 extern char *baud_rate;
335 /* Languages represented in the symbol table and elsewhere. */
339 language_unknown, /* Language not known */
340 language_auto, /* Placeholder for automatic setting */
342 language_cplus, /* C++ */
343 language_m2 /* Modula-2 */
346 /* Return a format string for printf that will print a number in the local
347 (language-specific) hexadecimal format. Result is static and is
348 overwritten by the next call. local_hex_format_custom takes printf
349 options like "08" or "l" (to produce e.g. %08x or %lx). */
351 #define local_hex_format() (current_language->la_hex_format)
354 local_hex_format_custom PARAMS ((char *)); /* language.c */
356 /* Return a string that contains a number formatted in the local
357 (language-specific) hexadecimal format. Result is static and is
358 overwritten by the next call. local_hex_string_custom takes printf
359 options like "08" or "l". */
362 local_hex_string PARAMS ((int)); /* language.c */
365 local_hex_string_custom PARAMS ((int, char *)); /* language.c */
368 /* Host machine definition. This will be a symlink to one of the
369 xm-*.h files, built by the `configure' script. */
373 /* If the xm.h file did not define the mode string used to open the
374 files, assume that binary files are opened the same way as text
377 #include "fopen-same.h"
381 * Allow things in gdb to be declared "const". If compiling ANSI, it
382 * just works. If compiling with gcc but non-ansi, redefine to __const__.
383 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
384 * objects be read-write rather than read-only.
390 # define const __const__
392 # define const /*nothing*/
400 # define volatile __volatile__
402 # define volatile /*nothing*/
405 #endif /* volatile */
407 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
408 declarations of functions that never return (exit for instance) as
409 "volatile void". For such compilers "NORETURN" can be defined away
410 to keep them happy */
414 # define NORETURN /*nothing*/
416 # define NORETURN volatile
420 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
422 #if !defined (UINT_MAX)
423 #define UINT_MAX 0xffffffff
426 #if !defined (LONG_MAX)
427 #define LONG_MAX 0x7fffffff
430 #if !defined (INT_MAX)
431 #define INT_MAX 0x7fffffff
434 #if !defined (INT_MIN)
435 /* Two's complement, 32 bit. */
436 #define INT_MIN -0x80000000
439 /* Number of bits in a char or unsigned char for the target machine.
440 Just like CHAR_BIT in <limits.h> but describes the target machine. */
441 #if !defined (TARGET_CHAR_BIT)
442 #define TARGET_CHAR_BIT 8
445 /* Number of bits in a short or unsigned short for the target machine. */
446 #if !defined (TARGET_SHORT_BIT)
447 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
450 /* Number of bits in an int or unsigned int for the target machine. */
451 #if !defined (TARGET_INT_BIT)
452 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
455 /* Number of bits in a long or unsigned long for the target machine. */
456 #if !defined (TARGET_LONG_BIT)
457 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
460 /* Number of bits in a long long or unsigned long long for the target machine. */
461 #if !defined (TARGET_LONG_LONG_BIT)
462 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
465 /* Number of bits in a float for the target machine. */
466 #if !defined (TARGET_FLOAT_BIT)
467 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
470 /* Number of bits in a double for the target machine. */
471 #if !defined (TARGET_DOUBLE_BIT)
472 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
475 /* Number of bits in a long double for the target machine. */
476 #if !defined (TARGET_LONG_DOUBLE_BIT)
477 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
480 /* Number of bits in a "complex" for the target machine. */
481 #if !defined (TARGET_COMPLEX_BIT)
482 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
485 /* Number of bits in a "double complex" for the target machine. */
486 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
487 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
490 /* Number of bits in a pointer for the target machine */
491 #if !defined (TARGET_PTR_BIT)
492 #define TARGET_PTR_BIT TARGET_INT_BIT
495 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
496 of arguments to a function, number in a value history, register
497 number, etc.) where the value must not be larger than can fit
499 #if !defined (longest_to_int)
500 #if defined (LONG_LONG)
501 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
502 ? (error ("Value out of range."),0) : (int) (x))
503 #else /* No LONG_LONG. */
504 /* Assume sizeof (int) == sizeof (long). */
505 #define longest_to_int(x) ((int) (x))
506 #endif /* No LONG_LONG. */
507 #endif /* No longest_to_int. */
509 /* This should not be a typedef, because "unsigned LONGEST" needs
510 to work. LONG_LONG is defined if the host has "long long". */
514 # define LONGEST long long
516 # define LONGEST long
520 /* Assorted functions we can declare, now that const and volatile are
524 savestring PARAMS ((const char *, int));
527 msavestring PARAMS ((void *, const char *, int));
530 strsave PARAMS ((const char *));
533 mstrsave PARAMS ((void *, const char *));
536 concat PARAMS ((char *, ...));
539 xmalloc PARAMS ((long));
542 xrealloc PARAMS ((PTR, long));
545 xmmalloc PARAMS ((PTR, long));
548 xmrealloc PARAMS ((PTR, PTR, long));
551 mmalloc PARAMS ((PTR, long));
554 mrealloc PARAMS ((PTR, PTR, long));
557 mfree PARAMS ((PTR, PTR));
560 mmcheck PARAMS ((PTR, void (*) (void)));
563 mmtrace PARAMS ((void));
566 parse_escape PARAMS ((char **));
568 extern const char * const reg_names[];
570 extern NORETURN void /* Does not return to the caller. */
573 extern NORETURN void /* Does not return to the caller. */
576 extern NORETURN void /* Not specified as volatile in ... */
577 exit PARAMS ((int)); /* 4.10.4.3 */
579 extern NORETURN void /* Does not return to the caller. */
580 nomem PARAMS ((long));
582 extern NORETURN void /* Does not return to the caller. */
583 return_to_top_level PARAMS ((void));
586 warning_setup PARAMS ((void));
591 /* Global functions from other, non-gdb GNU thingies (libiberty for
595 basename PARAMS ((char *));
598 getenv PARAMS ((CONST char *));
601 buildargv PARAMS ((char *));
604 freeargv PARAMS ((char **));
607 strerrno PARAMS ((int));
610 strsigno PARAMS ((int));
613 errno_max PARAMS ((void));
616 signo_max PARAMS ((void));
619 strtoerrno PARAMS ((char *));
622 strtosigno PARAMS ((char *));
625 strsignal PARAMS ((int));
627 /* From other system libraries */
629 #ifndef PSIGNAL_IN_SIGNAL_H
631 psignal PARAMS ((unsigned, char *));
634 /* For now, we can't include <stdlib.h> because it conflicts with
635 "../include/getopt.h". (FIXME)
637 However, if a function is defined in the ANSI C standard and a prototype
638 for that function is defined and visible in any header file in an ANSI
639 conforming environment, then that prototype must match the definition in
640 the ANSI standard. So we can just duplicate them here without conflict,
641 since they must be the same in all conforming ANSI environments. If
642 these cause problems, then the environment is not ANSI conformant. */
649 fclose PARAMS ((FILE *stream)); /* 4.9.5.1 */
652 perror PARAMS ((const char *)); /* 4.9.10.4 */
655 atof PARAMS ((const char *nptr)); /* 4.10.1.1 */
657 #ifndef MALLOC_INCOMPATIBLE
660 malloc PARAMS ((size_t size)); /* 4.10.3.3 */
663 realloc PARAMS ((void *ptr, size_t size)); /* 4.10.3.4 */
666 free PARAMS ((void *)); /* 4.10.3.2 */
668 #endif /* MALLOC_INCOMPATIBLE */
671 qsort PARAMS ((void *base, size_t nmemb, /* 4.10.5.2 */
673 int (*comp)(const void *, const void *)));
676 strchr PARAMS ((const char *, int)); /* 4.11.5.2 */
679 strrchr PARAMS ((const char *, int)); /* 4.11.5.5 */
682 strstr PARAMS ((const char *, const char *)); /* 4.11.5.7 */
685 strtok PARAMS ((char *, const char *)); /* 4.11.5.8 */
688 strerror PARAMS ((int)); /* 4.11.6.2 */
690 /* Various possibilities for alloca. */
693 # define alloca __builtin_alloca
698 # ifndef alloca /* May be macro, with args, in <alloca.h> */
699 extern char *alloca ();
704 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER should be defined to one of these. */
706 #if !defined (BIG_ENDIAN)
707 #define BIG_ENDIAN 4321
710 #if !defined (LITTLE_ENDIAN)
711 #define LITTLE_ENDIAN 1234
714 /* Target-system-dependent parameters for GDB.
716 The standard thing is to include defs.h. However, files that are
717 specific to a particular target can define TM_FILE_OVERRIDE before
718 including defs.h, then can include any particular tm-file they desire. */
720 /* Target machine definition. This will be a symlink to one of the
721 tm-*.h files, built by the `configure' script. */
723 #ifndef TM_FILE_OVERRIDE
727 /* The bit byte-order has to do just with numbering of bits in
728 debugging symbols and such. Conceptually, it's quite separate
729 from byte/word byte order. */
731 #if !defined (BITS_BIG_ENDIAN)
732 #if TARGET_BYTE_ORDER == BIG_ENDIAN
733 #define BITS_BIG_ENDIAN 1
734 #endif /* Big endian. */
736 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
737 #define BITS_BIG_ENDIAN 0
738 #endif /* Little endian. */
739 #endif /* BITS_BIG_ENDIAN not defined. */
741 /* Swap LEN bytes at BUFFER between target and host byte-order. */
742 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
743 #define SWAP_TARGET_AND_HOST(buffer,len)
744 #else /* Target and host byte order differ. */
745 #define SWAP_TARGET_AND_HOST(buffer,len) \
748 char *p = (char *)(buffer); \
749 char *q = ((char *)(buffer)) + len - 1; \
750 for (; p < q; p++, q--) \
757 #endif /* Target and host byte order differ. */
759 /* On some machines there are bits in addresses which are not really
760 part of the address, but are used by the kernel, the hardware, etc.
761 for special purposes. ADDR_BITS_REMOVE takes out any such bits
762 so we get a "real" address such as one would find in a symbol
763 table. ADDR_BITS_SET sets those bits the way the system wants
765 #if !defined (ADDR_BITS_REMOVE)
766 #define ADDR_BITS_REMOVE(addr) (addr)
767 #define ADDR_BITS_SET(addr) (addr)
768 #endif /* No ADDR_BITS_REMOVE. */
773 push_bytes PARAMS ((CORE_ADDR, char *, int));
775 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
776 must avoid prototyping this function for now. FIXME. Should be:
778 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
783 #endif /* !defined (DEFS_H) */