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 These functions use the extension_language_ops API to allow extension
164 language(s) and GDB SIGINT handling to coexist seamlessly. */
166 /* * Clear the quit flag. */
167 extern void clear_quit_flag (void);
168 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
169 will clear the quit flag as a side effect. */
170 extern int check_quit_flag (void);
171 /* * Set the quit flag. */
172 extern void set_quit_flag (void);
174 /* Flag that function quit should call quit_force. */
175 extern volatile int sync_quit_force_run;
177 extern int immediate_quit;
179 extern void quit (void);
181 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
182 benefits of having a ``QUIT'' macro rather than a function are
183 marginal. If the overhead of a QUIT function call is proving
184 significant then its calling frequency should probably be reduced
185 [kingdon]. A profile analyzing the current situtation is
189 if (check_quit_flag () || sync_quit_force_run) quit (); \
190 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
193 /* * Languages represented in the symbol table and elsewhere.
194 This should probably be in language.h, but since enum's can't
195 be forward declared to satisfy opaque references before their
196 actual definition, needs to be here. */
200 language_unknown, /* Language not known */
201 language_auto, /* Placeholder for automatic setting */
203 language_cplus, /* C++ */
205 language_go, /* Go */
206 language_objc, /* Objective-C */
207 language_java, /* Java */
208 language_fortran, /* Fortran */
209 language_m2, /* Modula-2 */
210 language_asm, /* Assembly language */
211 language_pascal, /* Pascal */
212 language_ada, /* Ada */
213 language_opencl, /* OpenCL */
214 language_minimal, /* All other languages, minimal support only */
222 unspecified_precision
225 /* * A generic, not quite boolean, enumeration. This is used for
226 set/show commands in which the options are on/off/automatic. */
234 /* * Potential ways that a function can return a value of a given
237 enum return_value_convention
239 /* * Where the return value has been squeezed into one or more
241 RETURN_VALUE_REGISTER_CONVENTION,
242 /* * Commonly known as the "struct return convention". The caller
243 passes an additional hidden first parameter to the caller. That
244 parameter contains the address at which the value being returned
245 should be stored. While typically, and historically, used for
246 large structs, this is convention is applied to values of many
248 RETURN_VALUE_STRUCT_CONVENTION,
249 /* * Like the "struct return convention" above, but where the ABI
250 guarantees that the called function stores the address at which
251 the value being returned is stored in a well-defined location,
252 such as a register or memory slot in the stack frame. Don't use
253 this if the ABI doesn't explicitly guarantees this. */
254 RETURN_VALUE_ABI_RETURNS_ADDRESS,
255 /* * Like the "struct return convention" above, but where the ABI
256 guarantees that the address at which the value being returned is
257 stored will be available in a well-defined location, such as a
258 register or memory slot in the stack frame. Don't use this if
259 the ABI doesn't explicitly guarantees this. */
260 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
263 /* Needed for various prototypes */
273 /* This really belong in utils.c (path-utils.c?), but it references some
274 globals that are currently only available to main.c. */
275 extern char *relocate_gdb_directory (const char *initial, int flag);
278 /* Annotation stuff. */
280 extern int annotation_level; /* in stack.c */
283 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
284 "const char *" in unistd.h, so we can't declare the argument
287 extern char *re_comp (const char *);
291 extern void symbol_file_command (char *, int);
293 /* * Remote targets may wish to use this as their load function. */
294 extern void generic_load (const char *name, int from_tty);
296 /* * Report on STREAM the performance of memory transfer operation,
298 @param DATA_COUNT is the number of bytes transferred.
299 @param WRITE_COUNT is the number of separate write operations, or 0,
300 if that information is not available.
301 @param START_TIME is the time at which an operation was started.
302 @param END_TIME is the time at which an operation ended. */
304 extern void print_transfer_performance (struct ui_file *stream,
305 unsigned long data_count,
306 unsigned long write_count,
307 const struct timeval *start_time,
308 const struct timeval *end_time);
312 typedef void initialize_file_ftype (void);
314 extern char *gdb_readline (char *);
316 extern char *gdb_readline_wrapper (char *);
318 extern char *command_line_input (char *, int, char *);
320 extern void print_prompt (void);
322 extern int input_from_terminal_p (void);
324 extern int info_verbose;
326 /* From printcmd.c */
328 extern void set_next_address (struct gdbarch *, CORE_ADDR);
330 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
331 struct ui_file *, int, char *);
333 extern int build_address_symbolic (struct gdbarch *,
342 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
343 extern const char *pc_prefix (CORE_ADDR);
347 /* See openp function definition for their description. */
348 #define OPF_TRY_CWD_FIRST 0x01
349 #define OPF_SEARCH_IN_PATH 0x02
350 #define OPF_RETURN_REALPATH 0x04
352 extern int openp (const char *, int, const char *, int, char **);
354 extern int source_full_path_of (const char *, char **);
356 extern void mod_path (char *, char **);
358 extern void add_path (char *, char **, int);
360 extern void directory_switch (char *, int);
362 extern char *source_path;
364 extern void init_source_path (void);
368 /* * Process memory area starting at ADDR with length SIZE. Area is
369 readable iff READ is non-zero, writable if WRITE is non-zero,
370 executable if EXEC is non-zero. Area is possibly changed against
371 its original file based copy if MODIFIED is non-zero. DATA is
372 passed without changes from a caller. */
374 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
375 int read, int write, int exec,
376 int modified, void *data);
378 /* * Possible lvalue types. Like enum language, this should be in
379 value.h, but needs to be here for the same reason. */
387 /* * In a register. Registers are relative to a frame. */
389 /* * In a gdb internal variable. */
391 /* * Value encapsulates a callable defined in an extension language. */
393 /* * Part of a gdb internal variable (structure field). */
394 lval_internalvar_component,
395 /* * Value's bits are fetched and stored using functions provided
400 /* * Control types for commands. */
402 enum misc_command_type
410 enum command_control_type
420 while_stepping_control,
424 /* * Structure for saved commands lines (for breakpoints, defined
429 struct command_line *next;
431 enum command_control_type control_type;
432 /* * The number of elements in body_list. */
434 /* * For composite commands, the nested lists of commands. For
435 example, for "if" command this will contain the then branch and
436 the else branch, if that is available. */
437 struct command_line **body_list;
440 extern struct command_line *read_command_lines (char *, int, int,
441 void (*)(char *, void *),
443 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
444 void (*)(char *, void *),
447 extern void free_command_lines (struct command_line **);
449 /* * Parameters of the "info proc" command. */
453 /* * Display the default cmdline, cwd and exe outputs. */
456 /* * Display `info proc mappings'. */
459 /* * Display `info proc status'. */
462 /* * Display `info proc stat'. */
465 /* * Display `info proc cmdline'. */
468 /* * Display `info proc exe'. */
471 /* * Display `info proc cwd'. */
474 /* * Display all of the above. */
478 /* * String containing the current directory (what getwd would return). */
480 extern char *current_directory;
482 /* * Default radixes for input and output. Only some values supported. */
483 extern unsigned input_radix;
484 extern unsigned output_radix;
486 /* * Possibilities for prettyformat parameters to routines which print
487 things. Like enum language, this should be in value.h, but needs
488 to be here for the same reason. FIXME: If we can eliminate this
489 as an arg to LA_VAL_PRINT, then we can probably move it back to
492 enum val_prettyformat
494 Val_no_prettyformat = 0,
496 /* * Use the default setting which the user has specified. */
497 Val_prettyformat_default
500 /* * Optional native machine support. Non-native (and possibly pure
501 multi-arch) targets do not need a "nm.h" file. This will be a
502 symlink to one of the nm-*.h files, built by the `configure'
509 /* Assume that fopen accepts the letter "b" in the mode string.
510 It is demanded by ISO C9X, and should be supported on all
511 platforms that claim to have a standard-conforming C library. On
512 true POSIX systems it will be ignored and have no effect. There
513 may still be systems without a standard-conforming C library where
514 an ISO C9X compiler (GCC) is available. Known examples are SunOS
515 4.x and 4.3BSD. This assumption means these systems are no longer
518 # include "fopen-bin.h"
521 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
522 FIXME: Assumes 2's complement arithmetic. */
524 #if !defined (UINT_MAX)
525 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
528 #if !defined (INT_MAX)
529 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
532 #if !defined (INT_MIN)
533 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
536 #if !defined (ULONG_MAX)
537 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
540 #if !defined (LONG_MAX)
541 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
544 #if !defined (ULONGEST_MAX)
545 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
548 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
549 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
552 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
553 arguments to a function, number in a value history, register number, etc.)
554 where the value must not be larger than can fit in an int. */
556 extern int longest_to_int (LONGEST);
558 #include "common-utils.h"
560 /* * List of known OS ABIs. If you change this, make sure to update the
564 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
566 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
573 GDB_OSABI_FREEBSD_AOUT,
574 GDB_OSABI_FREEBSD_ELF,
575 GDB_OSABI_NETBSD_AOUT,
576 GDB_OSABI_NETBSD_ELF,
577 GDB_OSABI_OPENBSD_ELF,
593 GDB_OSABI_INVALID /* keep this last */
596 /* Global functions from other, non-gdb GNU thingies.
597 Libiberty thingies are no longer declared here. We include libiberty.h
600 /* From other system libraries */
606 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
609 /* Various possibilities for alloca. */
612 #define alloca __builtin_alloca
613 #else /* Not GNU C */
621 /* We need to be careful not to declare this in a way which conflicts with
622 bison. Bison never declares it as char *, but under various circumstances
623 (like __hpux) we need to use void *. */
624 extern void *alloca ();
625 #endif /* Not _AIX */
626 #endif /* Not HAVE_ALLOCA_H */
627 #endif /* Not GNU C */
628 #endif /* alloca not defined */
630 /* Dynamic target-system-dependent parameters for GDB. */
633 /* * Maximum size of a register. Something small, but large enough for
634 all known ISAs. If it turns out to be too small, make it bigger. */
636 enum { MAX_REGISTER_SIZE = 64 };
638 /* Static target-system-dependent parameters for GDB. */
640 /* * Number of bits in a char or unsigned char for the target machine.
641 Just like CHAR_BIT in <limits.h> but describes the target machine. */
642 #if !defined (TARGET_CHAR_BIT)
643 #define TARGET_CHAR_BIT 8
646 /* * If we picked up a copy of CHAR_BIT from a configuration file
647 (which may get it by including <limits.h>) then use it to set
648 the number of bits in a host char. If not, use the same size
651 #if defined (CHAR_BIT)
652 #define HOST_CHAR_BIT CHAR_BIT
654 #define HOST_CHAR_BIT TARGET_CHAR_BIT
659 extern LONGEST extract_signed_integer (const gdb_byte *, int,
662 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
665 extern int extract_long_unsigned_integer (const gdb_byte *, int,
666 enum bfd_endian, LONGEST *);
668 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
671 extern void store_signed_integer (gdb_byte *, int,
672 enum bfd_endian, LONGEST);
674 extern void store_unsigned_integer (gdb_byte *, int,
675 enum bfd_endian, ULONGEST);
677 extern void store_typed_address (gdb_byte *buf, struct type *type,
685 /* Hooks for alternate command interfaces. */
687 /* * The name of the interpreter if specified on the command line. */
688 extern char *interpreter_p;
690 /* If a given interpreter matches INTERPRETER_P then it should update
691 deprecated_init_ui_hook with the per-interpreter implementation. */
692 /* FIXME: deprecated_init_ui_hook should be moved here. */
694 struct target_waitstatus;
695 struct cmd_list_element;
697 extern void (*deprecated_pre_add_symbol_hook) (const char *);
698 extern void (*deprecated_post_add_symbol_hook) (void);
699 extern void (*selected_frame_level_changed_hook) (int);
700 extern int (*deprecated_ui_loop_hook) (int signo);
701 extern void (*deprecated_init_ui_hook) (char *argv0);
702 extern void (*deprecated_show_load_progress) (const char *section,
703 unsigned long section_sent,
704 unsigned long section_size,
705 unsigned long total_sent,
706 unsigned long total_size);
707 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
711 extern int (*deprecated_query_hook) (const char *, va_list)
712 ATTRIBUTE_FPTR_PRINTF(1,0);
713 extern void (*deprecated_warning_hook) (const char *, va_list)
714 ATTRIBUTE_FPTR_PRINTF(1,0);
715 extern void (*deprecated_interactive_hook) (void);
716 extern void (*deprecated_readline_begin_hook) (char *, ...)
717 ATTRIBUTE_FPTR_PRINTF_1;
718 extern char *(*deprecated_readline_hook) (char *);
719 extern void (*deprecated_readline_end_hook) (void);
720 extern void (*deprecated_register_changed_hook) (int regno);
721 extern void (*deprecated_context_hook) (int);
722 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
723 struct target_waitstatus *status,
726 extern void (*deprecated_attach_hook) (void);
727 extern void (*deprecated_detach_hook) (void);
728 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
729 char *cmd, int from_tty);
731 extern int (*deprecated_ui_load_progress_hook) (const char *section,
734 /* If this definition isn't overridden by the header files, assume
735 that isatty and fileno exist on this system. */
737 #define ISATTY(FP) (isatty (fileno (FP)))
740 /* * A width that can achieve a better legibility for GDB MI mode. */
741 #define GDB_MI_MSG_WIDTH 80
743 /* From progspace.c */
745 extern void initialize_progspace (void);
746 extern void initialize_inferiors (void);
748 /* * Special block numbers */
754 FIRST_LOCAL_BLOCK = 2
759 #endif /* #ifndef DEFS_H */