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 "common-defs.h"
30 #include <sys/types.h>
31 #include <errno.h> /* System call error return status. */
35 /* The libdecnumber library, on which GDB depends, includes a header file
36 called gstdint.h instead of relying directly on stdint.h. GDB, on the
37 other hand, includes stdint.h directly, relying on the fact that gnulib
38 generates a copy if the system doesn't provide one or if it is missing
39 some features. Unfortunately, gstdint.h and stdint.h cannot be included
40 at the same time, which may happen when we include a file from
43 The following macro definition effectively prevents the inclusion of
44 gstdint.h, as all the definitions it provides are guarded against
45 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
46 included, so it's ok to blank out gstdint.h. */
47 #define GCC_GENERATED_STDINT_H 1
51 /* For gnulib's PATH_MAX. */
56 #include "gdb_locale.h"
58 #include "gdb_wchar.h"
60 /* For ``enum gdb_signal''. */
61 #include "gdb/signals.h"
65 #include "host-defs.h"
67 /* Just in case they're not defined in stdio.h. */
76 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
77 It is used as an access modifier in calls to open(), where it acts
78 similarly to the "b" character in fopen()'s MODE argument. On Posix
79 platforms it should be a no-op, so it is defined as 0 here. This
80 ensures that the symbol may be used freely elsewhere in gdb. */
86 #include "libiberty.h"
89 /* Rather than duplicate all the logic in BFD for figuring out what
90 types to use (which can be pretty complicated), symply define them
91 in terms of the corresponding type from BFD. */
95 /* * A byte from the program being debugged. */
96 typedef bfd_byte gdb_byte
;
98 /* * An address in the program being debugged. Host byte order. */
99 typedef bfd_vma CORE_ADDR
;
101 /* * The largest CORE_ADDR value. */
102 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
104 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
108 #define LONGEST BFD_HOST_64_BIT
109 #define ULONGEST BFD_HOST_U_64_BIT
113 #define LONGEST long long
114 #define ULONGEST unsigned long long
116 #endif /* No BFD64 */
119 #define min(a, b) ((a) < (b) ? (a) : (b))
122 #define max(a, b) ((a) > (b) ? (a) : (b))
127 /* * Enable xdb commands if set. */
128 extern int xdb_commands
;
130 /* * Enable dbx commands if set. */
131 extern int dbx_commands
;
133 /* * System root path, used to find libraries etc. */
134 extern char *gdb_sysroot
;
136 /* * GDB datadir, used to store data files. */
137 extern char *gdb_datadir
;
139 /* * If non-NULL, the possibly relocated path to python's "lib" directory
140 specified with --with-python. */
141 extern char *python_libdir
;
143 /* * Search path for separate debug files. */
144 extern char *debug_file_directory
;
146 /* GDB has two methods for handling SIGINT. When immediate_quit is
147 nonzero, a SIGINT results in an immediate longjmp out of the signal
148 handler. Otherwise, SIGINT simply sets a flag; code that might
149 take a long time, and which ought to be interruptible, checks this
150 flag using the QUIT macro.
152 These functions use the extension_language_ops API to allow extension
153 language(s) and GDB SIGINT handling to coexist seamlessly. */
155 /* * Clear the quit flag. */
156 extern void clear_quit_flag (void);
157 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
158 will clear the quit flag as a side effect. */
159 extern int check_quit_flag (void);
160 /* * Set the quit flag. */
161 extern void set_quit_flag (void);
163 /* Flag that function quit should call quit_force. */
164 extern volatile int sync_quit_force_run
;
166 extern int immediate_quit
;
168 extern void quit (void);
170 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
171 benefits of having a ``QUIT'' macro rather than a function are
172 marginal. If the overhead of a QUIT function call is proving
173 significant then its calling frequency should probably be reduced
174 [kingdon]. A profile analyzing the current situtation is
178 if (check_quit_flag () || sync_quit_force_run) quit (); \
179 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
182 /* * Languages represented in the symbol table and elsewhere.
183 This should probably be in language.h, but since enum's can't
184 be forward declared to satisfy opaque references before their
185 actual definition, needs to be here. */
189 language_unknown
, /* Language not known */
190 language_auto
, /* Placeholder for automatic setting */
192 language_cplus
, /* C++ */
194 language_go
, /* Go */
195 language_objc
, /* Objective-C */
196 language_java
, /* Java */
197 language_fortran
, /* Fortran */
198 language_m2
, /* Modula-2 */
199 language_asm
, /* Assembly language */
200 language_pascal
, /* Pascal */
201 language_ada
, /* Ada */
202 language_opencl
, /* OpenCL */
203 language_minimal
, /* All other languages, minimal support only */
211 unspecified_precision
214 /* * A generic, not quite boolean, enumeration. This is used for
215 set/show commands in which the options are on/off/automatic. */
223 /* * Potential ways that a function can return a value of a given
226 enum return_value_convention
228 /* * Where the return value has been squeezed into one or more
230 RETURN_VALUE_REGISTER_CONVENTION
,
231 /* * Commonly known as the "struct return convention". The caller
232 passes an additional hidden first parameter to the caller. That
233 parameter contains the address at which the value being returned
234 should be stored. While typically, and historically, used for
235 large structs, this is convention is applied to values of many
237 RETURN_VALUE_STRUCT_CONVENTION
,
238 /* * Like the "struct return convention" above, but where the ABI
239 guarantees that the called function stores the address at which
240 the value being returned is stored in a well-defined location,
241 such as a register or memory slot in the stack frame. Don't use
242 this if the ABI doesn't explicitly guarantees this. */
243 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
244 /* * Like the "struct return convention" above, but where the ABI
245 guarantees that the address at which the value being returned is
246 stored will be available in a well-defined location, such as a
247 register or memory slot in the stack frame. Don't use this if
248 the ABI doesn't explicitly guarantees this. */
249 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
252 /* Needed for various prototypes */
262 /* This really belong in utils.c (path-utils.c?), but it references some
263 globals that are currently only available to main.c. */
264 extern char *relocate_gdb_directory (const char *initial
, int flag
);
267 /* Annotation stuff. */
269 extern int annotation_level
; /* in stack.c */
272 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
273 "const char *" in unistd.h, so we can't declare the argument
276 extern char *re_comp (const char *);
280 extern void symbol_file_command (char *, int);
282 /* * Remote targets may wish to use this as their load function. */
283 extern void generic_load (const char *name
, int from_tty
);
285 /* * Report on STREAM the performance of memory transfer operation,
287 @param DATA_COUNT is the number of bytes transferred.
288 @param WRITE_COUNT is the number of separate write operations, or 0,
289 if that information is not available.
290 @param START_TIME is the time at which an operation was started.
291 @param END_TIME is the time at which an operation ended. */
293 extern void print_transfer_performance (struct ui_file
*stream
,
294 unsigned long data_count
,
295 unsigned long write_count
,
296 const struct timeval
*start_time
,
297 const struct timeval
*end_time
);
301 typedef void initialize_file_ftype (void);
303 extern char *gdb_readline (char *);
305 extern char *gdb_readline_wrapper (char *);
307 extern char *command_line_input (char *, int, char *);
309 extern void print_prompt (void);
311 extern int input_from_terminal_p (void);
313 extern int info_verbose
;
315 /* From printcmd.c */
317 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
319 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
320 struct ui_file
*, int, char *);
322 extern int build_address_symbolic (struct gdbarch
*,
331 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
332 extern const char *pc_prefix (CORE_ADDR
);
336 /* See openp function definition for their description. */
337 #define OPF_TRY_CWD_FIRST 0x01
338 #define OPF_SEARCH_IN_PATH 0x02
339 #define OPF_RETURN_REALPATH 0x04
341 extern int openp (const char *, int, const char *, int, char **);
343 extern int source_full_path_of (const char *, char **);
345 extern void mod_path (char *, char **);
347 extern void add_path (char *, char **, int);
349 extern void directory_switch (char *, int);
351 extern char *source_path
;
353 extern void init_source_path (void);
357 /* * Process memory area starting at ADDR with length SIZE. Area is
358 readable iff READ is non-zero, writable if WRITE is non-zero,
359 executable if EXEC is non-zero. Area is possibly changed against
360 its original file based copy if MODIFIED is non-zero. DATA is
361 passed without changes from a caller. */
363 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
364 int read
, int write
, int exec
,
365 int modified
, void *data
);
367 /* * Possible lvalue types. Like enum language, this should be in
368 value.h, but needs to be here for the same reason. */
376 /* * In a register. Registers are relative to a frame. */
378 /* * In a gdb internal variable. */
380 /* * Value encapsulates a callable defined in an extension language. */
382 /* * Part of a gdb internal variable (structure field). */
383 lval_internalvar_component
,
384 /* * Value's bits are fetched and stored using functions provided
389 /* * Control types for commands. */
391 enum misc_command_type
399 enum command_control_type
409 while_stepping_control
,
413 /* * Structure for saved commands lines (for breakpoints, defined
418 struct command_line
*next
;
420 enum command_control_type control_type
;
421 /* * The number of elements in body_list. */
423 /* * For composite commands, the nested lists of commands. For
424 example, for "if" command this will contain the then branch and
425 the else branch, if that is available. */
426 struct command_line
**body_list
;
429 extern struct command_line
*read_command_lines (char *, int, int,
430 void (*)(char *, void *),
432 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
433 void (*)(char *, void *),
436 extern void free_command_lines (struct command_line
**);
438 /* * Parameters of the "info proc" command. */
442 /* * Display the default cmdline, cwd and exe outputs. */
445 /* * Display `info proc mappings'. */
448 /* * Display `info proc status'. */
451 /* * Display `info proc stat'. */
454 /* * Display `info proc cmdline'. */
457 /* * Display `info proc exe'. */
460 /* * Display `info proc cwd'. */
463 /* * Display all of the above. */
467 /* * String containing the current directory (what getwd would return). */
469 extern char *current_directory
;
471 /* * Default radixes for input and output. Only some values supported. */
472 extern unsigned input_radix
;
473 extern unsigned output_radix
;
475 /* * Possibilities for prettyformat parameters to routines which print
476 things. Like enum language, this should be in value.h, but needs
477 to be here for the same reason. FIXME: If we can eliminate this
478 as an arg to LA_VAL_PRINT, then we can probably move it back to
481 enum val_prettyformat
483 Val_no_prettyformat
= 0,
485 /* * Use the default setting which the user has specified. */
486 Val_prettyformat_default
489 /* * Optional native machine support. Non-native (and possibly pure
490 multi-arch) targets do not need a "nm.h" file. This will be a
491 symlink to one of the nm-*.h files, built by the `configure'
498 /* Assume that fopen accepts the letter "b" in the mode string.
499 It is demanded by ISO C9X, and should be supported on all
500 platforms that claim to have a standard-conforming C library. On
501 true POSIX systems it will be ignored and have no effect. There
502 may still be systems without a standard-conforming C library where
503 an ISO C9X compiler (GCC) is available. Known examples are SunOS
504 4.x and 4.3BSD. This assumption means these systems are no longer
507 # include "fopen-bin.h"
510 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
511 FIXME: Assumes 2's complement arithmetic. */
513 #if !defined (UINT_MAX)
514 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
517 #if !defined (INT_MAX)
518 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
521 #if !defined (INT_MIN)
522 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
525 #if !defined (ULONG_MAX)
526 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
529 #if !defined (LONG_MAX)
530 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
533 #if !defined (ULONGEST_MAX)
534 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
537 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
538 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
541 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
542 arguments to a function, number in a value history, register number, etc.)
543 where the value must not be larger than can fit in an int. */
545 extern int longest_to_int (LONGEST
);
547 #include "common-utils.h"
549 /* * List of known OS ABIs. If you change this, make sure to update the
553 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
555 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
562 GDB_OSABI_FREEBSD_AOUT
,
563 GDB_OSABI_FREEBSD_ELF
,
564 GDB_OSABI_NETBSD_AOUT
,
565 GDB_OSABI_NETBSD_ELF
,
566 GDB_OSABI_OPENBSD_ELF
,
582 GDB_OSABI_INVALID
/* keep this last */
585 /* Global functions from other, non-gdb GNU thingies.
586 Libiberty thingies are no longer declared here. We include libiberty.h
589 /* From other system libraries */
592 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
595 /* Various possibilities for alloca. */
598 #define alloca __builtin_alloca
599 #else /* Not GNU C */
607 /* We need to be careful not to declare this in a way which conflicts with
608 bison. Bison never declares it as char *, but under various circumstances
609 (like __hpux) we need to use void *. */
610 extern void *alloca ();
611 #endif /* Not _AIX */
612 #endif /* Not HAVE_ALLOCA_H */
613 #endif /* Not GNU C */
614 #endif /* alloca not defined */
616 /* Dynamic target-system-dependent parameters for GDB. */
619 /* * Maximum size of a register. Something small, but large enough for
620 all known ISAs. If it turns out to be too small, make it bigger. */
622 enum { MAX_REGISTER_SIZE
= 64 };
624 /* Static target-system-dependent parameters for GDB. */
626 /* * Number of bits in a char or unsigned char for the target machine.
627 Just like CHAR_BIT in <limits.h> but describes the target machine. */
628 #if !defined (TARGET_CHAR_BIT)
629 #define TARGET_CHAR_BIT 8
632 /* * If we picked up a copy of CHAR_BIT from a configuration file
633 (which may get it by including <limits.h>) then use it to set
634 the number of bits in a host char. If not, use the same size
637 #if defined (CHAR_BIT)
638 #define HOST_CHAR_BIT CHAR_BIT
640 #define HOST_CHAR_BIT TARGET_CHAR_BIT
645 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
648 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
651 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
652 enum bfd_endian
, LONGEST
*);
654 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
657 extern void store_signed_integer (gdb_byte
*, int,
658 enum bfd_endian
, LONGEST
);
660 extern void store_unsigned_integer (gdb_byte
*, int,
661 enum bfd_endian
, ULONGEST
);
663 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
671 /* Hooks for alternate command interfaces. */
673 /* * The name of the interpreter if specified on the command line. */
674 extern char *interpreter_p
;
676 /* If a given interpreter matches INTERPRETER_P then it should update
677 deprecated_init_ui_hook with the per-interpreter implementation. */
678 /* FIXME: deprecated_init_ui_hook should be moved here. */
680 struct target_waitstatus
;
681 struct cmd_list_element
;
683 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
684 extern void (*deprecated_post_add_symbol_hook
) (void);
685 extern void (*selected_frame_level_changed_hook
) (int);
686 extern int (*deprecated_ui_loop_hook
) (int signo
);
687 extern void (*deprecated_init_ui_hook
) (char *argv0
);
688 extern void (*deprecated_show_load_progress
) (const char *section
,
689 unsigned long section_sent
,
690 unsigned long section_size
,
691 unsigned long total_sent
,
692 unsigned long total_size
);
693 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
697 extern int (*deprecated_query_hook
) (const char *, va_list)
698 ATTRIBUTE_FPTR_PRINTF(1,0);
699 extern void (*deprecated_warning_hook
) (const char *, va_list)
700 ATTRIBUTE_FPTR_PRINTF(1,0);
701 extern void (*deprecated_interactive_hook
) (void);
702 extern void (*deprecated_readline_begin_hook
) (char *, ...)
703 ATTRIBUTE_FPTR_PRINTF_1
;
704 extern char *(*deprecated_readline_hook
) (char *);
705 extern void (*deprecated_readline_end_hook
) (void);
706 extern void (*deprecated_register_changed_hook
) (int regno
);
707 extern void (*deprecated_context_hook
) (int);
708 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
709 struct target_waitstatus
*status
,
712 extern void (*deprecated_attach_hook
) (void);
713 extern void (*deprecated_detach_hook
) (void);
714 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
715 char *cmd
, int from_tty
);
717 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
720 /* If this definition isn't overridden by the header files, assume
721 that isatty and fileno exist on this system. */
723 #define ISATTY(FP) (isatty (fileno (FP)))
726 /* * A width that can achieve a better legibility for GDB MI mode. */
727 #define GDB_MI_MSG_WIDTH 80
729 /* From progspace.c */
731 extern void initialize_progspace (void);
732 extern void initialize_inferiors (void);
734 /* * Special block numbers */
740 FIRST_LOCAL_BLOCK
= 2
745 #endif /* #ifndef DEFS_H */