1 /* Basic, host-specific, and target-specific definitions for GDB.
2 Copyright (C) 1986-2023 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 # error gdbserver should not include gdb/defs.h
26 #include "gdbsupport/common-defs.h"
30 #undef PACKAGE_VERSION
32 #undef PACKAGE_TARNAME
37 #include <sys/types.h>
40 /* The libdecnumber library, on which GDB depends, includes a header file
41 called gstdint.h instead of relying directly on stdint.h. GDB, on the
42 other hand, includes stdint.h directly, relying on the fact that gnulib
43 generates a copy if the system doesn't provide one or if it is missing
44 some features. Unfortunately, gstdint.h and stdint.h cannot be included
45 at the same time, which may happen when we include a file from
48 The following macro definition effectively prevents the inclusion of
49 gstdint.h, as all the definitions it provides are guarded against
50 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
51 included, so it's ok to blank out gstdint.h. */
52 #define GCC_GENERATED_STDINT_H 1
58 #include "gdb_wchar.h"
62 #include "gdbsupport/host-defs.h"
63 #include "gdbsupport/enum-flags.h"
64 #include "gdbsupport/array-view.h"
66 /* Scope types enumerator. List the types of scopes the compiler will
69 enum compile_i_scope_types
71 COMPILE_I_INVALID_SCOPE
,
73 /* A simple scope. Wrap an expression into a simple scope that
74 takes no arguments, returns no value, and uses the generic
75 function name "_gdb_expr". */
77 COMPILE_I_SIMPLE_SCOPE
,
79 /* Do not wrap the expression,
80 it has to provide function "_gdb_expr" on its own. */
83 /* A printable expression scope. Wrap an expression into a scope
84 suitable for the "compile print" command. It uses the generic
85 function name "_gdb_expr". COMPILE_I_PRINT_ADDRESS_SCOPE variant
86 is the usual one, taking address of the object.
87 COMPILE_I_PRINT_VALUE_SCOPE is needed for arrays where the array
88 name already specifies its address. See get_out_value_type. */
89 COMPILE_I_PRINT_ADDRESS_SCOPE
,
90 COMPILE_I_PRINT_VALUE_SCOPE
,
95 using RequireLongest
= gdb::Requires
<gdb::Or
<std::is_same
<T
, LONGEST
>,
96 std::is_same
<T
, ULONGEST
>>>;
98 /* Just in case they're not defined in stdio.h. */
107 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
108 It is used as an access modifier in calls to open(), where it acts
109 similarly to the "b" character in fopen()'s MODE argument. On Posix
110 platforms it should be a no-op, so it is defined as 0 here. This
111 ensures that the symbol may be used freely elsewhere in gdb. */
119 /* * System root path, used to find libraries etc. */
120 extern std::string gdb_sysroot
;
122 /* * GDB datadir, used to store data files. */
123 extern std::string gdb_datadir
;
125 /* * If not empty, the possibly relocated path to python's "lib" directory
126 specified with --with-python. */
127 extern std::string python_libdir
;
129 /* * Search path for separate debug files. */
130 extern std::string debug_file_directory
;
132 /* GDB's SIGINT handler basically sets a flag; code that might take a
133 long time before it gets back to the event loop, and which ought to
134 be interruptible, checks this flag using the QUIT macro, which, if
135 GDB has the terminal, throws a quit exception.
137 In addition to setting a flag, the SIGINT handler also marks a
138 select/poll-able file descriptor as read-ready. That is used by
139 interruptible_select in order to support interrupting blocking I/O
140 in a race-free manner.
142 These functions use the extension_language_ops API to allow extension
143 language(s) and GDB SIGINT handling to coexist seamlessly. */
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 /* The current quit handler (and its type). This is called from the
152 QUIT macro. See default_quit_handler below for default behavior.
153 Parts of GDB temporarily override this to e.g., completely suppress
154 Ctrl-C because it would not be safe to throw. E.g., normally, you
155 wouldn't want to quit between a RSP command and its response, as
156 that would break the communication with the target, but you may
157 still want to intercept the Ctrl-C and offer to disconnect if the
158 user presses Ctrl-C multiple times while the target is stuck
159 waiting for the wedged remote stub. */
160 typedef void (quit_handler_ftype
) (void);
161 extern quit_handler_ftype
*quit_handler
;
163 /* The default quit handler. Checks whether Ctrl-C was pressed, and
166 - If GDB owns the terminal, throws a quit exception.
168 - If GDB does not own the terminal, forwards the Ctrl-C to the
171 extern void default_quit_handler (void);
173 /* Flag that function quit should call quit_force. */
174 extern volatile bool sync_quit_force_run
;
176 /* Set sync_quit_force_run and also call set_quit_flag(). */
177 extern void set_force_quit_flag ();
179 extern void quit (void);
181 /* Helper for the QUIT macro. */
183 extern void maybe_quit (void);
185 /* Check whether a Ctrl-C was typed, and if so, call the current quit
187 #define QUIT maybe_quit ()
189 /* Set the serial event associated with the quit flag. */
190 extern void quit_serial_event_set (void);
192 /* Clear the serial event associated with the quit flag. */
193 extern void quit_serial_event_clear (void);
195 /* * Languages represented in the symbol table and elsewhere.
196 This should probably be in language.h, but since enum's can't
197 be forward declared to satisfy opaque references before their
198 actual definition, needs to be here.
200 The constants here are in priority order. In particular,
201 demangling is attempted according to this order.
203 Note that there's ambiguity between the mangling schemes of some of
204 these languages, so some symbols could be successfully demangled by
205 several languages. For that reason, the constants here are sorted
206 in the order we'll attempt demangling them. For example: Rust uses
207 a C++-compatible mangling, so must come before C++; Ada must come
208 last (see ada_sniff_from_mangled_name). */
212 language_unknown
, /* Language not known */
214 language_objc
, /* Objective-C */
215 language_rust
, /* Rust */
216 language_cplus
, /* C++ */
218 language_go
, /* Go */
219 language_fortran
, /* Fortran */
220 language_m2
, /* Modula-2 */
221 language_asm
, /* Assembly language */
222 language_pascal
, /* Pascal */
223 language_opencl
, /* OpenCL */
224 language_minimal
, /* All other languages, minimal support only */
225 language_ada
, /* Ada */
229 /* The number of bits needed to represent all languages, with enough
230 padding to allow for reasonable growth. */
231 #define LANGUAGE_BITS 5
232 gdb_static_assert (nr_languages
<= (1 << LANGUAGE_BITS
));
234 /* The number of bytes needed to represent all languages. */
235 #define LANGUAGE_BYTES ((LANGUAGE_BITS + HOST_CHAR_BIT - 1) / HOST_CHAR_BIT)
241 unspecified_precision
244 /* * A generic, not quite boolean, enumeration. This is used for
245 set/show commands in which the options are on/off/automatic. */
253 /* * Potential ways that a function can return a value of a given
256 enum return_value_convention
258 /* * Where the return value has been squeezed into one or more
260 RETURN_VALUE_REGISTER_CONVENTION
,
261 /* * Commonly known as the "struct return convention". The caller
262 passes an additional hidden first parameter to the caller. That
263 parameter contains the address at which the value being returned
264 should be stored. While typically, and historically, used for
265 large structs, this is convention is applied to values of many
267 RETURN_VALUE_STRUCT_CONVENTION
,
268 /* * Like the "struct return convention" above, but where the ABI
269 guarantees that the called function stores the address at which
270 the value being returned is stored in a well-defined location,
271 such as a register or memory slot in the stack frame. Don't use
272 this if the ABI doesn't explicitly guarantees this. */
273 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
274 /* * Like the "struct return convention" above, but where the ABI
275 guarantees that the address at which the value being returned is
276 stored will be available in a well-defined location, such as a
277 register or memory slot in the stack frame. Don't use this if
278 the ABI doesn't explicitly guarantees this. */
279 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
282 /* Needed for various prototypes */
286 class frame_info_ptr
;
292 /* This really belong in utils.c (path-utils.c?), but it references some
293 globals that are currently only available to main.c. */
294 extern std::string
relocate_gdb_directory (const char *initial
, bool relocatable
);
297 /* Annotation stuff. */
299 extern int annotation_level
; /* in stack.c */
302 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
303 "const char *" in unistd.h, so we can't declare the argument
306 extern "C" char *re_comp (const char *);
310 extern void symbol_file_command (const char *, int);
314 typedef void initialize_file_ftype (void);
316 extern char *gdb_readline_wrapper (const char *);
318 extern const char *command_line_input (std::string
&cmd_line_buffer
,
319 const char *, const char *);
321 extern void print_prompt (void);
325 extern bool 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 void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
336 extern const char *pc_prefix (CORE_ADDR
);
340 /* * Process memory area starting at ADDR with length SIZE. Area is
341 readable iff READ is non-zero, writable if WRITE is non-zero,
342 executable if EXEC is non-zero. Area is possibly changed against
343 its original file based copy if MODIFIED is non-zero.
345 MEMORY_TAGGED is true if the memory region contains memory tags, false
348 DATA is passed without changes from a caller. */
350 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
351 int read
, int write
, int exec
,
352 int modified
, bool memory_tagged
,
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 /* * Parameters of the "info proc" command. */
381 /* * Display the default cmdline, cwd and exe outputs. */
384 /* * Display `info proc mappings'. */
387 /* * Display `info proc status'. */
390 /* * Display `info proc stat'. */
393 /* * Display `info proc cmdline'. */
396 /* * Display `info proc exe'. */
399 /* * Display `info proc cwd'. */
402 /* * Display `info proc files'. */
405 /* * Display all of the above. */
409 /* * Default radixes for input and output. Only some values supported. */
410 extern unsigned input_radix
;
411 extern unsigned output_radix
;
413 /* * Optional native machine support. Non-native (and possibly pure
414 multi-arch) targets do not need a "nm.h" file. This will be a
415 symlink to one of the nm-*.h files, built by the `configure'
422 /* Assume that fopen accepts the letter "b" in the mode string.
423 It is demanded by ISO C9X, and should be supported on all
424 platforms that claim to have a standard-conforming C library. On
425 true POSIX systems it will be ignored and have no effect. There
426 may still be systems without a standard-conforming C library where
427 an ISO C9X compiler (GCC) is available. Known examples are SunOS
428 4.x and 4.3BSD. This assumption means these systems are no longer
431 # include "fopen-bin.h"
434 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
435 arguments to a function, number in a value history, register number, etc.)
436 where the value must not be larger than can fit in an int. */
438 extern int longest_to_int (LONGEST
);
440 /* Enumerate the requirements a symbol has in order to be evaluated.
441 These are listed in order of "strength" -- a later entry subsumes
442 earlier ones. This fine-grained distinction is important because
443 it allows for the evaluation of a TLS symbol during unwinding --
444 when unwinding one has access to registers, but not the frame
445 itself, because that is being constructed. */
447 enum symbol_needs_kind
449 /* No special requirements -- just memory. */
452 /* The symbol needs registers. */
453 SYMBOL_NEEDS_REGISTERS
,
455 /* The symbol needs a frame. */
461 template<typename T
, typename
= RequireLongest
<T
>>
462 T
extract_integer (gdb::array_view
<const gdb_byte
>, enum bfd_endian byte_order
);
464 static inline LONGEST
465 extract_signed_integer (gdb::array_view
<const gdb_byte
> buf
,
466 enum bfd_endian byte_order
)
468 return extract_integer
<LONGEST
> (buf
, byte_order
);
471 static inline LONGEST
472 extract_signed_integer (const gdb_byte
*addr
, int len
,
473 enum bfd_endian byte_order
)
475 return extract_signed_integer (gdb::array_view
<const gdb_byte
> (addr
, len
),
479 static inline ULONGEST
480 extract_unsigned_integer (gdb::array_view
<const gdb_byte
> buf
,
481 enum bfd_endian byte_order
)
483 return extract_integer
<ULONGEST
> (buf
, byte_order
);
486 static inline ULONGEST
487 extract_unsigned_integer (const gdb_byte
*addr
, int len
,
488 enum bfd_endian byte_order
)
490 return extract_unsigned_integer (gdb::array_view
<const gdb_byte
> (addr
, len
),
494 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
495 enum bfd_endian
, LONGEST
*);
497 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
500 /* All 'store' functions accept a host-format integer and store a
501 target-format integer at ADDR which is LEN bytes long. */
503 template<typename T
, typename
= RequireLongest
<T
>>
504 extern void store_integer (gdb_byte
*addr
, int len
, enum bfd_endian byte_order
,
508 store_signed_integer (gdb_byte
*addr
, int len
,
509 enum bfd_endian byte_order
, LONGEST val
)
511 return store_integer (addr
, len
, byte_order
, val
);
515 store_unsigned_integer (gdb_byte
*addr
, int len
,
516 enum bfd_endian byte_order
, ULONGEST val
)
518 return store_integer (addr
, len
, byte_order
, val
);
521 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
524 extern void copy_integer_to_size (gdb_byte
*dest
, int dest_size
,
525 const gdb_byte
*source
, int source_size
,
526 bool is_signed
, enum bfd_endian byte_order
);
528 /* Hooks for alternate command interfaces. */
530 struct target_waitstatus
;
531 struct cmd_list_element
;
533 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
534 extern void (*deprecated_post_add_symbol_hook
) (void);
535 extern void (*selected_frame_level_changed_hook
) (int);
536 extern int (*deprecated_ui_loop_hook
) (int signo
);
537 extern void (*deprecated_show_load_progress
) (const char *section
,
538 unsigned long section_sent
,
539 unsigned long section_size
,
540 unsigned long total_sent
,
541 unsigned long total_size
);
542 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
546 extern int (*deprecated_query_hook
) (const char *, va_list)
547 ATTRIBUTE_FPTR_PRINTF(1,0);
548 extern void (*deprecated_warning_hook
) (const char *, va_list)
549 ATTRIBUTE_FPTR_PRINTF(1,0);
550 extern void (*deprecated_readline_begin_hook
) (const char *, ...)
551 ATTRIBUTE_FPTR_PRINTF_1
;
552 extern char *(*deprecated_readline_hook
) (const char *);
553 extern void (*deprecated_readline_end_hook
) (void);
554 extern void (*deprecated_context_hook
) (int);
555 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
556 struct target_waitstatus
*status
,
559 extern void (*deprecated_attach_hook
) (void);
560 extern void (*deprecated_detach_hook
) (void);
561 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
562 const char *cmd
, int from_tty
);
564 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
567 /* If this definition isn't overridden by the header files, assume
568 that isatty and fileno exist on this system. */
570 #define ISATTY(FP) (isatty (fileno (FP)))
573 /* * A width that can achieve a better legibility for GDB MI mode. */
574 #define GDB_MI_MSG_WIDTH 80
576 /* From progspace.c */
578 extern void initialize_progspace (void);
579 extern void initialize_inferiors (void);
581 /* * Special block numbers */
587 FIRST_LOCAL_BLOCK
= 2
590 /* User selection used in observable.h and multiple print functions. */
592 enum user_selected_what_flag
594 /* Inferior selected. */
595 USER_SELECTED_INFERIOR
= 1 << 1,
597 /* Thread selected. */
598 USER_SELECTED_THREAD
= 1 << 2,
600 /* Frame selected. */
601 USER_SELECTED_FRAME
= 1 << 3
603 DEF_ENUM_FLAGS_TYPE (enum user_selected_what_flag
, user_selected_what
);
607 #endif /* #ifndef DEFS_H */