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>
34 /* The libdecnumber library, on which GDB depends, includes a header file
35 called gstdint.h instead of relying directly on stdint.h. GDB, on the
36 other hand, includes stdint.h directly, relying on the fact that gnulib
37 generates a copy if the system doesn't provide one or if it is missing
38 some features. Unfortunately, gstdint.h and stdint.h cannot be included
39 at the same time, which may happen when we include a file from
42 The following macro definition effectively prevents the inclusion of
43 gstdint.h, as all the definitions it provides are guarded against
44 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
45 included, so it's ok to blank out gstdint.h. */
46 #define GCC_GENERATED_STDINT_H 1
52 #include "gdb_wchar.h"
56 #include "host-defs.h"
58 /* Just in case they're not defined in stdio.h. */
67 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
68 It is used as an access modifier in calls to open(), where it acts
69 similarly to the "b" character in fopen()'s MODE argument. On Posix
70 platforms it should be a no-op, so it is defined as 0 here. This
71 ensures that the symbol may be used freely elsewhere in gdb. */
79 /* Rather than duplicate all the logic in BFD for figuring out what
80 types to use (which can be pretty complicated), symply define them
81 in terms of the corresponding type from BFD. */
85 /* * A byte from the program being debugged. */
86 typedef bfd_byte gdb_byte
;
88 /* * An address in the program being debugged. Host byte order. */
89 typedef bfd_vma CORE_ADDR
;
91 /* * The largest CORE_ADDR value. */
92 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
94 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
98 #define LONGEST BFD_HOST_64_BIT
99 #define ULONGEST BFD_HOST_U_64_BIT
103 #define LONGEST long long
104 #define ULONGEST unsigned long long
106 #endif /* No BFD64 */
109 #define min(a, b) ((a) < (b) ? (a) : (b))
112 #define max(a, b) ((a) > (b) ? (a) : (b))
115 /* * Enable xdb commands if set. */
116 extern int xdb_commands
;
118 /* * Enable dbx commands if set. */
119 extern int dbx_commands
;
121 /* * System root path, used to find libraries etc. */
122 extern char *gdb_sysroot
;
124 /* * GDB datadir, used to store data files. */
125 extern char *gdb_datadir
;
127 /* * If non-NULL, the possibly relocated path to python's "lib" directory
128 specified with --with-python. */
129 extern char *python_libdir
;
131 /* * Search path for separate debug files. */
132 extern char *debug_file_directory
;
134 /* GDB has two methods for handling SIGINT. When immediate_quit is
135 nonzero, a SIGINT results in an immediate longjmp out of the signal
136 handler. Otherwise, SIGINT simply sets a flag; code that might
137 take a long time, and which ought to be interruptible, checks this
138 flag using the QUIT macro.
140 These functions use the extension_language_ops API to allow extension
141 language(s) and GDB SIGINT handling to coexist seamlessly. */
143 /* * Clear the quit flag. */
144 extern void clear_quit_flag (void);
145 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
146 will clear the quit flag as a side effect. */
147 extern int check_quit_flag (void);
148 /* * Set the quit flag. */
149 extern void set_quit_flag (void);
151 /* Flag that function quit should call quit_force. */
152 extern volatile int sync_quit_force_run
;
154 extern int immediate_quit
;
156 extern void quit (void);
158 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
159 benefits of having a ``QUIT'' macro rather than a function are
160 marginal. If the overhead of a QUIT function call is proving
161 significant then its calling frequency should probably be reduced
162 [kingdon]. A profile analyzing the current situtation is
166 if (check_quit_flag () || sync_quit_force_run) quit (); \
167 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
170 /* * Languages represented in the symbol table and elsewhere.
171 This should probably be in language.h, but since enum's can't
172 be forward declared to satisfy opaque references before their
173 actual definition, needs to be here. */
177 language_unknown
, /* Language not known */
178 language_auto
, /* Placeholder for automatic setting */
180 language_cplus
, /* C++ */
182 language_go
, /* Go */
183 language_objc
, /* Objective-C */
184 language_java
, /* Java */
185 language_fortran
, /* Fortran */
186 language_m2
, /* Modula-2 */
187 language_asm
, /* Assembly language */
188 language_pascal
, /* Pascal */
189 language_ada
, /* Ada */
190 language_opencl
, /* OpenCL */
191 language_minimal
, /* All other languages, minimal support only */
199 unspecified_precision
202 /* * A generic, not quite boolean, enumeration. This is used for
203 set/show commands in which the options are on/off/automatic. */
211 /* * Potential ways that a function can return a value of a given
214 enum return_value_convention
216 /* * Where the return value has been squeezed into one or more
218 RETURN_VALUE_REGISTER_CONVENTION
,
219 /* * Commonly known as the "struct return convention". The caller
220 passes an additional hidden first parameter to the caller. That
221 parameter contains the address at which the value being returned
222 should be stored. While typically, and historically, used for
223 large structs, this is convention is applied to values of many
225 RETURN_VALUE_STRUCT_CONVENTION
,
226 /* * Like the "struct return convention" above, but where the ABI
227 guarantees that the called function stores the address at which
228 the value being returned is stored in a well-defined location,
229 such as a register or memory slot in the stack frame. Don't use
230 this if the ABI doesn't explicitly guarantees this. */
231 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
232 /* * Like the "struct return convention" above, but where the ABI
233 guarantees that the address at which the value being returned is
234 stored will be available in a well-defined location, such as a
235 register or memory slot in the stack frame. Don't use this if
236 the ABI doesn't explicitly guarantees this. */
237 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
240 /* Needed for various prototypes */
250 /* This really belong in utils.c (path-utils.c?), but it references some
251 globals that are currently only available to main.c. */
252 extern char *relocate_gdb_directory (const char *initial
, int flag
);
255 /* Annotation stuff. */
257 extern int annotation_level
; /* in stack.c */
260 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
261 "const char *" in unistd.h, so we can't declare the argument
264 extern char *re_comp (const char *);
268 extern void symbol_file_command (char *, int);
270 /* * Remote targets may wish to use this as their load function. */
271 extern void generic_load (const char *name
, int from_tty
);
273 /* * Report on STREAM the performance of memory transfer operation,
275 @param DATA_COUNT is the number of bytes transferred.
276 @param WRITE_COUNT is the number of separate write operations, or 0,
277 if that information is not available.
278 @param START_TIME is the time at which an operation was started.
279 @param END_TIME is the time at which an operation ended. */
281 extern void print_transfer_performance (struct ui_file
*stream
,
282 unsigned long data_count
,
283 unsigned long write_count
,
284 const struct timeval
*start_time
,
285 const struct timeval
*end_time
);
289 typedef void initialize_file_ftype (void);
291 extern char *gdb_readline (char *);
293 extern char *gdb_readline_wrapper (char *);
295 extern char *command_line_input (char *, int, char *);
297 extern void print_prompt (void);
299 extern int input_from_terminal_p (void);
301 extern int info_verbose
;
303 /* From printcmd.c */
305 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
307 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
308 struct ui_file
*, int, char *);
310 extern int build_address_symbolic (struct gdbarch
*,
319 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
320 extern const char *pc_prefix (CORE_ADDR
);
324 /* See openp function definition for their description. */
325 #define OPF_TRY_CWD_FIRST 0x01
326 #define OPF_SEARCH_IN_PATH 0x02
327 #define OPF_RETURN_REALPATH 0x04
329 extern int openp (const char *, int, const char *, int, char **);
331 extern int source_full_path_of (const char *, char **);
333 extern void mod_path (char *, char **);
335 extern void add_path (char *, char **, int);
337 extern void directory_switch (char *, int);
339 extern char *source_path
;
341 extern void init_source_path (void);
345 /* * Process memory area starting at ADDR with length SIZE. Area is
346 readable iff READ is non-zero, writable if WRITE is non-zero,
347 executable if EXEC is non-zero. Area is possibly changed against
348 its original file based copy if MODIFIED is non-zero. DATA is
349 passed without changes from a caller. */
351 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
352 int read
, int write
, int exec
,
353 int modified
, void *data
);
355 /* * Possible lvalue types. Like enum language, this should be in
356 value.h, but needs to be here for the same reason. */
364 /* * In a register. Registers are relative to a frame. */
366 /* * In a gdb internal variable. */
368 /* * Value encapsulates a callable defined in an extension language. */
370 /* * Part of a gdb internal variable (structure field). */
371 lval_internalvar_component
,
372 /* * Value's bits are fetched and stored using functions provided
377 /* * Control types for commands. */
379 enum misc_command_type
387 enum command_control_type
397 while_stepping_control
,
401 /* * Structure for saved commands lines (for breakpoints, defined
406 struct command_line
*next
;
408 enum command_control_type control_type
;
409 /* * The number of elements in body_list. */
411 /* * For composite commands, the nested lists of commands. For
412 example, for "if" command this will contain the then branch and
413 the else branch, if that is available. */
414 struct command_line
**body_list
;
417 extern struct command_line
*read_command_lines (char *, int, int,
418 void (*)(char *, void *),
420 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
421 void (*)(char *, void *),
424 extern void free_command_lines (struct command_line
**);
426 /* * Parameters of the "info proc" command. */
430 /* * Display the default cmdline, cwd and exe outputs. */
433 /* * Display `info proc mappings'. */
436 /* * Display `info proc status'. */
439 /* * Display `info proc stat'. */
442 /* * Display `info proc cmdline'. */
445 /* * Display `info proc exe'. */
448 /* * Display `info proc cwd'. */
451 /* * Display all of the above. */
455 /* * String containing the current directory (what getwd would return). */
457 extern char *current_directory
;
459 /* * Default radixes for input and output. Only some values supported. */
460 extern unsigned input_radix
;
461 extern unsigned output_radix
;
463 /* * Possibilities for prettyformat parameters to routines which print
464 things. Like enum language, this should be in value.h, but needs
465 to be here for the same reason. FIXME: If we can eliminate this
466 as an arg to LA_VAL_PRINT, then we can probably move it back to
469 enum val_prettyformat
471 Val_no_prettyformat
= 0,
473 /* * Use the default setting which the user has specified. */
474 Val_prettyformat_default
477 /* * Optional native machine support. Non-native (and possibly pure
478 multi-arch) targets do not need a "nm.h" file. This will be a
479 symlink to one of the nm-*.h files, built by the `configure'
486 /* Assume that fopen accepts the letter "b" in the mode string.
487 It is demanded by ISO C9X, and should be supported on all
488 platforms that claim to have a standard-conforming C library. On
489 true POSIX systems it will be ignored and have no effect. There
490 may still be systems without a standard-conforming C library where
491 an ISO C9X compiler (GCC) is available. Known examples are SunOS
492 4.x and 4.3BSD. This assumption means these systems are no longer
495 # include "fopen-bin.h"
498 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
499 FIXME: Assumes 2's complement arithmetic. */
501 #if !defined (UINT_MAX)
502 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
505 #if !defined (INT_MAX)
506 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
509 #if !defined (INT_MIN)
510 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
513 #if !defined (ULONG_MAX)
514 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
517 #if !defined (LONG_MAX)
518 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
521 #if !defined (ULONGEST_MAX)
522 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
525 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
526 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
529 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
530 arguments to a function, number in a value history, register number, etc.)
531 where the value must not be larger than can fit in an int. */
533 extern int longest_to_int (LONGEST
);
535 /* * List of known OS ABIs. If you change this, make sure to update the
539 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
541 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
548 GDB_OSABI_FREEBSD_AOUT
,
549 GDB_OSABI_FREEBSD_ELF
,
550 GDB_OSABI_NETBSD_AOUT
,
551 GDB_OSABI_NETBSD_ELF
,
552 GDB_OSABI_OPENBSD_ELF
,
568 GDB_OSABI_INVALID
/* keep this last */
571 /* Global functions from other, non-gdb GNU thingies.
572 Libiberty thingies are no longer declared here. We include libiberty.h
575 /* From other system libraries */
578 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
581 /* Various possibilities for alloca. */
584 #define alloca __builtin_alloca
585 #else /* Not GNU C */
593 /* We need to be careful not to declare this in a way which conflicts with
594 bison. Bison never declares it as char *, but under various circumstances
595 (like __hpux) we need to use void *. */
596 extern void *alloca ();
597 #endif /* Not _AIX */
598 #endif /* Not HAVE_ALLOCA_H */
599 #endif /* Not GNU C */
600 #endif /* alloca not defined */
602 /* Dynamic target-system-dependent parameters for GDB. */
605 /* * Maximum size of a register. Something small, but large enough for
606 all known ISAs. If it turns out to be too small, make it bigger. */
608 enum { MAX_REGISTER_SIZE
= 64 };
610 /* Static target-system-dependent parameters for GDB. */
612 /* * Number of bits in a char or unsigned char for the target machine.
613 Just like CHAR_BIT in <limits.h> but describes the target machine. */
614 #if !defined (TARGET_CHAR_BIT)
615 #define TARGET_CHAR_BIT 8
618 /* * If we picked up a copy of CHAR_BIT from a configuration file
619 (which may get it by including <limits.h>) then use it to set
620 the number of bits in a host char. If not, use the same size
623 #if defined (CHAR_BIT)
624 #define HOST_CHAR_BIT CHAR_BIT
626 #define HOST_CHAR_BIT TARGET_CHAR_BIT
631 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
634 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
637 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
638 enum bfd_endian
, LONGEST
*);
640 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
643 extern void store_signed_integer (gdb_byte
*, int,
644 enum bfd_endian
, LONGEST
);
646 extern void store_unsigned_integer (gdb_byte
*, int,
647 enum bfd_endian
, ULONGEST
);
649 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
657 /* Hooks for alternate command interfaces. */
659 /* * The name of the interpreter if specified on the command line. */
660 extern char *interpreter_p
;
662 /* If a given interpreter matches INTERPRETER_P then it should update
663 deprecated_init_ui_hook with the per-interpreter implementation. */
664 /* FIXME: deprecated_init_ui_hook should be moved here. */
666 struct target_waitstatus
;
667 struct cmd_list_element
;
669 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
670 extern void (*deprecated_post_add_symbol_hook
) (void);
671 extern void (*selected_frame_level_changed_hook
) (int);
672 extern int (*deprecated_ui_loop_hook
) (int signo
);
673 extern void (*deprecated_init_ui_hook
) (char *argv0
);
674 extern void (*deprecated_show_load_progress
) (const char *section
,
675 unsigned long section_sent
,
676 unsigned long section_size
,
677 unsigned long total_sent
,
678 unsigned long total_size
);
679 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
683 extern int (*deprecated_query_hook
) (const char *, va_list)
684 ATTRIBUTE_FPTR_PRINTF(1,0);
685 extern void (*deprecated_warning_hook
) (const char *, va_list)
686 ATTRIBUTE_FPTR_PRINTF(1,0);
687 extern void (*deprecated_interactive_hook
) (void);
688 extern void (*deprecated_readline_begin_hook
) (char *, ...)
689 ATTRIBUTE_FPTR_PRINTF_1
;
690 extern char *(*deprecated_readline_hook
) (char *);
691 extern void (*deprecated_readline_end_hook
) (void);
692 extern void (*deprecated_register_changed_hook
) (int regno
);
693 extern void (*deprecated_context_hook
) (int);
694 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
695 struct target_waitstatus
*status
,
698 extern void (*deprecated_attach_hook
) (void);
699 extern void (*deprecated_detach_hook
) (void);
700 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
701 char *cmd
, int from_tty
);
703 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
706 /* If this definition isn't overridden by the header files, assume
707 that isatty and fileno exist on this system. */
709 #define ISATTY(FP) (isatty (fileno (FP)))
712 /* * A width that can achieve a better legibility for GDB MI mode. */
713 #define GDB_MI_MSG_WIDTH 80
715 /* From progspace.c */
717 extern void initialize_progspace (void);
718 extern void initialize_inferiors (void);
720 /* * Special block numbers */
726 FIRST_LOCAL_BLOCK
= 2
731 #endif /* #ifndef DEFS_H */