1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
3 /* Basic, host-specific, and target-specific definitions for GDB.
4 Copyright (C) 1986-2019 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 "gdbsupport/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 "gdbsupport/host-defs.h"
56 #include "gdbsupport/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 /* The default quit handler. Checks whether Ctrl-C was pressed, and
161 - If GDB owns the terminal, throws a quit exception.
163 - If GDB does not own the terminal, forwards the Ctrl-C to the
166 extern void default_quit_handler (void);
168 /* Flag that function quit should call quit_force. */
169 extern volatile int sync_quit_force_run;
171 extern void quit (void);
173 /* Helper for the QUIT macro. */
175 extern void maybe_quit (void);
177 /* Check whether a Ctrl-C was typed, and if so, call the current quit
179 #define QUIT maybe_quit ()
181 /* Set the serial event associated with the quit flag. */
182 extern void quit_serial_event_set (void);
184 /* Clear the serial event associated with the quit flag. */
185 extern void quit_serial_event_clear (void);
187 /* * Languages represented in the symbol table and elsewhere.
188 This should probably be in language.h, but since enum's can't
189 be forward declared to satisfy opaque references before their
190 actual definition, needs to be here.
192 The constants here are in priority order. In particular,
193 demangling is attempted according to this order.
195 Note that there's ambiguity between the mangling schemes of some of
196 these languages, so some symbols could be successfully demangled by
197 several languages. For that reason, the constants here are sorted
198 in the order we'll attempt demangling them. For example: Rust uses
199 C++ mangling, so must come after C++; Ada must come last (see
200 ada_sniff_from_mangled_name). (Keep this order in sync with the
201 'languages' array in language.c.) */
205 language_unknown, /* Language not known */
206 language_auto, /* Placeholder for automatic setting */
208 language_objc, /* Objective-C */
209 language_cplus, /* C++ */
211 language_go, /* Go */
212 language_fortran, /* Fortran */
213 language_m2, /* Modula-2 */
214 language_asm, /* Assembly language */
215 language_pascal, /* Pascal */
216 language_opencl, /* OpenCL */
217 language_rust, /* Rust */
218 language_minimal, /* All other languages, minimal support only */
219 language_ada, /* Ada */
223 /* The number of bits needed to represent all languages, with enough
224 padding to allow for reasonable growth. */
225 #define LANGUAGE_BITS 5
226 gdb_static_assert (nr_languages <= (1 << LANGUAGE_BITS));
232 unspecified_precision
235 /* * A generic, not quite boolean, enumeration. This is used for
236 set/show commands in which the options are on/off/automatic. */
244 /* * Potential ways that a function can return a value of a given
247 enum return_value_convention
249 /* * Where the return value has been squeezed into one or more
251 RETURN_VALUE_REGISTER_CONVENTION,
252 /* * Commonly known as the "struct return convention". The caller
253 passes an additional hidden first parameter to the caller. That
254 parameter contains the address at which the value being returned
255 should be stored. While typically, and historically, used for
256 large structs, this is convention is applied to values of many
258 RETURN_VALUE_STRUCT_CONVENTION,
259 /* * Like the "struct return convention" above, but where the ABI
260 guarantees that the called function stores the address at which
261 the value being returned is stored in a well-defined location,
262 such as a register or memory slot in the stack frame. Don't use
263 this if the ABI doesn't explicitly guarantees this. */
264 RETURN_VALUE_ABI_RETURNS_ADDRESS,
265 /* * Like the "struct return convention" above, but where the ABI
266 guarantees that the address at which the value being returned is
267 stored will be available in a well-defined location, such as a
268 register or memory slot in the stack frame. Don't use this if
269 the ABI doesn't explicitly guarantees this. */
270 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
273 /* Needed for various prototypes */
283 /* This really belong in utils.c (path-utils.c?), but it references some
284 globals that are currently only available to main.c. */
285 extern char *relocate_gdb_directory (const char *initial, int flag);
288 /* Annotation stuff. */
290 extern int annotation_level; /* in stack.c */
293 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
294 "const char *" in unistd.h, so we can't declare the argument
297 EXTERN_C char *re_comp (const char *);
301 extern void symbol_file_command (const char *, int);
305 typedef void initialize_file_ftype (void);
307 extern char *gdb_readline_wrapper (const char *);
309 extern char *command_line_input (const char *, const char *);
311 extern void print_prompt (void);
315 extern int input_interactive_p (struct ui *);
317 extern int info_verbose;
319 /* From printcmd.c */
321 extern void set_next_address (struct gdbarch *, CORE_ADDR);
323 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
324 struct ui_file *, int,
327 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
328 extern const char *pc_prefix (CORE_ADDR);
332 /* * Process memory area starting at ADDR with length SIZE. Area is
333 readable iff READ is non-zero, writable if WRITE is non-zero,
334 executable if EXEC is non-zero. Area is possibly changed against
335 its original file based copy if MODIFIED is non-zero. DATA is
336 passed without changes from a caller. */
338 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
339 int read, int write, int exec,
340 int modified, void *data);
342 /* * Possible lvalue types. Like enum language, this should be in
343 value.h, but needs to be here for the same reason. */
351 /* * In a register. Registers are relative to a frame. */
353 /* * In a gdb internal variable. */
355 /* * Value encapsulates a callable defined in an extension language. */
357 /* * Part of a gdb internal variable (structure field). */
358 lval_internalvar_component,
359 /* * Value's bits are fetched and stored using functions provided
364 /* * Parameters of the "info proc" command. */
368 /* * Display the default cmdline, cwd and exe outputs. */
371 /* * Display `info proc mappings'. */
374 /* * Display `info proc status'. */
377 /* * Display `info proc stat'. */
380 /* * Display `info proc cmdline'. */
383 /* * Display `info proc exe'. */
386 /* * Display `info proc cwd'. */
389 /* * Display `info proc files'. */
392 /* * Display all of the above. */
396 /* * Default radixes for input and output. Only some values supported. */
397 extern unsigned input_radix;
398 extern unsigned output_radix;
400 /* * Possibilities for prettyformat parameters to routines which print
401 things. Like enum language, this should be in value.h, but needs
402 to be here for the same reason. FIXME: If we can eliminate this
403 as an arg to LA_VAL_PRINT, then we can probably move it back to
406 enum val_prettyformat
408 Val_no_prettyformat = 0,
410 /* * Use the default setting which the user has specified. */
411 Val_prettyformat_default
414 /* * Optional native machine support. Non-native (and possibly pure
415 multi-arch) targets do not need a "nm.h" file. This will be a
416 symlink to one of the nm-*.h files, built by the `configure'
423 /* Assume that fopen accepts the letter "b" in the mode string.
424 It is demanded by ISO C9X, and should be supported on all
425 platforms that claim to have a standard-conforming C library. On
426 true POSIX systems it will be ignored and have no effect. There
427 may still be systems without a standard-conforming C library where
428 an ISO C9X compiler (GCC) is available. Known examples are SunOS
429 4.x and 4.3BSD. This assumption means these systems are no longer
432 # include "fopen-bin.h"
435 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
436 FIXME: Assumes 2's complement arithmetic. */
438 #if !defined (UINT_MAX)
439 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
442 #if !defined (INT_MAX)
443 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
446 #if !defined (INT_MIN)
447 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
450 #if !defined (ULONG_MAX)
451 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
454 #if !defined (LONG_MAX)
455 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
458 #if !defined (ULONGEST_MAX)
459 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
462 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
463 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
466 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
467 arguments to a function, number in a value history, register number, etc.)
468 where the value must not be larger than can fit in an int. */
470 extern int longest_to_int (LONGEST);
472 /* * List of known OS ABIs. If you change this, make sure to update the
476 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
500 GDB_OSABI_INVALID /* keep this last */
503 /* Enumerate the requirements a symbol has in order to be evaluated.
504 These are listed in order of "strength" -- a later entry subsumes
505 earlier ones. This fine-grained distinction is important because
506 it allows for the evaluation of a TLS symbol during unwinding --
507 when unwinding one has access to registers, but not the frame
508 itself, because that is being constructed. */
510 enum symbol_needs_kind
512 /* No special requirements -- just memory. */
515 /* The symbol needs registers. */
516 SYMBOL_NEEDS_REGISTERS,
518 /* The symbol needs a frame. */
522 /* Dynamic target-system-dependent parameters for GDB. */
527 template<typename T, typename = RequireLongest<T>>
528 T extract_integer (const gdb_byte *addr, int len, enum bfd_endian byte_order);
530 static inline LONGEST
531 extract_signed_integer (const gdb_byte *addr, int len,
532 enum bfd_endian byte_order)
534 return extract_integer<LONGEST> (addr, len, byte_order);
537 static inline ULONGEST
538 extract_unsigned_integer (const gdb_byte *addr, int len,
539 enum bfd_endian byte_order)
541 return extract_integer<ULONGEST> (addr, len, byte_order);
544 extern int extract_long_unsigned_integer (const gdb_byte *, int,
545 enum bfd_endian, LONGEST *);
547 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
550 /* All 'store' functions accept a host-format integer and store a
551 target-format integer at ADDR which is LEN bytes long. */
553 template<typename T, typename = RequireLongest<T>>
554 extern void store_integer (gdb_byte *addr, int len, enum bfd_endian byte_order,
558 store_signed_integer (gdb_byte *addr, int len,
559 enum bfd_endian byte_order, LONGEST val)
561 return store_integer (addr, len, byte_order, val);
565 store_unsigned_integer (gdb_byte *addr, int len,
566 enum bfd_endian byte_order, ULONGEST val)
568 return store_integer (addr, len, byte_order, val);
571 extern void store_typed_address (gdb_byte *buf, struct type *type,
574 extern void copy_integer_to_size (gdb_byte *dest, int dest_size,
575 const gdb_byte *source, int source_size,
576 bool is_signed, enum bfd_endian byte_order);
578 /* Hooks for alternate command interfaces. */
580 struct target_waitstatus;
581 struct cmd_list_element;
583 extern void (*deprecated_pre_add_symbol_hook) (const char *);
584 extern void (*deprecated_post_add_symbol_hook) (void);
585 extern void (*selected_frame_level_changed_hook) (int);
586 extern int (*deprecated_ui_loop_hook) (int signo);
587 extern void (*deprecated_show_load_progress) (const char *section,
588 unsigned long section_sent,
589 unsigned long section_size,
590 unsigned long total_sent,
591 unsigned long total_size);
592 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
596 extern int (*deprecated_query_hook) (const char *, va_list)
597 ATTRIBUTE_FPTR_PRINTF(1,0);
598 extern void (*deprecated_warning_hook) (const char *, va_list)
599 ATTRIBUTE_FPTR_PRINTF(1,0);
600 extern void (*deprecated_readline_begin_hook) (const char *, ...)
601 ATTRIBUTE_FPTR_PRINTF_1;
602 extern char *(*deprecated_readline_hook) (const char *);
603 extern void (*deprecated_readline_end_hook) (void);
604 extern void (*deprecated_context_hook) (int);
605 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
606 struct target_waitstatus *status,
609 extern void (*deprecated_attach_hook) (void);
610 extern void (*deprecated_detach_hook) (void);
611 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
612 const char *cmd, int from_tty);
614 extern int (*deprecated_ui_load_progress_hook) (const char *section,
617 /* If this definition isn't overridden by the header files, assume
618 that isatty and fileno exist on this system. */
620 #define ISATTY(FP) (isatty (fileno (FP)))
623 /* * A width that can achieve a better legibility for GDB MI mode. */
624 #define GDB_MI_MSG_WIDTH 80
626 /* From progspace.c */
628 extern void initialize_progspace (void);
629 extern void initialize_inferiors (void);
631 /* * Special block numbers */
637 FIRST_LOCAL_BLOCK = 2
640 /* User selection used in observable.h and multiple print functions. */
642 enum user_selected_what_flag
644 /* Inferior selected. */
645 USER_SELECTED_INFERIOR = 1 << 1,
647 /* Thread selected. */
648 USER_SELECTED_THREAD = 1 << 2,
650 /* Frame selected. */
651 USER_SELECTED_FRAME = 1 << 3
653 DEF_ENUM_FLAGS_TYPE (enum user_selected_what_flag, user_selected_what);
657 #endif /* #ifndef DEFS_H */