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 *));
204 print_spaces PARAMS ((int, FILE *));
207 print_spaces_filtered PARAMS ((int, FILE *));
210 n_spaces PARAMS ((int));
213 printchar PARAMS ((int, FILE *, int));
216 strdup_demangled PARAMS ((const char *));
219 fprint_symbol PARAMS ((FILE *, char *));
222 fputs_demangled PARAMS ((char *, FILE *, int));
225 perror_with_name PARAMS ((char *));
228 print_sys_errmsg PARAMS ((char *, int));
233 re_comp PARAMS ((char *));
238 symbol_file_command PARAMS ((char *, int));
243 skip_quoted PARAMS ((char *));
246 gdb_readline PARAMS ((char *));
249 command_line_input PARAMS ((char *, int));
252 print_prompt PARAMS ((void));
255 batch_mode PARAMS ((void));
258 input_from_terminal_p PARAMS ((void));
261 catch_errors PARAMS ((int (*) (char *), char *, char *));
263 /* From printcmd.c */
266 set_next_address PARAMS ((CORE_ADDR));
269 print_address_symbolic PARAMS ((CORE_ADDR, FILE *, int, char *));
272 print_address PARAMS ((CORE_ADDR, FILE *));
277 openp PARAMS ((char *, int, char *, int, int, char **));
280 mod_path PARAMS ((char *, char **));
283 directory_command PARAMS ((char *, int));
286 init_source_path PARAMS ((void));
291 read_relative_register_raw_bytes PARAMS ((int, char *));
293 /* From readline (but not in any readline .h files). */
296 tilde_expand PARAMS ((char *));
298 /* Structure for saved commands lines
299 (for breakpoints, defined commands, etc). */
303 struct command_line *next;
307 extern struct command_line *
308 read_command_lines PARAMS ((void));
311 free_command_lines PARAMS ((struct command_line **));
313 /* String containing the current directory (what getwd would return). */
315 extern char *current_directory;
317 /* Default radixes for input and output. Only some values supported. */
318 extern unsigned input_radix;
319 extern unsigned output_radix;
321 /* Baud rate specified for communication with serial target systems. */
322 extern char *baud_rate;
324 /* Languages represented in the symbol table and elsewhere. */
328 language_unknown, /* Language not known */
329 language_auto, /* Placeholder for automatic setting */
331 language_cplus, /* C++ */
332 language_m2 /* Modula-2 */
335 /* Return a format string for printf that will print a number in the local
336 (language-specific) hexadecimal format. Result is static and is
337 overwritten by the next call. local_hex_format_custom takes printf
338 options like "08" or "l" (to produce e.g. %08x or %lx). */
340 #define local_hex_format() (current_language->la_hex_format)
343 local_hex_format_custom PARAMS ((char *)); /* language.c */
345 /* Return a string that contains a number formatted in the local
346 (language-specific) hexadecimal format. Result is static and is
347 overwritten by the next call. local_hex_string_custom takes printf
348 options like "08" or "l". */
351 local_hex_string PARAMS ((int)); /* language.c */
354 local_hex_string_custom PARAMS ((int, char *)); /* language.c */
357 /* Host machine definition. This will be a symlink to one of the
358 xm-*.h files, built by the `configure' script. */
362 /* If the xm.h file did not define the mode string used to open the
363 files, assume that binary files are opened the same way as text
366 #include "fopen-same.h"
370 * Allow things in gdb to be declared "const". If compiling ANSI, it
371 * just works. If compiling with gcc but non-ansi, redefine to __const__.
372 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
373 * objects be read-write rather than read-only.
379 # define const __const__
381 # define const /*nothing*/
389 # define volatile __volatile__
391 # define volatile /*nothing*/
394 #endif /* volatile */
396 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
397 declarations of functions that never return (exit for instance) as
398 "volatile void". For such compilers "NORETURN" can be defined away
399 to keep them happy */
403 # define NORETURN /*nothing*/
405 # define NORETURN volatile
409 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
411 #if !defined (UINT_MAX)
412 #define UINT_MAX 0xffffffff
415 #if !defined (LONG_MAX)
416 #define LONG_MAX 0x7fffffff
419 #if !defined (INT_MAX)
420 #define INT_MAX 0x7fffffff
423 #if !defined (INT_MIN)
424 /* Two's complement, 32 bit. */
425 #define INT_MIN -0x80000000
428 /* Number of bits in a char or unsigned char for the target machine.
429 Just like CHAR_BIT in <limits.h> but describes the target machine. */
430 #if !defined (TARGET_CHAR_BIT)
431 #define TARGET_CHAR_BIT 8
434 /* Number of bits in a short or unsigned short for the target machine. */
435 #if !defined (TARGET_SHORT_BIT)
436 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
439 /* Number of bits in an int or unsigned int for the target machine. */
440 #if !defined (TARGET_INT_BIT)
441 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
444 /* Number of bits in a long or unsigned long for the target machine. */
445 #if !defined (TARGET_LONG_BIT)
446 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
449 /* Number of bits in a long long or unsigned long long for the target machine. */
450 #if !defined (TARGET_LONG_LONG_BIT)
451 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
454 /* Number of bits in a float for the target machine. */
455 #if !defined (TARGET_FLOAT_BIT)
456 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
459 /* Number of bits in a double for the target machine. */
460 #if !defined (TARGET_DOUBLE_BIT)
461 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
464 /* Number of bits in a long double for the target machine. */
465 #if !defined (TARGET_LONG_DOUBLE_BIT)
466 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
469 /* Number of bits in a "complex" for the target machine. */
470 #if !defined (TARGET_COMPLEX_BIT)
471 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
474 /* Number of bits in a "double complex" for the target machine. */
475 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
476 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
479 /* Number of bits in a pointer for the target machine */
480 #if !defined (TARGET_PTR_BIT)
481 #define TARGET_PTR_BIT TARGET_INT_BIT
484 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
485 of arguments to a function, number in a value history, register
486 number, etc.) where the value must not be larger than can fit
488 #if !defined (longest_to_int)
489 #if defined (LONG_LONG)
490 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
491 ? (error ("Value out of range."),0) : (int) (x))
492 #else /* No LONG_LONG. */
493 /* Assume sizeof (int) == sizeof (long). */
494 #define longest_to_int(x) ((int) (x))
495 #endif /* No LONG_LONG. */
496 #endif /* No longest_to_int. */
498 /* This should not be a typedef, because "unsigned LONGEST" needs
499 to work. LONG_LONG is defined if the host has "long long". */
503 # define LONGEST long long
505 # define LONGEST long
509 /* Assorted functions we can declare, now that const and volatile are
513 savestring PARAMS ((const char *, int));
516 msavestring PARAMS ((void *, const char *, int));
519 strsave PARAMS ((const char *));
522 mstrsave PARAMS ((void *, const char *));
525 concat PARAMS ((char *, ...));
528 xmalloc PARAMS ((long));
531 xrealloc PARAMS ((PTR, long));
534 xmmalloc PARAMS ((PTR, long));
537 xmrealloc PARAMS ((PTR, PTR, long));
540 mmalloc PARAMS ((PTR, long));
543 mrealloc PARAMS ((PTR, PTR, long));
546 mfree PARAMS ((PTR, PTR));
549 mmcheck PARAMS ((PTR, void (*) (void)));
552 mmtrace PARAMS ((void));
555 parse_escape PARAMS ((char **));
557 extern const char * const reg_names[];
559 extern NORETURN void /* Does not return to the caller. */
562 extern NORETURN void /* Does not return to the caller. */
565 extern NORETURN void /* Not specified as volatile in ... */
566 exit PARAMS ((int)); /* 4.10.4.3 */
568 extern NORETURN void /* Does not return to the caller. */
569 nomem PARAMS ((long));
571 extern NORETURN void /* Does not return to the caller. */
572 return_to_top_level PARAMS ((void));
575 warning_setup PARAMS ((void));
580 /* Global functions from other, non-gdb GNU thingies (libiberty for
584 basename PARAMS ((char *));
587 getenv PARAMS ((CONST char *));
590 buildargv PARAMS ((char *));
593 freeargv PARAMS ((char **));
596 strerrno PARAMS ((int));
599 strsigno PARAMS ((int));
602 errno_max PARAMS ((void));
605 signo_max PARAMS ((void));
608 strtoerrno PARAMS ((char *));
611 strtosigno PARAMS ((char *));
614 strsignal PARAMS ((int));
616 /* From other system libraries */
618 #ifndef PSIGNAL_IN_SIGNAL_H
620 psignal PARAMS ((unsigned, char *));
623 /* For now, we can't include <stdlib.h> because it conflicts with
624 "../include/getopt.h". (FIXME)
626 However, if a function is defined in the ANSI C standard and a prototype
627 for that function is defined and visible in any header file in an ANSI
628 conforming environment, then that prototype must match the definition in
629 the ANSI standard. So we can just duplicate them here without conflict,
630 since they must be the same in all conforming ANSI environments. If
631 these cause problems, then the environment is not ANSI conformant. */
638 fclose PARAMS ((FILE *stream)); /* 4.9.5.1 */
641 perror PARAMS ((const char *)); /* 4.9.10.4 */
644 atof PARAMS ((const char *nptr)); /* 4.10.1.1 */
647 atoi PARAMS ((const char *)); /* 4.10.1.2 */
649 #ifndef MALLOC_INCOMPATIBLE
652 malloc PARAMS ((size_t size)); /* 4.10.3.3 */
655 realloc PARAMS ((void *ptr, size_t size)); /* 4.10.3.4 */
658 free PARAMS ((void *)); /* 4.10.3.2 */
660 #endif /* MALLOC_INCOMPATIBLE */
663 qsort PARAMS ((void *base, size_t nmemb, /* 4.10.5.2 */
665 int (*comp)(const void *, const void *)));
667 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
669 memcpy PARAMS ((void *, const void *, size_t)); /* 4.11.2.1 */
673 memcmp PARAMS ((const void *, const void *, size_t)); /* 4.11.4.1 */
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 */
687 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
689 memset PARAMS ((void *, int, size_t)); /* 4.11.6.1 */
693 strerror PARAMS ((int)); /* 4.11.6.2 */
695 /* Various possibilities for alloca. */
698 # define alloca __builtin_alloca
701 # include <alloca.h> /* NOTE: Doesn't declare alloca() */
704 extern void *alloca (size_t);
705 # else /* __STDC__ */
706 extern char *alloca ();
711 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these. */
713 #if !defined (BIG_ENDIAN)
714 #define BIG_ENDIAN 4321
717 #if !defined (LITTLE_ENDIAN)
718 #define LITTLE_ENDIAN 1234
721 /* Target-system-dependent parameters for GDB.
723 The standard thing is to include defs.h. However, files that are
724 specific to a particular target can define TM_FILE_OVERRIDE before
725 including defs.h, then can include any particular tm-file they desire. */
727 /* Target machine definition. This will be a symlink to one of the
728 tm-*.h files, built by the `configure' script. */
730 #ifndef TM_FILE_OVERRIDE
734 /* The bit byte-order has to do just with numbering of bits in
735 debugging symbols and such. Conceptually, it's quite separate
736 from byte/word byte order. */
738 #if !defined (BITS_BIG_ENDIAN)
739 #if TARGET_BYTE_ORDER == BIG_ENDIAN
740 #define BITS_BIG_ENDIAN 1
741 #endif /* Big endian. */
743 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
744 #define BITS_BIG_ENDIAN 0
745 #endif /* Little endian. */
746 #endif /* BITS_BIG_ENDIAN not defined. */
748 /* Swap LEN bytes at BUFFER between target and host byte-order. */
749 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
750 #define SWAP_TARGET_AND_HOST(buffer,len)
751 #else /* Target and host byte order differ. */
752 #define SWAP_TARGET_AND_HOST(buffer,len) \
755 char *p = (char *)(buffer); \
756 char *q = ((char *)(buffer)) + len - 1; \
757 for (; p < q; p++, q--) \
764 #endif /* Target and host byte order differ. */
766 /* On some machines there are bits in addresses which are not really
767 part of the address, but are used by the kernel, the hardware, etc.
768 for special purposes. ADDR_BITS_REMOVE takes out any such bits
769 so we get a "real" address such as one would find in a symbol
770 table. ADDR_BITS_SET sets those bits the way the system wants
772 #if !defined (ADDR_BITS_REMOVE)
773 #define ADDR_BITS_REMOVE(addr) (addr)
774 #define ADDR_BITS_SET(addr) (addr)
775 #endif /* No ADDR_BITS_REMOVE. */
780 push_bytes PARAMS ((CORE_ADDR, char *, int));
782 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
783 must avoid prototyping this function for now. FIXME. Should be:
785 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
790 /* Some parts of gdb might be considered optional, in the sense that they
791 are not essential for being able to build a working, usable debugger
792 for a specific environment. For example, the maintenance commands
793 are there for the benefit of gdb maintainers. As another example,
794 some environments really don't need gdb's that are able to read N
795 different object file formats. In order to make it possible (but
796 not necessarily recommended) to build "stripped down" versions of
797 gdb, the following defines control selective compilation of those
798 parts of gdb which can be safely left out when necessary. Note that
799 the default is to include everything. */
801 #ifndef MAINTENANCE_CMDS
802 #define MAINTENANCE_CMDS 1
805 #endif /* !defined (DEFS_H) */