1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
3 /* Basic, host-specific, and target-specific definitions for GDB.
4 Copyright (C) 1986-2016 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>
33 /* The libdecnumber library, on which GDB depends, includes a header file
34 called gstdint.h instead of relying directly on stdint.h. GDB, on the
35 other hand, includes stdint.h directly, relying on the fact that gnulib
36 generates a copy if the system doesn't provide one or if it is missing
37 some features. Unfortunately, gstdint.h and stdint.h cannot be included
38 at the same time, which may happen when we include a file from
41 The following macro definition effectively prevents the inclusion of
42 gstdint.h, as all the definitions it provides are guarded against
43 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
44 included, so it's ok to blank out gstdint.h. */
45 #define GCC_GENERATED_STDINT_H 1
51 #include "gdb_wchar.h"
55 #include "host-defs.h"
56 #include "common/enum-flags.h"
58 /* Scope types enumerator. List the types of scopes the compiler will
61 enum compile_i_scope_types
63 COMPILE_I_INVALID_SCOPE
,
65 /* A simple scope. Wrap an expression into a simple scope that
66 takes no arguments, returns no value, and uses the generic
67 function name "_gdb_expr". */
69 COMPILE_I_SIMPLE_SCOPE
,
71 /* Do not wrap the expression,
72 it has to provide function "_gdb_expr" on its own. */
75 /* A printable expression scope. Wrap an expression into a scope
76 suitable for the "compile print" command. It uses the generic
77 function name "_gdb_expr". COMPILE_I_PRINT_ADDRESS_SCOPE variant
78 is the usual one, taking address of the object.
79 COMPILE_I_PRINT_VALUE_SCOPE is needed for arrays where the array
80 name already specifies its address. See get_out_value_type. */
81 COMPILE_I_PRINT_ADDRESS_SCOPE
,
82 COMPILE_I_PRINT_VALUE_SCOPE
,
85 /* Just in case they're not defined in stdio.h. */
94 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
95 It is used as an access modifier in calls to open(), where it acts
96 similarly to the "b" character in fopen()'s MODE argument. On Posix
97 platforms it should be a no-op, so it is defined as 0 here. This
98 ensures that the symbol may be used freely elsewhere in gdb. */
106 /* * Enable dbx commands if set. */
107 extern int dbx_commands
;
109 /* * System root path, used to find libraries etc. */
110 extern char *gdb_sysroot
;
112 /* * GDB datadir, used to store data files. */
113 extern char *gdb_datadir
;
115 /* * If non-NULL, the possibly relocated path to python's "lib" directory
116 specified with --with-python. */
117 extern char *python_libdir
;
119 /* * Search path for separate debug files. */
120 extern char *debug_file_directory
;
122 /* GDB's SIGINT handler basically sets a flag; code that might take a
123 long time before it gets back to the event loop, and which ought to
124 be interruptible, checks this flag using the QUIT macro, which, if
125 GDB has the terminal, throws a quit exception.
127 In addition to setting a flag, the SIGINT handler also marks a
128 select/poll-able file descriptor as read-ready. That is used by
129 interruptible_select in order to support interrupting blocking I/O
130 in a race-free manner.
132 These functions use the extension_language_ops API to allow extension
133 language(s) and GDB SIGINT handling to coexist seamlessly. */
135 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
136 will clear the quit flag as a side effect. */
137 extern int check_quit_flag (void);
138 /* * Set the quit flag. */
139 extern void set_quit_flag (void);
141 /* The current quit handler (and its type). This is called from the
142 QUIT macro. See default_quit_handler below for default behavior.
143 Parts of GDB temporarily override this to e.g., completely suppress
144 Ctrl-C because it would not be safe to throw. E.g., normally, you
145 wouldn't want to quit between a RSP command and its response, as
146 that would break the communication with the target, but you may
147 still want to intercept the Ctrl-C and offer to disconnect if the
148 user presses Ctrl-C multiple times while the target is stuck
149 waiting for the wedged remote stub. */
150 typedef void (quit_handler_ftype
) (void);
151 extern quit_handler_ftype
*quit_handler
;
153 /* Override the current quit handler. Sets NEW_QUIT_HANDLER as
154 current quit handler, and installs a cleanup that when run restores
155 the previous quit handler. */
157 make_cleanup_override_quit_handler (quit_handler_ftype
*new_quit_handler
);
159 /* The default quit handler. Checks whether Ctrl-C was pressed, and
162 - If GDB owns the terminal, throws a quit exception.
164 - If GDB does not own the terminal, forwards the Ctrl-C to the
167 extern void default_quit_handler (void);
169 /* Flag that function quit should call quit_force. */
170 extern volatile int sync_quit_force_run
;
172 extern void quit (void);
174 /* Helper for the QUIT macro. */
176 extern void maybe_quit (void);
178 /* Check whether a Ctrl-C was typed, and if so, call the current quit
180 #define QUIT maybe_quit ()
182 /* Set the serial event associated with the quit flag. */
183 extern void quit_serial_event_set (void);
185 /* Clear the serial event associated with the quit flag. */
186 extern void quit_serial_event_clear (void);
188 /* * Languages represented in the symbol table and elsewhere.
189 This should probably be in language.h, but since enum's can't
190 be forward declared to satisfy opaque references before their
191 actual definition, needs to be here.
193 The constants here are in priority order. In particular,
194 demangling is attempted according to this order.
196 Note that there's ambiguity between the mangling schemes of some of
197 these languages, so some symbols could be successfully demangled by
198 several languages. For that reason, the constants here are sorted
199 in the order we'll attempt demangling them. For example: Java and
200 Rust use C++ mangling, so must come after C++; Ada must come last
201 (see ada_sniff_from_mangled_name). */
205 language_unknown
, /* Language not known */
206 language_auto
, /* Placeholder for automatic setting */
208 language_objc
, /* Objective-C */
209 language_cplus
, /* C++ */
210 language_java
, /* Java */
212 language_go
, /* Go */
213 language_fortran
, /* Fortran */
214 language_m2
, /* Modula-2 */
215 language_asm
, /* Assembly language */
216 language_pascal
, /* Pascal */
217 language_opencl
, /* OpenCL */
218 language_rust
, /* Rust */
219 language_minimal
, /* All other languages, minimal support only */
220 language_ada
, /* Ada */
224 /* The number of bits needed to represent all languages, with enough
225 padding to allow for reasonable growth. */
226 #define LANGUAGE_BITS 5
227 gdb_static_assert (nr_languages
<= (1 << LANGUAGE_BITS
));
233 unspecified_precision
236 /* * A generic, not quite boolean, enumeration. This is used for
237 set/show commands in which the options are on/off/automatic. */
245 /* * Potential ways that a function can return a value of a given
248 enum return_value_convention
250 /* * Where the return value has been squeezed into one or more
252 RETURN_VALUE_REGISTER_CONVENTION
,
253 /* * Commonly known as the "struct return convention". The caller
254 passes an additional hidden first parameter to the caller. That
255 parameter contains the address at which the value being returned
256 should be stored. While typically, and historically, used for
257 large structs, this is convention is applied to values of many
259 RETURN_VALUE_STRUCT_CONVENTION
,
260 /* * Like the "struct return convention" above, but where the ABI
261 guarantees that the called function stores the address at which
262 the value being returned is stored in a well-defined location,
263 such as a register or memory slot in the stack frame. Don't use
264 this if the ABI doesn't explicitly guarantees this. */
265 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
266 /* * Like the "struct return convention" above, but where the ABI
267 guarantees that the address at which the value being returned is
268 stored will be available in a well-defined location, such as a
269 register or memory slot in the stack frame. Don't use this if
270 the ABI doesn't explicitly guarantees this. */
271 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
274 /* Needed for various prototypes */
284 /* This really belong in utils.c (path-utils.c?), but it references some
285 globals that are currently only available to main.c. */
286 extern char *relocate_gdb_directory (const char *initial
, int flag
);
289 /* Annotation stuff. */
291 extern int annotation_level
; /* in stack.c */
294 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
295 "const char *" in unistd.h, so we can't declare the argument
298 EXTERN_C
char *re_comp (const char *);
302 extern void symbol_file_command (char *, int);
304 /* * Remote targets may wish to use this as their load function. */
305 extern void generic_load (const char *name
, int from_tty
);
307 /* * Report on STREAM the performance of memory transfer operation,
309 @param DATA_COUNT is the number of bytes transferred.
310 @param WRITE_COUNT is the number of separate write operations, or 0,
311 if that information is not available.
312 @param START_TIME is the time at which an operation was started.
313 @param END_TIME is the time at which an operation ended. */
315 extern void print_transfer_performance (struct ui_file
*stream
,
316 unsigned long data_count
,
317 unsigned long write_count
,
318 const struct timeval
*start_time
,
319 const struct timeval
*end_time
);
323 typedef void initialize_file_ftype (void);
325 extern char *gdb_readline_wrapper (const char *);
327 extern char *command_line_input (const char *, int, char *);
329 extern void print_prompt (void);
333 extern int input_interactive_p (struct ui
*);
335 extern int info_verbose
;
337 /* From printcmd.c */
339 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
341 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
342 struct ui_file
*, int, char *);
344 extern int build_address_symbolic (struct gdbarch
*,
353 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
354 extern const char *pc_prefix (CORE_ADDR
);
358 /* See openp function definition for their description. */
359 #define OPF_TRY_CWD_FIRST 0x01
360 #define OPF_SEARCH_IN_PATH 0x02
361 #define OPF_RETURN_REALPATH 0x04
363 extern int openp (const char *, int, const char *, int, char **);
365 extern int source_full_path_of (const char *, char **);
367 extern void mod_path (char *, char **);
369 extern void add_path (char *, char **, int);
371 extern void directory_switch (char *, int);
373 extern char *source_path
;
375 extern void init_source_path (void);
379 /* * Process memory area starting at ADDR with length SIZE. Area is
380 readable iff READ is non-zero, writable if WRITE is non-zero,
381 executable if EXEC is non-zero. Area is possibly changed against
382 its original file based copy if MODIFIED is non-zero. DATA is
383 passed without changes from a caller. */
385 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
386 int read
, int write
, int exec
,
387 int modified
, void *data
);
389 /* * Possible lvalue types. Like enum language, this should be in
390 value.h, but needs to be here for the same reason. */
398 /* * In a register. Registers are relative to a frame. */
400 /* * In a gdb internal variable. */
402 /* * Value encapsulates a callable defined in an extension language. */
404 /* * Part of a gdb internal variable (structure field). */
405 lval_internalvar_component
,
406 /* * Value's bits are fetched and stored using functions provided
411 /* * Control types for commands. */
413 enum misc_command_type
421 enum command_control_type
432 while_stepping_control
,
436 /* * Structure for saved commands lines (for breakpoints, defined
441 struct command_line
*next
;
443 enum command_control_type control_type
;
448 enum compile_i_scope_types scope
;
454 /* * The number of elements in body_list. */
456 /* * For composite commands, the nested lists of commands. For
457 example, for "if" command this will contain the then branch and
458 the else branch, if that is available. */
459 struct command_line
**body_list
;
462 extern struct command_line
*read_command_lines (char *, int, int,
463 void (*)(char *, void *),
465 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
466 void (*)(char *, void *),
469 extern void free_command_lines (struct command_line
**);
471 /* * Parameters of the "info proc" command. */
475 /* * Display the default cmdline, cwd and exe outputs. */
478 /* * Display `info proc mappings'. */
481 /* * Display `info proc status'. */
484 /* * Display `info proc stat'. */
487 /* * Display `info proc cmdline'. */
490 /* * Display `info proc exe'. */
493 /* * Display `info proc cwd'. */
496 /* * Display all of the above. */
500 /* * String containing the current directory (what getwd would return). */
502 extern char *current_directory
;
504 /* * Default radixes for input and output. Only some values supported. */
505 extern unsigned input_radix
;
506 extern unsigned output_radix
;
508 /* * Possibilities for prettyformat parameters to routines which print
509 things. Like enum language, this should be in value.h, but needs
510 to be here for the same reason. FIXME: If we can eliminate this
511 as an arg to LA_VAL_PRINT, then we can probably move it back to
514 enum val_prettyformat
516 Val_no_prettyformat
= 0,
518 /* * Use the default setting which the user has specified. */
519 Val_prettyformat_default
522 /* * Optional native machine support. Non-native (and possibly pure
523 multi-arch) targets do not need a "nm.h" file. This will be a
524 symlink to one of the nm-*.h files, built by the `configure'
531 /* Assume that fopen accepts the letter "b" in the mode string.
532 It is demanded by ISO C9X, and should be supported on all
533 platforms that claim to have a standard-conforming C library. On
534 true POSIX systems it will be ignored and have no effect. There
535 may still be systems without a standard-conforming C library where
536 an ISO C9X compiler (GCC) is available. Known examples are SunOS
537 4.x and 4.3BSD. This assumption means these systems are no longer
540 # include "fopen-bin.h"
543 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
544 FIXME: Assumes 2's complement arithmetic. */
546 #if !defined (UINT_MAX)
547 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
550 #if !defined (INT_MAX)
551 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
554 #if !defined (INT_MIN)
555 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
558 #if !defined (ULONG_MAX)
559 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
562 #if !defined (LONG_MAX)
563 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
566 #if !defined (ULONGEST_MAX)
567 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
570 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
571 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
574 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
575 arguments to a function, number in a value history, register number, etc.)
576 where the value must not be larger than can fit in an int. */
578 extern int longest_to_int (LONGEST
);
580 /* * List of known OS ABIs. If you change this, make sure to update the
584 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
586 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
592 GDB_OSABI_FREEBSD_AOUT
,
593 GDB_OSABI_FREEBSD_ELF
,
594 GDB_OSABI_NETBSD_AOUT
,
595 GDB_OSABI_NETBSD_ELF
,
596 GDB_OSABI_OPENBSD_ELF
,
613 GDB_OSABI_INVALID
/* keep this last */
616 /* Global functions from other, non-gdb GNU thingies.
617 Libiberty thingies are no longer declared here. We include libiberty.h
620 /* From other system libraries */
623 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
626 /* Enumerate the requirements a symbol has in order to be evaluated.
627 These are listed in order of "strength" -- a later entry subsumes
628 earlier ones. This fine-grained distinction is important because
629 it allows for the evaluation of a TLS symbol during unwinding --
630 when unwinding one has access to registers, but not the frame
631 itself, because that is being constructed. */
633 enum symbol_needs_kind
635 /* No special requirements -- just memory. */
638 /* The symbol needs registers. */
639 SYMBOL_NEEDS_REGISTERS
,
641 /* The symbol needs a frame. */
645 /* Dynamic target-system-dependent parameters for GDB. */
648 /* * Maximum size of a register. Something small, but large enough for
649 all known ISAs. If it turns out to be too small, make it bigger. */
651 enum { MAX_REGISTER_SIZE
= 64 };
655 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
658 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
661 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
662 enum bfd_endian
, LONGEST
*);
664 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
667 extern void store_signed_integer (gdb_byte
*, int,
668 enum bfd_endian
, LONGEST
);
670 extern void store_unsigned_integer (gdb_byte
*, int,
671 enum bfd_endian
, ULONGEST
);
673 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
681 /* Hooks for alternate command interfaces. */
683 /* * The name of the interpreter if specified on the command line. */
684 extern char *interpreter_p
;
686 struct target_waitstatus
;
687 struct cmd_list_element
;
689 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
690 extern void (*deprecated_post_add_symbol_hook
) (void);
691 extern void (*selected_frame_level_changed_hook
) (int);
692 extern int (*deprecated_ui_loop_hook
) (int signo
);
693 extern void (*deprecated_show_load_progress
) (const char *section
,
694 unsigned long section_sent
,
695 unsigned long section_size
,
696 unsigned long total_sent
,
697 unsigned long total_size
);
698 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
702 extern int (*deprecated_query_hook
) (const char *, va_list)
703 ATTRIBUTE_FPTR_PRINTF(1,0);
704 extern void (*deprecated_warning_hook
) (const char *, va_list)
705 ATTRIBUTE_FPTR_PRINTF(1,0);
706 extern void (*deprecated_interactive_hook
) (void);
707 extern void (*deprecated_readline_begin_hook
) (char *, ...)
708 ATTRIBUTE_FPTR_PRINTF_1
;
709 extern char *(*deprecated_readline_hook
) (const char *);
710 extern void (*deprecated_readline_end_hook
) (void);
711 extern void (*deprecated_context_hook
) (int);
712 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
713 struct target_waitstatus
*status
,
716 extern void (*deprecated_attach_hook
) (void);
717 extern void (*deprecated_detach_hook
) (void);
718 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
719 char *cmd
, int from_tty
);
721 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
724 /* If this definition isn't overridden by the header files, assume
725 that isatty and fileno exist on this system. */
727 #define ISATTY(FP) (isatty (fileno (FP)))
730 /* * A width that can achieve a better legibility for GDB MI mode. */
731 #define GDB_MI_MSG_WIDTH 80
733 /* From progspace.c */
735 extern void initialize_progspace (void);
736 extern void initialize_inferiors (void);
738 /* * Special block numbers */
744 FIRST_LOCAL_BLOCK
= 2
747 /* User selection used in observer.h and multiple print functions. */
749 enum user_selected_what_flag
751 /* Inferior selected. */
752 USER_SELECTED_INFERIOR
= 1 << 1,
754 /* Thread selected. */
755 USER_SELECTED_THREAD
= 1 << 2,
757 /* Frame selected. */
758 USER_SELECTED_FRAME
= 1 << 3
760 DEF_ENUM_FLAGS_TYPE (enum user_selected_what_flag
, user_selected_what
);
764 #endif /* #ifndef DEFS_H */