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's SIGINT handler basically sets a flag; code that might take a
129 long time before it gets back to the event loop, and which ought to
130 be interruptible, checks this flag using the QUIT macro, which, if
131 GDB has the terminal, throws a quit exception.
133 In addition to setting a flag, the SIGINT handler also marks a
134 select/poll-able file descriptor as read-ready. That is used by
135 interruptible_select in order to support interrupting blocking I/O
136 in a race-free manner.
138 These functions use the extension_language_ops API to allow extension
139 language(s) and GDB SIGINT handling to coexist seamlessly. */
141 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
142 will clear the quit flag as a side effect. */
143 extern int check_quit_flag (void);
144 /* * Set the quit flag. */
145 extern void set_quit_flag (void);
147 /* The current quit handler (and its type). This is called from the
148 QUIT macro. See default_quit_handler below for default behavior.
149 Parts of GDB temporarily override this to e.g., completely suppress
150 Ctrl-C because it would not be safe to throw. E.g., normally, you
151 wouldn't want to quit between a RSP command and its response, as
152 that would break the communication with the target, but you may
153 still want to intercept the Ctrl-C and offer to disconnect if the
154 user presses Ctrl-C multiple times while the target is stuck
155 waiting for the wedged remote stub. */
156 typedef void (quit_handler_ftype
) (void);
157 extern quit_handler_ftype
*quit_handler
;
159 /* Override the current quit handler. Sets NEW_QUIT_HANDLER as
160 current quit handler, and installs a cleanup that when run restores
161 the previous quit handler. */
163 make_cleanup_override_quit_handler (quit_handler_ftype
*new_quit_handler
);
165 /* The default quit handler. Checks whether Ctrl-C was pressed, and
168 - If GDB owns the terminal, throws a quit exception.
170 - If GDB does not own the terminal, forwards the Ctrl-C to the
173 extern void default_quit_handler (void);
175 /* Flag that function quit should call quit_force. */
176 extern volatile int sync_quit_force_run
;
178 extern void quit (void);
180 /* Helper for the QUIT macro. */
182 extern void maybe_quit (void);
184 /* Check whether a Ctrl-C was typed, and if so, call the current quit
186 #define QUIT maybe_quit ()
188 /* Set the serial event associated with the quit flag. */
189 extern void quit_serial_event_set (void);
191 /* Clear the serial event associated with the quit flag. */
192 extern void quit_serial_event_clear (void);
194 /* * Languages represented in the symbol table and elsewhere.
195 This should probably be in language.h, but since enum's can't
196 be forward declared to satisfy opaque references before their
197 actual definition, needs to be here. */
201 language_unknown
, /* Language not known */
202 language_auto
, /* Placeholder for automatic setting */
204 language_cplus
, /* C++ */
206 language_go
, /* Go */
207 language_objc
, /* Objective-C */
208 language_java
, /* Java */
209 language_fortran
, /* Fortran */
210 language_m2
, /* Modula-2 */
211 language_asm
, /* Assembly language */
212 language_pascal
, /* Pascal */
213 language_ada
, /* Ada */
214 language_opencl
, /* OpenCL */
215 language_minimal
, /* All other languages, minimal support only */
219 /* The number of bits needed to represent all languages, with enough
220 padding to allow for reasonable growth. */
221 #define LANGUAGE_BITS 5
222 gdb_static_assert (nr_languages
<= (1 << LANGUAGE_BITS
));
228 unspecified_precision
231 /* * A generic, not quite boolean, enumeration. This is used for
232 set/show commands in which the options are on/off/automatic. */
240 /* * Potential ways that a function can return a value of a given
243 enum return_value_convention
245 /* * Where the return value has been squeezed into one or more
247 RETURN_VALUE_REGISTER_CONVENTION
,
248 /* * Commonly known as the "struct return convention". The caller
249 passes an additional hidden first parameter to the caller. That
250 parameter contains the address at which the value being returned
251 should be stored. While typically, and historically, used for
252 large structs, this is convention is applied to values of many
254 RETURN_VALUE_STRUCT_CONVENTION
,
255 /* * Like the "struct return convention" above, but where the ABI
256 guarantees that the called function stores the address at which
257 the value being returned is stored in a well-defined location,
258 such as a register or memory slot in the stack frame. Don't use
259 this if the ABI doesn't explicitly guarantees this. */
260 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
261 /* * Like the "struct return convention" above, but where the ABI
262 guarantees that the address at which the value being returned is
263 stored will be available in a well-defined location, such as a
264 register or memory slot in the stack frame. Don't use this if
265 the ABI doesn't explicitly guarantees this. */
266 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
269 /* Needed for various prototypes */
279 /* This really belong in utils.c (path-utils.c?), but it references some
280 globals that are currently only available to main.c. */
281 extern char *relocate_gdb_directory (const char *initial
, int flag
);
284 /* Annotation stuff. */
286 extern int annotation_level
; /* in stack.c */
289 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
290 "const char *" in unistd.h, so we can't declare the argument
293 EXTERN_C
char *re_comp (const char *);
297 extern void symbol_file_command (char *, int);
299 /* * Remote targets may wish to use this as their load function. */
300 extern void generic_load (const char *name
, int from_tty
);
302 /* * Report on STREAM the performance of memory transfer operation,
304 @param DATA_COUNT is the number of bytes transferred.
305 @param WRITE_COUNT is the number of separate write operations, or 0,
306 if that information is not available.
307 @param START_TIME is the time at which an operation was started.
308 @param END_TIME is the time at which an operation ended. */
310 extern void print_transfer_performance (struct ui_file
*stream
,
311 unsigned long data_count
,
312 unsigned long write_count
,
313 const struct timeval
*start_time
,
314 const struct timeval
*end_time
);
318 typedef void initialize_file_ftype (void);
320 extern char *gdb_readline_wrapper (const char *);
322 extern char *command_line_input (const char *, int, char *);
324 extern void print_prompt (void);
326 extern int input_from_terminal_p (void);
328 extern int info_verbose
;
330 /* From printcmd.c */
332 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
334 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
335 struct ui_file
*, int, char *);
337 extern int build_address_symbolic (struct gdbarch
*,
346 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
347 extern const char *pc_prefix (CORE_ADDR
);
351 /* See openp function definition for their description. */
352 #define OPF_TRY_CWD_FIRST 0x01
353 #define OPF_SEARCH_IN_PATH 0x02
354 #define OPF_RETURN_REALPATH 0x04
356 extern int openp (const char *, int, const char *, int, char **);
358 extern int source_full_path_of (const char *, char **);
360 extern void mod_path (char *, char **);
362 extern void add_path (char *, char **, int);
364 extern void directory_switch (char *, int);
366 extern char *source_path
;
368 extern void init_source_path (void);
372 /* * Process memory area starting at ADDR with length SIZE. Area is
373 readable iff READ is non-zero, writable if WRITE is non-zero,
374 executable if EXEC is non-zero. Area is possibly changed against
375 its original file based copy if MODIFIED is non-zero. DATA is
376 passed without changes from a caller. */
378 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
379 int read
, int write
, int exec
,
380 int modified
, void *data
);
382 /* * Possible lvalue types. Like enum language, this should be in
383 value.h, but needs to be here for the same reason. */
391 /* * In a register. Registers are relative to a frame. */
393 /* * In a gdb internal variable. */
395 /* * Value encapsulates a callable defined in an extension language. */
397 /* * Part of a gdb internal variable (structure field). */
398 lval_internalvar_component
,
399 /* * Value's bits are fetched and stored using functions provided
404 /* * Control types for commands. */
406 enum misc_command_type
414 enum command_control_type
425 while_stepping_control
,
429 /* * Structure for saved commands lines (for breakpoints, defined
434 struct command_line
*next
;
436 enum command_control_type control_type
;
441 enum compile_i_scope_types scope
;
447 /* * The number of elements in body_list. */
449 /* * For composite commands, the nested lists of commands. For
450 example, for "if" command this will contain the then branch and
451 the else branch, if that is available. */
452 struct command_line
**body_list
;
455 extern struct command_line
*read_command_lines (char *, int, int,
456 void (*)(char *, void *),
458 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
459 void (*)(char *, void *),
462 extern void free_command_lines (struct command_line
**);
464 /* * Parameters of the "info proc" command. */
468 /* * Display the default cmdline, cwd and exe outputs. */
471 /* * Display `info proc mappings'. */
474 /* * Display `info proc status'. */
477 /* * Display `info proc stat'. */
480 /* * Display `info proc cmdline'. */
483 /* * Display `info proc exe'. */
486 /* * Display `info proc cwd'. */
489 /* * Display all of the above. */
493 /* * String containing the current directory (what getwd would return). */
495 extern char *current_directory
;
497 /* * Default radixes for input and output. Only some values supported. */
498 extern unsigned input_radix
;
499 extern unsigned output_radix
;
501 /* * Possibilities for prettyformat parameters to routines which print
502 things. Like enum language, this should be in value.h, but needs
503 to be here for the same reason. FIXME: If we can eliminate this
504 as an arg to LA_VAL_PRINT, then we can probably move it back to
507 enum val_prettyformat
509 Val_no_prettyformat
= 0,
511 /* * Use the default setting which the user has specified. */
512 Val_prettyformat_default
515 /* * Optional native machine support. Non-native (and possibly pure
516 multi-arch) targets do not need a "nm.h" file. This will be a
517 symlink to one of the nm-*.h files, built by the `configure'
524 /* Assume that fopen accepts the letter "b" in the mode string.
525 It is demanded by ISO C9X, and should be supported on all
526 platforms that claim to have a standard-conforming C library. On
527 true POSIX systems it will be ignored and have no effect. There
528 may still be systems without a standard-conforming C library where
529 an ISO C9X compiler (GCC) is available. Known examples are SunOS
530 4.x and 4.3BSD. This assumption means these systems are no longer
533 # include "fopen-bin.h"
536 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
537 FIXME: Assumes 2's complement arithmetic. */
539 #if !defined (UINT_MAX)
540 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
543 #if !defined (INT_MAX)
544 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
547 #if !defined (INT_MIN)
548 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
551 #if !defined (ULONG_MAX)
552 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
555 #if !defined (LONG_MAX)
556 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
559 #if !defined (ULONGEST_MAX)
560 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
563 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
564 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
567 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
568 arguments to a function, number in a value history, register number, etc.)
569 where the value must not be larger than can fit in an int. */
571 extern int longest_to_int (LONGEST
);
573 /* * List of known OS ABIs. If you change this, make sure to update the
577 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
579 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
585 GDB_OSABI_FREEBSD_AOUT
,
586 GDB_OSABI_FREEBSD_ELF
,
587 GDB_OSABI_NETBSD_AOUT
,
588 GDB_OSABI_NETBSD_ELF
,
589 GDB_OSABI_OPENBSD_ELF
,
606 GDB_OSABI_INVALID
/* keep this last */
609 /* Global functions from other, non-gdb GNU thingies.
610 Libiberty thingies are no longer declared here. We include libiberty.h
613 /* From other system libraries */
616 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
619 /* Dynamic target-system-dependent parameters for GDB. */
622 /* * Maximum size of a register. Something small, but large enough for
623 all known ISAs. If it turns out to be too small, make it bigger. */
625 enum { MAX_REGISTER_SIZE
= 64 };
629 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
632 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
635 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
636 enum bfd_endian
, LONGEST
*);
638 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
641 extern void store_signed_integer (gdb_byte
*, int,
642 enum bfd_endian
, LONGEST
);
644 extern void store_unsigned_integer (gdb_byte
*, int,
645 enum bfd_endian
, ULONGEST
);
647 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
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
723 #endif /* #ifndef DEFS_H */