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"
57 /* Scope types enumerator. List the types of scopes the compiler will
60 enum compile_i_scope_types
62 COMPILE_I_INVALID_SCOPE
,
64 /* A simple scope. Wrap an expression into a simple scope that
65 takes no arguments, returns no value, and uses the generic
66 function name "_gdb_expr". */
68 COMPILE_I_SIMPLE_SCOPE
,
70 /* Do not wrap the expression,
71 it has to provide function "_gdb_expr" on its own. */
74 /* A printable expression scope. Wrap an expression into a scope
75 suitable for the "compile print" command. It uses the generic
76 function name "_gdb_expr". COMPILE_I_PRINT_ADDRESS_SCOPE variant
77 is the usual one, taking address of the object.
78 COMPILE_I_PRINT_VALUE_SCOPE is needed for arrays where the array
79 name already specifies its address. See get_out_value_type. */
80 COMPILE_I_PRINT_ADDRESS_SCOPE
,
81 COMPILE_I_PRINT_VALUE_SCOPE
,
84 /* Just in case they're not defined in stdio.h. */
93 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
94 It is used as an access modifier in calls to open(), where it acts
95 similarly to the "b" character in fopen()'s MODE argument. On Posix
96 platforms it should be a no-op, so it is defined as 0 here. This
97 ensures that the symbol may be used freely elsewhere in gdb. */
106 #define min(a, b) ((a) < (b) ? (a) : (b))
109 #define max(a, b) ((a) > (b) ? (a) : (b))
112 /* * Enable dbx commands if set. */
113 extern int dbx_commands
;
115 /* * System root path, used to find libraries etc. */
116 extern char *gdb_sysroot
;
118 /* * GDB datadir, used to store data files. */
119 extern char *gdb_datadir
;
121 /* * If non-NULL, the possibly relocated path to python's "lib" directory
122 specified with --with-python. */
123 extern char *python_libdir
;
125 /* * Search path for separate debug files. */
126 extern char *debug_file_directory
;
128 /* GDB has two methods for handling SIGINT. When immediate_quit is
129 nonzero, a SIGINT results in an immediate longjmp out of the signal
130 handler. Otherwise, SIGINT simply sets a flag; code that might
131 take a long time, and which ought to be interruptible, checks this
132 flag using the QUIT macro.
134 In addition to setting a flag, the SIGINT handler also marks a
135 select/poll-able file descriptor as read-ready. That is used by
136 interruptible_select in order to support interrupting blocking I/O
137 in a race-free manner.
139 These functions use the extension_language_ops API to allow extension
140 language(s) and GDB SIGINT handling to coexist seamlessly. */
142 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
143 will clear the quit flag as a side effect. */
144 extern int check_quit_flag (void);
145 /* * Set the quit flag. */
146 extern void set_quit_flag (void);
148 /* The current quit handler (and its type). This is called from the
149 QUIT macro. See default_quit_handler below for default behavior.
150 Parts of GDB temporarily override this to e.g., completely suppress
151 Ctrl-C because it would not be safe to throw. E.g., normally, you
152 wouldn't want to quit between a RSP command and its response, as
153 that would break the communication with the target, but you may
154 still want to intercept the Ctrl-C and offer to disconnect if the
155 user presses Ctrl-C multiple times while the target is stuck
156 waiting for the wedged remote stub. */
157 typedef void (quit_handler_ftype
) (void);
158 extern quit_handler_ftype
*quit_handler
;
160 /* Override the current quit handler. Sets NEW_QUIT_HANDLER as
161 current quit handler, and installs a cleanup that when run restores
162 the previous quit handler. */
164 make_cleanup_override_quit_handler (quit_handler_ftype
*new_quit_handler
);
166 /* The default quit handler. Checks whether Ctrl-C was pressed, and
169 - If GDB owns the terminal, throws a quit exception.
171 - If GDB does not own the terminal, forwards the Ctrl-C to the
174 extern void default_quit_handler (void);
176 /* Flag that function quit should call quit_force. */
177 extern volatile int sync_quit_force_run
;
179 extern int immediate_quit
;
181 extern void quit (void);
183 /* Helper for the QUIT macro. */
185 extern void maybe_quit (void);
187 /* Check whether a Ctrl-C was typed, and if so, call the current quit
189 #define QUIT maybe_quit ()
191 /* Set the serial event associated with the quit flag. */
192 extern void quit_serial_event_set (void);
194 /* Clear the serial event associated with the quit flag. */
195 extern void quit_serial_event_clear (void);
197 /* * Languages represented in the symbol table and elsewhere.
198 This should probably be in language.h, but since enum's can't
199 be forward declared to satisfy opaque references before their
200 actual definition, needs to be here. */
204 language_unknown
, /* Language not known */
205 language_auto
, /* Placeholder for automatic setting */
207 language_cplus
, /* C++ */
209 language_go
, /* Go */
210 language_objc
, /* Objective-C */
211 language_java
, /* Java */
212 language_fortran
, /* Fortran */
213 language_m2
, /* Modula-2 */
214 language_asm
, /* Assembly language */
215 language_pascal
, /* Pascal */
216 language_ada
, /* Ada */
217 language_opencl
, /* OpenCL */
218 language_minimal
, /* All other languages, minimal support only */
222 /* The number of bits needed to represent all languages, with enough
223 padding to allow for reasonable growth. */
224 #define LANGUAGE_BITS 5
225 gdb_static_assert (nr_languages
<= (1 << LANGUAGE_BITS
));
231 unspecified_precision
234 /* * A generic, not quite boolean, enumeration. This is used for
235 set/show commands in which the options are on/off/automatic. */
243 /* * Potential ways that a function can return a value of a given
246 enum return_value_convention
248 /* * Where the return value has been squeezed into one or more
250 RETURN_VALUE_REGISTER_CONVENTION
,
251 /* * Commonly known as the "struct return convention". The caller
252 passes an additional hidden first parameter to the caller. That
253 parameter contains the address at which the value being returned
254 should be stored. While typically, and historically, used for
255 large structs, this is convention is applied to values of many
257 RETURN_VALUE_STRUCT_CONVENTION
,
258 /* * Like the "struct return convention" above, but where the ABI
259 guarantees that the called function stores the address at which
260 the value being returned is stored in a well-defined location,
261 such as a register or memory slot in the stack frame. Don't use
262 this if the ABI doesn't explicitly guarantees this. */
263 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
264 /* * Like the "struct return convention" above, but where the ABI
265 guarantees that the address at which the value being returned is
266 stored will be available in a well-defined location, such as a
267 register or memory slot in the stack frame. Don't use this if
268 the ABI doesn't explicitly guarantees this. */
269 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
272 /* Needed for various prototypes */
282 /* This really belong in utils.c (path-utils.c?), but it references some
283 globals that are currently only available to main.c. */
284 extern char *relocate_gdb_directory (const char *initial
, int flag
);
287 /* Annotation stuff. */
289 extern int annotation_level
; /* in stack.c */
292 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
293 "const char *" in unistd.h, so we can't declare the argument
296 EXTERN_C
char *re_comp (const char *);
300 extern void symbol_file_command (char *, int);
302 /* * Remote targets may wish to use this as their load function. */
303 extern void generic_load (const char *name
, int from_tty
);
305 /* * Report on STREAM the performance of memory transfer operation,
307 @param DATA_COUNT is the number of bytes transferred.
308 @param WRITE_COUNT is the number of separate write operations, or 0,
309 if that information is not available.
310 @param START_TIME is the time at which an operation was started.
311 @param END_TIME is the time at which an operation ended. */
313 extern void print_transfer_performance (struct ui_file
*stream
,
314 unsigned long data_count
,
315 unsigned long write_count
,
316 const struct timeval
*start_time
,
317 const struct timeval
*end_time
);
321 typedef void initialize_file_ftype (void);
323 extern char *gdb_readline_wrapper (const char *);
325 extern char *command_line_input (const char *, int, char *);
327 extern void print_prompt (void);
329 extern int input_from_terminal_p (void);
331 extern int info_verbose
;
333 /* From printcmd.c */
335 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
337 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
338 struct ui_file
*, int, char *);
340 extern int build_address_symbolic (struct gdbarch
*,
349 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
350 extern const char *pc_prefix (CORE_ADDR
);
354 /* See openp function definition for their description. */
355 #define OPF_TRY_CWD_FIRST 0x01
356 #define OPF_SEARCH_IN_PATH 0x02
357 #define OPF_RETURN_REALPATH 0x04
359 extern int openp (const char *, int, const char *, int, char **);
361 extern int source_full_path_of (const char *, char **);
363 extern void mod_path (char *, char **);
365 extern void add_path (char *, char **, int);
367 extern void directory_switch (char *, int);
369 extern char *source_path
;
371 extern void init_source_path (void);
375 /* * Process memory area starting at ADDR with length SIZE. Area is
376 readable iff READ is non-zero, writable if WRITE is non-zero,
377 executable if EXEC is non-zero. Area is possibly changed against
378 its original file based copy if MODIFIED is non-zero. DATA is
379 passed without changes from a caller. */
381 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
382 int read
, int write
, int exec
,
383 int modified
, void *data
);
385 /* * Possible lvalue types. Like enum language, this should be in
386 value.h, but needs to be here for the same reason. */
394 /* * In a register. Registers are relative to a frame. */
396 /* * In a gdb internal variable. */
398 /* * Value encapsulates a callable defined in an extension language. */
400 /* * Part of a gdb internal variable (structure field). */
401 lval_internalvar_component
,
402 /* * Value's bits are fetched and stored using functions provided
407 /* * Control types for commands. */
409 enum misc_command_type
417 enum command_control_type
428 while_stepping_control
,
432 /* * Structure for saved commands lines (for breakpoints, defined
437 struct command_line
*next
;
439 enum command_control_type control_type
;
444 enum compile_i_scope_types scope
;
450 /* * The number of elements in body_list. */
452 /* * For composite commands, the nested lists of commands. For
453 example, for "if" command this will contain the then branch and
454 the else branch, if that is available. */
455 struct command_line
**body_list
;
458 extern struct command_line
*read_command_lines (char *, int, int,
459 void (*)(char *, void *),
461 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
462 void (*)(char *, void *),
465 extern void free_command_lines (struct command_line
**);
467 /* * Parameters of the "info proc" command. */
471 /* * Display the default cmdline, cwd and exe outputs. */
474 /* * Display `info proc mappings'. */
477 /* * Display `info proc status'. */
480 /* * Display `info proc stat'. */
483 /* * Display `info proc cmdline'. */
486 /* * Display `info proc exe'. */
489 /* * Display `info proc cwd'. */
492 /* * Display all of the above. */
496 /* * String containing the current directory (what getwd would return). */
498 extern char *current_directory
;
500 /* * Default radixes for input and output. Only some values supported. */
501 extern unsigned input_radix
;
502 extern unsigned output_radix
;
504 /* * Possibilities for prettyformat parameters to routines which print
505 things. Like enum language, this should be in value.h, but needs
506 to be here for the same reason. FIXME: If we can eliminate this
507 as an arg to LA_VAL_PRINT, then we can probably move it back to
510 enum val_prettyformat
512 Val_no_prettyformat
= 0,
514 /* * Use the default setting which the user has specified. */
515 Val_prettyformat_default
518 /* * Optional native machine support. Non-native (and possibly pure
519 multi-arch) targets do not need a "nm.h" file. This will be a
520 symlink to one of the nm-*.h files, built by the `configure'
527 /* Assume that fopen accepts the letter "b" in the mode string.
528 It is demanded by ISO C9X, and should be supported on all
529 platforms that claim to have a standard-conforming C library. On
530 true POSIX systems it will be ignored and have no effect. There
531 may still be systems without a standard-conforming C library where
532 an ISO C9X compiler (GCC) is available. Known examples are SunOS
533 4.x and 4.3BSD. This assumption means these systems are no longer
536 # include "fopen-bin.h"
539 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
540 FIXME: Assumes 2's complement arithmetic. */
542 #if !defined (UINT_MAX)
543 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
546 #if !defined (INT_MAX)
547 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
550 #if !defined (INT_MIN)
551 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
554 #if !defined (ULONG_MAX)
555 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
558 #if !defined (LONG_MAX)
559 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
562 #if !defined (ULONGEST_MAX)
563 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
566 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
567 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
570 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
571 arguments to a function, number in a value history, register number, etc.)
572 where the value must not be larger than can fit in an int. */
574 extern int longest_to_int (LONGEST
);
576 /* * List of known OS ABIs. If you change this, make sure to update the
580 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
582 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
588 GDB_OSABI_FREEBSD_AOUT
,
589 GDB_OSABI_FREEBSD_ELF
,
590 GDB_OSABI_NETBSD_AOUT
,
591 GDB_OSABI_NETBSD_ELF
,
592 GDB_OSABI_OPENBSD_ELF
,
609 GDB_OSABI_INVALID
/* keep this last */
612 /* Global functions from other, non-gdb GNU thingies.
613 Libiberty thingies are no longer declared here. We include libiberty.h
616 /* From other system libraries */
619 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
622 /* Dynamic target-system-dependent parameters for GDB. */
625 /* * Maximum size of a register. Something small, but large enough for
626 all known ISAs. If it turns out to be too small, make it bigger. */
628 enum { MAX_REGISTER_SIZE
= 64 };
632 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
635 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
638 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
639 enum bfd_endian
, LONGEST
*);
641 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
644 extern void store_signed_integer (gdb_byte
*, int,
645 enum bfd_endian
, LONGEST
);
647 extern void store_unsigned_integer (gdb_byte
*, int,
648 enum bfd_endian
, ULONGEST
);
650 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
658 /* Hooks for alternate command interfaces. */
660 /* * The name of the interpreter if specified on the command line. */
661 extern char *interpreter_p
;
663 struct target_waitstatus
;
664 struct cmd_list_element
;
666 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
667 extern void (*deprecated_post_add_symbol_hook
) (void);
668 extern void (*selected_frame_level_changed_hook
) (int);
669 extern int (*deprecated_ui_loop_hook
) (int signo
);
670 extern void (*deprecated_show_load_progress
) (const char *section
,
671 unsigned long section_sent
,
672 unsigned long section_size
,
673 unsigned long total_sent
,
674 unsigned long total_size
);
675 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
679 extern int (*deprecated_query_hook
) (const char *, va_list)
680 ATTRIBUTE_FPTR_PRINTF(1,0);
681 extern void (*deprecated_warning_hook
) (const char *, va_list)
682 ATTRIBUTE_FPTR_PRINTF(1,0);
683 extern void (*deprecated_interactive_hook
) (void);
684 extern void (*deprecated_readline_begin_hook
) (char *, ...)
685 ATTRIBUTE_FPTR_PRINTF_1
;
686 extern char *(*deprecated_readline_hook
) (const char *);
687 extern void (*deprecated_readline_end_hook
) (void);
688 extern void (*deprecated_context_hook
) (int);
689 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
690 struct target_waitstatus
*status
,
693 extern void (*deprecated_attach_hook
) (void);
694 extern void (*deprecated_detach_hook
) (void);
695 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
696 char *cmd
, int from_tty
);
698 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
701 /* If this definition isn't overridden by the header files, assume
702 that isatty and fileno exist on this system. */
704 #define ISATTY(FP) (isatty (fileno (FP)))
707 /* * A width that can achieve a better legibility for GDB MI mode. */
708 #define GDB_MI_MSG_WIDTH 80
710 /* From progspace.c */
712 extern void initialize_progspace (void);
713 extern void initialize_inferiors (void);
715 /* * Special block numbers */
721 FIRST_LOCAL_BLOCK
= 2
726 #endif /* #ifndef DEFS_H */