1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
3 /* Basic, host-specific, and target-specific definitions for GDB.
4 Copyright (C) 1986-2014 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
25 # error gdbserver should not include gdb/defs.h
28 #include "config.h" /* Generated by configure. */
29 #include "build-gnulib/config.h"
31 #include <sys/types.h>
33 #include <errno.h> /* System call error return status. */
37 /* The libdecnumber library, on which GDB depends, includes a header file
38 called gstdint.h instead of relying directly on stdint.h. GDB, on the
39 other hand, includes stdint.h directly, relying on the fact that gnulib
40 generates a copy if the system doesn't provide one or if it is missing
41 some features. Unfortunately, gstdint.h and stdint.h cannot be included
42 at the same time, which may happen when we include a file from
45 The following macro definition effectively prevents the inclusion of
46 gstdint.h, as all the definitions it provides are guarded against
47 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
48 included, so it's ok to blank out gstdint.h. */
49 #define GCC_GENERATED_STDINT_H 1
55 /* For gnulib's PATH_MAX. */
60 /* First include ansidecl.h so we can use the various macro definitions
61 here and in all subsequent file inclusions. */
65 #include "gdb_locale.h"
67 #include "gdb_wchar.h"
69 /* For ``enum gdb_signal''. */
70 #include "gdb/signals.h"
74 #include "host-defs.h"
76 /* Just in case they're not defined in stdio.h. */
85 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
86 It is used as an access modifier in calls to open(), where it acts
87 similarly to the "b" character in fopen()'s MODE argument. On Posix
88 platforms it should be a no-op, so it is defined as 0 here. This
89 ensures that the symbol may be used freely elsewhere in gdb. */
95 #include <stdarg.h> /* For va_list. */
97 #include "libiberty.h"
100 /* Rather than duplicate all the logic in BFD for figuring out what
101 types to use (which can be pretty complicated), symply define them
102 in terms of the corresponding type from BFD. */
106 /* A byte from the program being debugged. */
107 typedef bfd_byte gdb_byte;
109 /* An address in the program being debugged. Host byte order. */
110 typedef bfd_vma CORE_ADDR;
112 /* The largest CORE_ADDR value. */
113 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
115 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
119 #define LONGEST BFD_HOST_64_BIT
120 #define ULONGEST BFD_HOST_U_64_BIT
124 #define LONGEST long long
125 #define ULONGEST unsigned long long
127 #endif /* No BFD64 */
130 #define min(a, b) ((a) < (b) ? (a) : (b))
133 #define max(a, b) ((a) > (b) ? (a) : (b))
138 /* Enable xdb commands if set. */
139 extern int xdb_commands;
141 /* Enable dbx commands if set. */
142 extern int dbx_commands;
144 /* System root path, used to find libraries etc. */
145 extern char *gdb_sysroot;
147 /* GDB datadir, used to store data files. */
148 extern char *gdb_datadir;
150 /* If non-NULL, the possibly relocated path to python's "lib" directory
151 specified with --with-python. */
152 extern char *python_libdir;
154 /* Search path for separate debug files. */
155 extern char *debug_file_directory;
157 /* GDB has two methods for handling SIGINT. When immediate_quit is
158 nonzero, a SIGINT results in an immediate longjmp out of the signal
159 handler. Otherwise, SIGINT simply sets a flag; code that might
160 take a long time, and which ought to be interruptible, checks this
161 flag using the QUIT macro.
163 If GDB is built with Python support, it uses Python's low-level
164 interface to implement the flag. This approach makes it possible
165 for Python and GDB SIGINT handling to coexist seamlessly.
167 If GDB is built without Python, it instead uses its traditional
170 /* Clear the quit flag. */
171 extern void clear_quit_flag (void);
172 /* Evaluate to non-zero if the quit flag is set, zero otherwise. This
173 will clear the quit flag as a side effect. */
174 extern int check_quit_flag (void);
175 /* Set the quit flag. */
176 extern void set_quit_flag (void);
178 extern int immediate_quit;
180 extern void quit (void);
182 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
183 benefits of having a ``QUIT'' macro rather than a function are
184 marginal. If the overhead of a QUIT function call is proving
185 significant then its calling frequency should probably be reduced
186 [kingdon]. A profile analyzing the current situtation is
190 if (check_quit_flag ()) quit (); \
191 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
194 /* Languages represented in the symbol table and elsewhere.
195 This should probably be in language.h, but since enum's can't
196 be forward declared to satisfy opaque references before their
197 actual definition, needs to be here. */
201 language_unknown, /* Language not known */
202 language_auto, /* Placeholder for automatic setting */
204 language_cplus, /* C++ */
206 language_go, /* Go */
207 language_objc, /* Objective-C */
208 language_java, /* Java */
209 language_fortran, /* Fortran */
210 language_m2, /* Modula-2 */
211 language_asm, /* Assembly language */
212 language_pascal, /* Pascal */
213 language_ada, /* Ada */
214 language_opencl, /* OpenCL */
215 language_minimal, /* All other languages, minimal support only */
223 unspecified_precision
226 /* A generic, not quite boolean, enumeration. */
234 /* Potential ways that a function can return a value of a given type. */
235 enum return_value_convention
237 /* Where the return value has been squeezed into one or more
239 RETURN_VALUE_REGISTER_CONVENTION,
240 /* Commonly known as the "struct return convention". The caller
241 passes an additional hidden first parameter to the caller. That
242 parameter contains the address at which the value being returned
243 should be stored. While typically, and historically, used for
244 large structs, this is convention is applied to values of many
246 RETURN_VALUE_STRUCT_CONVENTION,
247 /* Like the "struct return convention" above, but where the ABI
248 guarantees that the called function stores the address at which
249 the value being returned is stored in a well-defined location,
250 such as a register or memory slot in the stack frame. Don't use
251 this if the ABI doesn't explicitly guarantees this. */
252 RETURN_VALUE_ABI_RETURNS_ADDRESS,
253 /* Like the "struct return convention" above, but where the ABI
254 guarantees that the address at which the value being returned is
255 stored will be available in a well-defined location, such as a
256 register or memory slot in the stack frame. Don't use this if
257 the ABI doesn't explicitly guarantees this. */
258 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
261 /* Needed for various prototypes */
271 /* This really belong in utils.c (path-utils.c?), but it references some
272 globals that are currently only available to main.c. */
273 extern char *relocate_gdb_directory (const char *initial, int flag);
276 /* Annotation stuff. */
278 extern int annotation_level; /* in stack.c */
281 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
282 "const char *" in unistd.h, so we can't declare the argument
285 extern char *re_comp (const char *);
289 extern void symbol_file_command (char *, int);
291 /* Remote targets may wish to use this as their load function. */
292 extern void generic_load (char *name, int from_tty);
294 /* Report on STREAM the performance of memory transfer operation,
296 DATA_COUNT is the number of bytes transferred.
297 WRITE_COUNT is the number of separate write operations, or 0,
298 if that information is not available.
299 START_TIME is the time at which an operation was started.
300 END_TIME is the time at which an operation ended. */
302 extern void print_transfer_performance (struct ui_file *stream,
303 unsigned long data_count,
304 unsigned long write_count,
305 const struct timeval *start_time,
306 const struct timeval *end_time);
310 typedef void initialize_file_ftype (void);
312 extern char *gdb_readline (char *);
314 extern char *gdb_readline_wrapper (char *);
316 extern char *command_line_input (char *, int, char *);
318 extern void print_prompt (void);
320 extern int input_from_terminal_p (void);
322 extern int info_verbose;
324 /* From printcmd.c */
326 extern void set_next_address (struct gdbarch *, CORE_ADDR);
328 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
329 struct ui_file *, int, char *);
331 extern int build_address_symbolic (struct gdbarch *,
340 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
341 extern const char *pc_prefix (CORE_ADDR);
345 /* See openp function definition for their description. */
346 #define OPF_TRY_CWD_FIRST 0x01
347 #define OPF_SEARCH_IN_PATH 0x02
348 #define OPF_RETURN_REALPATH 0x04
350 extern int openp (const char *, int, const char *, int, char **);
352 extern int source_full_path_of (const char *, char **);
354 extern void mod_path (char *, char **);
356 extern void add_path (char *, char **, int);
358 extern void directory_switch (char *, int);
360 extern char *source_path;
362 extern void init_source_path (void);
366 /* Process memory area starting at ADDR with length SIZE. Area is readable iff
367 READ is non-zero, writable if WRITE is non-zero, executable if EXEC is
368 non-zero. Area is possibly changed against its original file based copy if
369 MODIFIED is non-zero. DATA is passed without changes from a caller. */
371 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
372 int read, int write, int exec,
373 int modified, void *data);
375 /* Take over the 'find_mapped_memory' vector from exec.c. */
376 extern void exec_set_find_memory_regions
377 (int (*func) (find_memory_region_ftype func, void *data));
379 /* Possible lvalue types. Like enum language, this should be in
380 value.h, but needs to be here for the same reason. */
388 /* In a register. Registers are relative to a frame. */
390 /* In a gdb internal variable. */
392 /* Part of a gdb internal variable (structure field). */
393 lval_internalvar_component,
394 /* Value's bits are fetched and stored using functions provided by
399 /* Control types for commands */
401 enum misc_command_type
409 enum command_control_type
418 while_stepping_control,
422 /* Structure for saved commands lines
423 (for breakpoints, defined commands, etc). */
427 struct command_line *next;
429 enum command_control_type control_type;
430 /* The number of elements in body_list. */
432 /* For composite commands, the nested lists of commands. For
433 example, for "if" command this will contain the then branch and
434 the else branch, if that is available. */
435 struct command_line **body_list;
438 extern struct command_line *read_command_lines (char *, int, int,
439 void (*)(char *, void *),
441 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
442 void (*)(char *, void *),
445 extern void free_command_lines (struct command_line **);
447 /* Parameters of the "info proc" command. */
451 /* Display the default cmdline, cwd and exe outputs. */
454 /* Display `info proc mappings'. */
457 /* Display `info proc status'. */
460 /* Display `info proc stat'. */
463 /* Display `info proc cmdline'. */
466 /* Display `info proc exe'. */
469 /* Display `info proc cwd'. */
472 /* Display all of the above. */
476 /* String containing the current directory (what getwd would return). */
478 extern char *current_directory;
480 /* Default radixes for input and output. Only some values supported. */
481 extern unsigned input_radix;
482 extern unsigned output_radix;
484 /* Possibilities for prettyformat parameters to routines which print
485 things. Like enum language, this should be in value.h, but needs
486 to be here for the same reason. FIXME: If we can eliminate this
487 as an arg to LA_VAL_PRINT, then we can probably move it back to
490 enum val_prettyformat
492 Val_no_prettyformat = 0,
494 /* Use the default setting which the user has specified. */
495 Val_prettyformat_default
498 /* Optional native machine support. Non-native (and possibly pure
499 multi-arch) targets do not need a "nm.h" file. This will be a
500 symlink to one of the nm-*.h files, built by the `configure'
507 /* Assume that fopen accepts the letter "b" in the mode string.
508 It is demanded by ISO C9X, and should be supported on all
509 platforms that claim to have a standard-conforming C library. On
510 true POSIX systems it will be ignored and have no effect. There
511 may still be systems without a standard-conforming C library where
512 an ISO C9X compiler (GCC) is available. Known examples are SunOS
513 4.x and 4.3BSD. This assumption means these systems are no longer
516 # include "fopen-bin.h"
519 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
520 FIXME: Assumes 2's complement arithmetic. */
522 #if !defined (UINT_MAX)
523 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
526 #if !defined (INT_MAX)
527 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
530 #if !defined (INT_MIN)
531 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
534 #if !defined (ULONG_MAX)
535 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
538 #if !defined (LONG_MAX)
539 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
542 #if !defined (ULONGEST_MAX)
543 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
546 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
547 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
550 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
551 arguments to a function, number in a value history, register number, etc.)
552 where the value must not be larger than can fit in an int. */
554 extern int longest_to_int (LONGEST);
556 /* Utility macros to allocate typed memory. Avoids errors like:
557 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
558 sizeof (struct foo), 0). */
559 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
561 #include "common-utils.h"
563 /* List of known OS ABIs. If you change this, make sure to update the
567 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
569 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
576 GDB_OSABI_FREEBSD_AOUT,
577 GDB_OSABI_FREEBSD_ELF,
578 GDB_OSABI_NETBSD_AOUT,
579 GDB_OSABI_NETBSD_ELF,
580 GDB_OSABI_OPENBSD_ELF,
596 GDB_OSABI_INVALID /* keep this last */
599 /* Global functions from other, non-gdb GNU thingies.
600 Libiberty thingies are no longer declared here. We include libiberty.h
603 /* From other system libraries */
609 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
612 /* Various possibilities for alloca. */
615 #define alloca __builtin_alloca
616 #else /* Not GNU C */
624 /* We need to be careful not to declare this in a way which conflicts with
625 bison. Bison never declares it as char *, but under various circumstances
626 (like __hpux) we need to use void *. */
627 extern void *alloca ();
628 #endif /* Not _AIX */
629 #endif /* Not HAVE_ALLOCA_H */
630 #endif /* Not GNU C */
631 #endif /* alloca not defined */
633 /* Dynamic target-system-dependent parameters for GDB. */
636 /* Maximum size of a register. Something small, but large enough for
637 all known ISAs. If it turns out to be too small, make it bigger. */
639 enum { MAX_REGISTER_SIZE = 64 };
641 /* Static target-system-dependent parameters for GDB. */
643 /* Number of bits in a char or unsigned char for the target machine.
644 Just like CHAR_BIT in <limits.h> but describes the target machine. */
645 #if !defined (TARGET_CHAR_BIT)
646 #define TARGET_CHAR_BIT 8
649 /* If we picked up a copy of CHAR_BIT from a configuration file
650 (which may get it by including <limits.h>) then use it to set
651 the number of bits in a host char. If not, use the same size
654 #if defined (CHAR_BIT)
655 #define HOST_CHAR_BIT CHAR_BIT
657 #define HOST_CHAR_BIT TARGET_CHAR_BIT
662 extern LONGEST extract_signed_integer (const gdb_byte *, int,
665 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
668 extern int extract_long_unsigned_integer (const gdb_byte *, int,
669 enum bfd_endian, LONGEST *);
671 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
674 extern void store_signed_integer (gdb_byte *, int,
675 enum bfd_endian, LONGEST);
677 extern void store_unsigned_integer (gdb_byte *, int,
678 enum bfd_endian, ULONGEST);
680 extern void store_typed_address (gdb_byte *buf, struct type *type,
688 /* Hooks for alternate command interfaces. */
690 /* The name of the interpreter if specified on the command line. */
691 extern char *interpreter_p;
693 /* If a given interpreter matches INTERPRETER_P then it should update
694 deprecated_init_ui_hook with the per-interpreter implementation. */
695 /* FIXME: deprecated_init_ui_hook should be moved here. */
697 struct target_waitstatus;
698 struct cmd_list_element;
700 extern void (*deprecated_pre_add_symbol_hook) (const char *);
701 extern void (*deprecated_post_add_symbol_hook) (void);
702 extern void (*selected_frame_level_changed_hook) (int);
703 extern int (*deprecated_ui_loop_hook) (int signo);
704 extern void (*deprecated_init_ui_hook) (char *argv0);
705 extern void (*deprecated_show_load_progress) (const char *section,
706 unsigned long section_sent,
707 unsigned long section_size,
708 unsigned long total_sent,
709 unsigned long total_size);
710 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
714 extern int (*deprecated_query_hook) (const char *, va_list)
715 ATTRIBUTE_FPTR_PRINTF(1,0);
716 extern void (*deprecated_warning_hook) (const char *, va_list)
717 ATTRIBUTE_FPTR_PRINTF(1,0);
718 extern void (*deprecated_flush_hook) (struct ui_file * stream);
719 extern void (*deprecated_interactive_hook) (void);
720 extern void (*deprecated_readline_begin_hook) (char *, ...)
721 ATTRIBUTE_FPTR_PRINTF_1;
722 extern char *(*deprecated_readline_hook) (char *);
723 extern void (*deprecated_readline_end_hook) (void);
724 extern void (*deprecated_register_changed_hook) (int regno);
725 extern void (*deprecated_context_hook) (int);
726 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
727 struct target_waitstatus *status,
730 extern void (*deprecated_attach_hook) (void);
731 extern void (*deprecated_detach_hook) (void);
732 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
733 char *cmd, int from_tty);
735 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
737 extern int (*deprecated_ui_load_progress_hook) (const char *section,
740 /* Inhibit window interface if non-zero. */
742 extern int use_windows;
744 /* If this definition isn't overridden by the header files, assume
745 that isatty and fileno exist on this system. */
747 #define ISATTY(FP) (isatty (fileno (FP)))
750 /* A width that can achieve a better legibility for GDB MI mode. */
751 #define GDB_MI_MSG_WIDTH 80
753 /* From progspace.c */
755 extern void initialize_progspace (void);
756 extern void initialize_inferiors (void);
758 /* Special block numbers */
764 FIRST_LOCAL_BLOCK = 2
769 #endif /* #ifndef DEFS_H */