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,
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: Rust uses
200 C++ mangling, so must come after C++; Ada must come last (see
201 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++ */
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 (char *, int);
303 /* * Remote targets may wish to use this as their load function. */
304 extern void generic_load (const char *name, int from_tty);
308 typedef void initialize_file_ftype (void);
310 extern char *gdb_readline_wrapper (const char *);
312 extern char *command_line_input (const char *, int, char *);
314 extern void print_prompt (void);
318 extern int input_interactive_p (struct ui *);
320 extern int info_verbose;
322 /* From printcmd.c */
324 extern void set_next_address (struct gdbarch *, CORE_ADDR);
326 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
327 struct ui_file *, int, char *);
329 extern int build_address_symbolic (struct gdbarch *,
338 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
339 extern const char *pc_prefix (CORE_ADDR);
343 /* See openp function definition for their description. */
344 #define OPF_TRY_CWD_FIRST 0x01
345 #define OPF_SEARCH_IN_PATH 0x02
346 #define OPF_RETURN_REALPATH 0x04
348 extern int openp (const char *, int, const char *, int, char **);
350 extern int source_full_path_of (const char *, char **);
352 extern void mod_path (char *, char **);
354 extern void add_path (char *, char **, int);
356 extern void directory_switch (char *, int);
358 extern char *source_path;
360 extern void init_source_path (void);
364 /* * Process memory area starting at ADDR with length SIZE. Area is
365 readable iff READ is non-zero, writable if WRITE is non-zero,
366 executable if EXEC is non-zero. Area is possibly changed against
367 its original file based copy if MODIFIED is non-zero. DATA is
368 passed without changes from a caller. */
370 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
371 int read, int write, int exec,
372 int modified, void *data);
374 /* * Possible lvalue types. Like enum language, this should be in
375 value.h, but needs to be here for the same reason. */
383 /* * In a register. Registers are relative to a frame. */
385 /* * In a gdb internal variable. */
387 /* * Value encapsulates a callable defined in an extension language. */
389 /* * Part of a gdb internal variable (structure field). */
390 lval_internalvar_component,
391 /* * Value's bits are fetched and stored using functions provided
396 /* * Control types for commands. */
398 enum misc_command_type
406 enum command_control_type
417 while_stepping_control,
421 /* * Structure for saved commands lines (for breakpoints, defined
426 struct command_line *next;
428 enum command_control_type control_type;
433 enum compile_i_scope_types scope;
439 /* * The number of elements in body_list. */
441 /* * For composite commands, the nested lists of commands. For
442 example, for "if" command this will contain the then branch and
443 the else branch, if that is available. */
444 struct command_line **body_list;
447 extern struct command_line *read_command_lines (char *, int, int,
448 void (*)(char *, void *),
450 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
451 void (*)(char *, void *),
454 extern void free_command_lines (struct command_line **);
456 /* * Parameters of the "info proc" command. */
460 /* * Display the default cmdline, cwd and exe outputs. */
463 /* * Display `info proc mappings'. */
466 /* * Display `info proc status'. */
469 /* * Display `info proc stat'. */
472 /* * Display `info proc cmdline'. */
475 /* * Display `info proc exe'. */
478 /* * Display `info proc cwd'. */
481 /* * Display all of the above. */
485 /* * String containing the current directory (what getwd would return). */
487 extern char *current_directory;
489 /* * Default radixes for input and output. Only some values supported. */
490 extern unsigned input_radix;
491 extern unsigned output_radix;
493 /* * Possibilities for prettyformat parameters to routines which print
494 things. Like enum language, this should be in value.h, but needs
495 to be here for the same reason. FIXME: If we can eliminate this
496 as an arg to LA_VAL_PRINT, then we can probably move it back to
499 enum val_prettyformat
501 Val_no_prettyformat = 0,
503 /* * Use the default setting which the user has specified. */
504 Val_prettyformat_default
507 /* * Optional native machine support. Non-native (and possibly pure
508 multi-arch) targets do not need a "nm.h" file. This will be a
509 symlink to one of the nm-*.h files, built by the `configure'
516 /* Assume that fopen accepts the letter "b" in the mode string.
517 It is demanded by ISO C9X, and should be supported on all
518 platforms that claim to have a standard-conforming C library. On
519 true POSIX systems it will be ignored and have no effect. There
520 may still be systems without a standard-conforming C library where
521 an ISO C9X compiler (GCC) is available. Known examples are SunOS
522 4.x and 4.3BSD. This assumption means these systems are no longer
525 # include "fopen-bin.h"
528 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
529 FIXME: Assumes 2's complement arithmetic. */
531 #if !defined (UINT_MAX)
532 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
535 #if !defined (INT_MAX)
536 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
539 #if !defined (INT_MIN)
540 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
543 #if !defined (ULONG_MAX)
544 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
547 #if !defined (LONG_MAX)
548 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
551 #if !defined (ULONGEST_MAX)
552 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
555 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
556 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
559 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
560 arguments to a function, number in a value history, register number, etc.)
561 where the value must not be larger than can fit in an int. */
563 extern int longest_to_int (LONGEST);
565 /* * List of known OS ABIs. If you change this, make sure to update the
569 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
571 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
593 GDB_OSABI_INVALID /* keep this last */
596 /* Enumerate the requirements a symbol has in order to be evaluated.
597 These are listed in order of "strength" -- a later entry subsumes
598 earlier ones. This fine-grained distinction is important because
599 it allows for the evaluation of a TLS symbol during unwinding --
600 when unwinding one has access to registers, but not the frame
601 itself, because that is being constructed. */
603 enum symbol_needs_kind
605 /* No special requirements -- just memory. */
608 /* The symbol needs registers. */
609 SYMBOL_NEEDS_REGISTERS,
611 /* The symbol needs a frame. */
615 /* Dynamic target-system-dependent parameters for GDB. */
618 /* * Maximum size of a register. Something small, but large enough for
619 all known ISAs. If it turns out to be too small, make it bigger. */
621 enum { MAX_REGISTER_SIZE = 64 };
625 extern LONGEST extract_signed_integer (const gdb_byte *, int,
628 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
631 extern int extract_long_unsigned_integer (const gdb_byte *, int,
632 enum bfd_endian, LONGEST *);
634 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
637 extern void store_signed_integer (gdb_byte *, int,
638 enum bfd_endian, LONGEST);
640 extern void store_unsigned_integer (gdb_byte *, int,
641 enum bfd_endian, ULONGEST);
643 extern void store_typed_address (gdb_byte *buf, struct type *type,
651 /* From dwarf2read.c */
653 ULONGEST read_unsigned_leb128 (bfd *, const gdb_byte *, unsigned int *);
655 /* Hooks for alternate command interfaces. */
657 /* * The name of the interpreter if specified on the command line. */
658 extern char *interpreter_p;
660 struct target_waitstatus;
661 struct cmd_list_element;
663 extern void (*deprecated_pre_add_symbol_hook) (const char *);
664 extern void (*deprecated_post_add_symbol_hook) (void);
665 extern void (*selected_frame_level_changed_hook) (int);
666 extern int (*deprecated_ui_loop_hook) (int signo);
667 extern void (*deprecated_show_load_progress) (const char *section,
668 unsigned long section_sent,
669 unsigned long section_size,
670 unsigned long total_sent,
671 unsigned long total_size);
672 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
676 extern int (*deprecated_query_hook) (const char *, va_list)
677 ATTRIBUTE_FPTR_PRINTF(1,0);
678 extern void (*deprecated_warning_hook) (const char *, va_list)
679 ATTRIBUTE_FPTR_PRINTF(1,0);
680 extern void (*deprecated_interactive_hook) (void);
681 extern void (*deprecated_readline_begin_hook) (char *, ...)
682 ATTRIBUTE_FPTR_PRINTF_1;
683 extern char *(*deprecated_readline_hook) (const char *);
684 extern void (*deprecated_readline_end_hook) (void);
685 extern void (*deprecated_context_hook) (int);
686 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
687 struct target_waitstatus *status,
690 extern void (*deprecated_attach_hook) (void);
691 extern void (*deprecated_detach_hook) (void);
692 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
693 char *cmd, int from_tty);
695 extern int (*deprecated_ui_load_progress_hook) (const char *section,
698 /* If this definition isn't overridden by the header files, assume
699 that isatty and fileno exist on this system. */
701 #define ISATTY(FP) (isatty (fileno (FP)))
704 /* * A width that can achieve a better legibility for GDB MI mode. */
705 #define GDB_MI_MSG_WIDTH 80
707 /* From progspace.c */
709 extern void initialize_progspace (void);
710 extern void initialize_inferiors (void);
712 /* * Special block numbers */
718 FIRST_LOCAL_BLOCK = 2
721 /* User selection used in observer.h and multiple print functions. */
723 enum user_selected_what_flag
725 /* Inferior selected. */
726 USER_SELECTED_INFERIOR = 1 << 1,
728 /* Thread selected. */
729 USER_SELECTED_THREAD = 1 << 2,
731 /* Frame selected. */
732 USER_SELECTED_FRAME = 1 << 3
734 DEF_ENUM_FLAGS_TYPE (enum user_selected_what_flag, user_selected_what);
738 #endif /* #ifndef DEFS_H */