1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
3 /* Basic, host-specific, and target-specific definitions for GDB.
4 Copyright (C) 1986-2017 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
,
87 using RequireLongest
= gdb::Requires
<gdb::Or
<std::is_same
<T
, LONGEST
>,
88 std::is_same
<T
, ULONGEST
>>>;
90 /* Just in case they're not defined in stdio.h. */
99 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
100 It is used as an access modifier in calls to open(), where it acts
101 similarly to the "b" character in fopen()'s MODE argument. On Posix
102 platforms it should be a no-op, so it is defined as 0 here. This
103 ensures that the symbol may be used freely elsewhere in gdb. */
111 /* * Enable dbx commands if set. */
112 extern int dbx_commands
;
114 /* * System root path, used to find libraries etc. */
115 extern char *gdb_sysroot
;
117 /* * GDB datadir, used to store data files. */
118 extern char *gdb_datadir
;
120 /* * If non-NULL, the possibly relocated path to python's "lib" directory
121 specified with --with-python. */
122 extern char *python_libdir
;
124 /* * Search path for separate debug files. */
125 extern char *debug_file_directory
;
127 /* GDB's SIGINT handler basically sets a flag; code that might take a
128 long time before it gets back to the event loop, and which ought to
129 be interruptible, checks this flag using the QUIT macro, which, if
130 GDB has the terminal, throws a quit exception.
132 In addition to setting a flag, the SIGINT handler also marks a
133 select/poll-able file descriptor as read-ready. That is used by
134 interruptible_select in order to support interrupting blocking I/O
135 in a race-free manner.
137 These functions use the extension_language_ops API to allow extension
138 language(s) and GDB SIGINT handling to coexist seamlessly. */
140 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
141 will clear the quit flag as a side effect. */
142 extern int check_quit_flag (void);
143 /* * Set the quit flag. */
144 extern void set_quit_flag (void);
146 /* The current quit handler (and its type). This is called from the
147 QUIT macro. See default_quit_handler below for default behavior.
148 Parts of GDB temporarily override this to e.g., completely suppress
149 Ctrl-C because it would not be safe to throw. E.g., normally, you
150 wouldn't want to quit between a RSP command and its response, as
151 that would break the communication with the target, but you may
152 still want to intercept the Ctrl-C and offer to disconnect if the
153 user presses Ctrl-C multiple times while the target is stuck
154 waiting for the wedged remote stub. */
155 typedef void (quit_handler_ftype
) (void);
156 extern quit_handler_ftype
*quit_handler
;
158 /* Override the current quit handler. Sets NEW_QUIT_HANDLER as
159 current quit handler, and installs a cleanup that when run restores
160 the previous quit handler. */
162 make_cleanup_override_quit_handler (quit_handler_ftype
*new_quit_handler
);
164 /* The default quit handler. Checks whether Ctrl-C was pressed, and
167 - If GDB owns the terminal, throws a quit exception.
169 - If GDB does not own the terminal, forwards the Ctrl-C to the
172 extern void default_quit_handler (void);
174 /* Flag that function quit should call quit_force. */
175 extern volatile int sync_quit_force_run
;
177 extern void quit (void);
179 /* Helper for the QUIT macro. */
181 extern void maybe_quit (void);
183 /* Check whether a Ctrl-C was typed, and if so, call the current quit
185 #define QUIT maybe_quit ()
187 /* Set the serial event associated with the quit flag. */
188 extern void quit_serial_event_set (void);
190 /* Clear the serial event associated with the quit flag. */
191 extern void quit_serial_event_clear (void);
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.
198 The constants here are in priority order. In particular,
199 demangling is attempted according to this order.
201 Note that there's ambiguity between the mangling schemes of some of
202 these languages, so some symbols could be successfully demangled by
203 several languages. For that reason, the constants here are sorted
204 in the order we'll attempt demangling them. For example: Rust uses
205 C++ mangling, so must come after C++; Ada must come last (see
206 ada_sniff_from_mangled_name). */
210 language_unknown
, /* Language not known */
211 language_auto
, /* Placeholder for automatic setting */
213 language_objc
, /* Objective-C */
214 language_cplus
, /* C++ */
216 language_go
, /* Go */
217 language_fortran
, /* Fortran */
218 language_m2
, /* Modula-2 */
219 language_asm
, /* Assembly language */
220 language_pascal
, /* Pascal */
221 language_opencl
, /* OpenCL */
222 language_rust
, /* Rust */
223 language_minimal
, /* All other languages, minimal support only */
224 language_ada
, /* Ada */
228 /* The number of bits needed to represent all languages, with enough
229 padding to allow for reasonable growth. */
230 #define LANGUAGE_BITS 5
231 gdb_static_assert (nr_languages
<= (1 << LANGUAGE_BITS
));
237 unspecified_precision
240 /* * A generic, not quite boolean, enumeration. This is used for
241 set/show commands in which the options are on/off/automatic. */
249 /* * Potential ways that a function can return a value of a given
252 enum return_value_convention
254 /* * Where the return value has been squeezed into one or more
256 RETURN_VALUE_REGISTER_CONVENTION
,
257 /* * Commonly known as the "struct return convention". The caller
258 passes an additional hidden first parameter to the caller. That
259 parameter contains the address at which the value being returned
260 should be stored. While typically, and historically, used for
261 large structs, this is convention is applied to values of many
263 RETURN_VALUE_STRUCT_CONVENTION
,
264 /* * Like the "struct return convention" above, but where the ABI
265 guarantees that the called function stores the address at which
266 the value being returned is stored in a well-defined location,
267 such as a register or memory slot in the stack frame. Don't use
268 this if the ABI doesn't explicitly guarantees this. */
269 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
270 /* * Like the "struct return convention" above, but where the ABI
271 guarantees that the address at which the value being returned is
272 stored will be available in a well-defined location, such as a
273 register or memory slot in the stack frame. Don't use this if
274 the ABI doesn't explicitly guarantees this. */
275 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
278 /* Needed for various prototypes */
288 /* This really belong in utils.c (path-utils.c?), but it references some
289 globals that are currently only available to main.c. */
290 extern char *relocate_gdb_directory (const char *initial
, int flag
);
293 /* Annotation stuff. */
295 extern int annotation_level
; /* in stack.c */
298 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
299 "const char *" in unistd.h, so we can't declare the argument
302 EXTERN_C
char *re_comp (const char *);
306 extern void symbol_file_command (char *, int);
308 /* * Remote targets may wish to use this as their load function. */
309 extern void generic_load (const char *name
, int from_tty
);
313 typedef void initialize_file_ftype (void);
315 extern char *gdb_readline_wrapper (const char *);
317 extern char *command_line_input (const char *, int, const char *);
319 extern void print_prompt (void);
323 extern int input_interactive_p (struct ui
*);
325 extern int info_verbose
;
327 /* From printcmd.c */
329 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
331 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
332 struct ui_file
*, int,
335 extern int build_address_symbolic (struct gdbarch
*,
344 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
345 extern const char *pc_prefix (CORE_ADDR
);
349 /* See openp function definition for their description. */
350 #define OPF_TRY_CWD_FIRST 0x01
351 #define OPF_SEARCH_IN_PATH 0x02
352 #define OPF_RETURN_REALPATH 0x04
354 extern int openp (const char *, int, const char *, int, char **);
356 extern int source_full_path_of (const char *, char **);
358 extern void mod_path (char *, char **);
360 extern void add_path (char *, char **, int);
362 extern void directory_switch (char *, int);
364 extern char *source_path
;
366 extern void init_source_path (void);
370 /* * Process memory area starting at ADDR with length SIZE. Area is
371 readable iff READ is non-zero, writable if WRITE is non-zero,
372 executable if EXEC is non-zero. Area is possibly changed against
373 its original file based copy if MODIFIED is non-zero. DATA is
374 passed without changes from a caller. */
376 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
377 int read
, int write
, int exec
,
378 int modified
, void *data
);
380 /* * Possible lvalue types. Like enum language, this should be in
381 value.h, but needs to be here for the same reason. */
389 /* * In a register. Registers are relative to a frame. */
391 /* * In a gdb internal variable. */
393 /* * Value encapsulates a callable defined in an extension language. */
395 /* * Part of a gdb internal variable (structure field). */
396 lval_internalvar_component
,
397 /* * Value's bits are fetched and stored using functions provided
402 /* * Control types for commands. */
404 enum misc_command_type
412 enum command_control_type
423 while_stepping_control
,
427 /* * Structure for saved commands lines (for breakpoints, defined
432 struct command_line
*next
;
434 enum command_control_type control_type
;
439 enum compile_i_scope_types scope
;
445 /* * The number of elements in body_list. */
447 /* * For composite commands, the nested lists of commands. For
448 example, for "if" command this will contain the then branch and
449 the else branch, if that is available. */
450 struct command_line
**body_list
;
453 extern void free_command_lines (struct command_line
**);
455 /* A deleter for command_line that calls free_command_lines. */
457 struct command_lines_deleter
459 void operator() (command_line
*lines
) const
461 free_command_lines (&lines
);
465 /* A unique pointer to a command_line. */
467 typedef std::unique_ptr
<command_line
, command_lines_deleter
> command_line_up
;
469 extern command_line_up
read_command_lines (char *, int, int,
470 void (*)(char *, void *),
472 extern command_line_up
read_command_lines_1 (char * (*) (void), int,
473 void (*)(char *, void *),
476 /* * Parameters of the "info proc" command. */
480 /* * Display the default cmdline, cwd and exe outputs. */
483 /* * Display `info proc mappings'. */
486 /* * Display `info proc status'. */
489 /* * Display `info proc stat'. */
492 /* * Display `info proc cmdline'. */
495 /* * Display `info proc exe'. */
498 /* * Display `info proc cwd'. */
501 /* * Display all of the above. */
505 /* * String containing the current directory (what getwd would return). */
507 extern char *current_directory
;
509 /* * Default radixes for input and output. Only some values supported. */
510 extern unsigned input_radix
;
511 extern unsigned output_radix
;
513 /* * Possibilities for prettyformat parameters to routines which print
514 things. Like enum language, this should be in value.h, but needs
515 to be here for the same reason. FIXME: If we can eliminate this
516 as an arg to LA_VAL_PRINT, then we can probably move it back to
519 enum val_prettyformat
521 Val_no_prettyformat
= 0,
523 /* * Use the default setting which the user has specified. */
524 Val_prettyformat_default
527 /* * Optional native machine support. Non-native (and possibly pure
528 multi-arch) targets do not need a "nm.h" file. This will be a
529 symlink to one of the nm-*.h files, built by the `configure'
536 /* Assume that fopen accepts the letter "b" in the mode string.
537 It is demanded by ISO C9X, and should be supported on all
538 platforms that claim to have a standard-conforming C library. On
539 true POSIX systems it will be ignored and have no effect. There
540 may still be systems without a standard-conforming C library where
541 an ISO C9X compiler (GCC) is available. Known examples are SunOS
542 4.x and 4.3BSD. This assumption means these systems are no longer
545 # include "fopen-bin.h"
548 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
549 FIXME: Assumes 2's complement arithmetic. */
551 #if !defined (UINT_MAX)
552 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
555 #if !defined (INT_MAX)
556 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
559 #if !defined (INT_MIN)
560 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
563 #if !defined (ULONG_MAX)
564 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
567 #if !defined (LONG_MAX)
568 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
571 #if !defined (ULONGEST_MAX)
572 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
575 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
576 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
579 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
580 arguments to a function, number in a value history, register number, etc.)
581 where the value must not be larger than can fit in an int. */
583 extern int longest_to_int (LONGEST
);
585 /* * List of known OS ABIs. If you change this, make sure to update the
589 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
591 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
613 GDB_OSABI_INVALID
/* keep this last */
616 /* Enumerate the requirements a symbol has in order to be evaluated.
617 These are listed in order of "strength" -- a later entry subsumes
618 earlier ones. This fine-grained distinction is important because
619 it allows for the evaluation of a TLS symbol during unwinding --
620 when unwinding one has access to registers, but not the frame
621 itself, because that is being constructed. */
623 enum symbol_needs_kind
625 /* No special requirements -- just memory. */
628 /* The symbol needs registers. */
629 SYMBOL_NEEDS_REGISTERS
,
631 /* The symbol needs a frame. */
635 /* Dynamic target-system-dependent parameters for GDB. */
638 /* * Maximum size of a register. Something small, but large enough for
639 all known ISAs. If it turns out to be too small, make it bigger. */
641 enum { MAX_REGISTER_SIZE
= 64 };
645 template<typename T
, typename
= RequireLongest
<T
>>
646 T
extract_integer (const gdb_byte
*addr
, int len
, enum bfd_endian byte_order
);
648 static inline LONGEST
649 extract_signed_integer (const gdb_byte
*addr
, int len
,
650 enum bfd_endian byte_order
)
652 return extract_integer
<LONGEST
> (addr
, len
, byte_order
);
655 static inline ULONGEST
656 extract_unsigned_integer (const gdb_byte
*addr
, int len
,
657 enum bfd_endian byte_order
)
659 return extract_integer
<ULONGEST
> (addr
, len
, byte_order
);
662 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
663 enum bfd_endian
, LONGEST
*);
665 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
668 /* All 'store' functions accept a host-format integer and store a
669 target-format integer at ADDR which is LEN bytes long. */
671 template<typename T
, typename
= RequireLongest
<T
>>
672 extern void store_integer (gdb_byte
*addr
, int len
, enum bfd_endian byte_order
,
676 store_signed_integer (gdb_byte
*addr
, int len
,
677 enum bfd_endian byte_order
, LONGEST val
)
679 return store_integer (addr
, len
, byte_order
, val
);
683 store_unsigned_integer (gdb_byte
*addr
, int len
,
684 enum bfd_endian byte_order
, ULONGEST val
)
686 return store_integer (addr
, len
, byte_order
, val
);
689 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
692 extern void copy_integer_to_size (gdb_byte
*dest
, int dest_size
,
693 const gdb_byte
*source
, int source_size
,
694 bool is_signed
, enum bfd_endian byte_order
);
700 /* From dwarf2read.c */
702 ULONGEST
read_unsigned_leb128 (bfd
*, const gdb_byte
*, unsigned int *);
704 /* Hooks for alternate command interfaces. */
706 /* * The name of the interpreter if specified on the command line. */
707 extern char *interpreter_p
;
709 struct target_waitstatus
;
710 struct cmd_list_element
;
712 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
713 extern void (*deprecated_post_add_symbol_hook
) (void);
714 extern void (*selected_frame_level_changed_hook
) (int);
715 extern int (*deprecated_ui_loop_hook
) (int signo
);
716 extern void (*deprecated_show_load_progress
) (const char *section
,
717 unsigned long section_sent
,
718 unsigned long section_size
,
719 unsigned long total_sent
,
720 unsigned long total_size
);
721 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
725 extern int (*deprecated_query_hook
) (const char *, va_list)
726 ATTRIBUTE_FPTR_PRINTF(1,0);
727 extern void (*deprecated_warning_hook
) (const char *, va_list)
728 ATTRIBUTE_FPTR_PRINTF(1,0);
729 extern void (*deprecated_interactive_hook
) (void);
730 extern void (*deprecated_readline_begin_hook
) (const char *, ...)
731 ATTRIBUTE_FPTR_PRINTF_1
;
732 extern char *(*deprecated_readline_hook
) (const char *);
733 extern void (*deprecated_readline_end_hook
) (void);
734 extern void (*deprecated_context_hook
) (int);
735 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
736 struct target_waitstatus
*status
,
739 extern void (*deprecated_attach_hook
) (void);
740 extern void (*deprecated_detach_hook
) (void);
741 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
742 char *cmd
, int from_tty
);
744 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
747 /* If this definition isn't overridden by the header files, assume
748 that isatty and fileno exist on this system. */
750 #define ISATTY(FP) (isatty (fileno (FP)))
753 /* * A width that can achieve a better legibility for GDB MI mode. */
754 #define GDB_MI_MSG_WIDTH 80
756 /* From progspace.c */
758 extern void initialize_progspace (void);
759 extern void initialize_inferiors (void);
761 /* * Special block numbers */
767 FIRST_LOCAL_BLOCK
= 2
770 /* User selection used in observer.h and multiple print functions. */
772 enum user_selected_what_flag
774 /* Inferior selected. */
775 USER_SELECTED_INFERIOR
= 1 << 1,
777 /* Thread selected. */
778 USER_SELECTED_THREAD
= 1 << 2,
780 /* Frame selected. */
781 USER_SELECTED_FRAME
= 1 << 3
783 DEF_ENUM_FLAGS_TYPE (enum user_selected_what_flag
, user_selected_what
);
787 #endif /* #ifndef DEFS_H */