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_rust, /* Rust */
216 language_minimal, /* All other languages, minimal support only */
220 /* The number of bits needed to represent all languages, with enough
221 padding to allow for reasonable growth. */
222 #define LANGUAGE_BITS 5
223 gdb_static_assert (nr_languages <= (1 << LANGUAGE_BITS));
229 unspecified_precision
232 /* * A generic, not quite boolean, enumeration. This is used for
233 set/show commands in which the options are on/off/automatic. */
241 /* * Potential ways that a function can return a value of a given
244 enum return_value_convention
246 /* * Where the return value has been squeezed into one or more
248 RETURN_VALUE_REGISTER_CONVENTION,
249 /* * Commonly known as the "struct return convention". The caller
250 passes an additional hidden first parameter to the caller. That
251 parameter contains the address at which the value being returned
252 should be stored. While typically, and historically, used for
253 large structs, this is convention is applied to values of many
255 RETURN_VALUE_STRUCT_CONVENTION,
256 /* * Like the "struct return convention" above, but where the ABI
257 guarantees that the called function stores the address at which
258 the value being returned is stored in a well-defined location,
259 such as a register or memory slot in the stack frame. Don't use
260 this if the ABI doesn't explicitly guarantees this. */
261 RETURN_VALUE_ABI_RETURNS_ADDRESS,
262 /* * Like the "struct return convention" above, but where the ABI
263 guarantees that the address at which the value being returned is
264 stored will be available in a well-defined location, such as a
265 register or memory slot in the stack frame. Don't use this if
266 the ABI doesn't explicitly guarantees this. */
267 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
270 /* Needed for various prototypes */
280 /* This really belong in utils.c (path-utils.c?), but it references some
281 globals that are currently only available to main.c. */
282 extern char *relocate_gdb_directory (const char *initial, int flag);
285 /* Annotation stuff. */
287 extern int annotation_level; /* in stack.c */
290 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
291 "const char *" in unistd.h, so we can't declare the argument
294 EXTERN_C char *re_comp (const char *);
298 extern void symbol_file_command (char *, int);
300 /* * Remote targets may wish to use this as their load function. */
301 extern void generic_load (const char *name, int from_tty);
303 /* * Report on STREAM the performance of memory transfer operation,
305 @param DATA_COUNT is the number of bytes transferred.
306 @param WRITE_COUNT is the number of separate write operations, or 0,
307 if that information is not available.
308 @param START_TIME is the time at which an operation was started.
309 @param END_TIME is the time at which an operation ended. */
311 extern void print_transfer_performance (struct ui_file *stream,
312 unsigned long data_count,
313 unsigned long write_count,
314 const struct timeval *start_time,
315 const struct timeval *end_time);
319 typedef void initialize_file_ftype (void);
321 extern char *gdb_readline_wrapper (const char *);
323 extern char *command_line_input (const char *, int, char *);
325 extern void print_prompt (void);
327 extern int input_from_terminal_p (void);
329 extern int info_verbose;
331 /* From printcmd.c */
333 extern void set_next_address (struct gdbarch *, CORE_ADDR);
335 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
336 struct ui_file *, int, char *);
338 extern int build_address_symbolic (struct gdbarch *,
347 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
348 extern const char *pc_prefix (CORE_ADDR);
352 /* See openp function definition for their description. */
353 #define OPF_TRY_CWD_FIRST 0x01
354 #define OPF_SEARCH_IN_PATH 0x02
355 #define OPF_RETURN_REALPATH 0x04
357 extern int openp (const char *, int, const char *, int, char **);
359 extern int source_full_path_of (const char *, char **);
361 extern void mod_path (char *, char **);
363 extern void add_path (char *, char **, int);
365 extern void directory_switch (char *, int);
367 extern char *source_path;
369 extern void init_source_path (void);
373 /* * Process memory area starting at ADDR with length SIZE. Area is
374 readable iff READ is non-zero, writable if WRITE is non-zero,
375 executable if EXEC is non-zero. Area is possibly changed against
376 its original file based copy if MODIFIED is non-zero. DATA is
377 passed without changes from a caller. */
379 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
380 int read, int write, int exec,
381 int modified, void *data);
383 /* * Possible lvalue types. Like enum language, this should be in
384 value.h, but needs to be here for the same reason. */
392 /* * In a register. Registers are relative to a frame. */
394 /* * In a gdb internal variable. */
396 /* * Value encapsulates a callable defined in an extension language. */
398 /* * Part of a gdb internal variable (structure field). */
399 lval_internalvar_component,
400 /* * Value's bits are fetched and stored using functions provided
405 /* * Control types for commands. */
407 enum misc_command_type
415 enum command_control_type
426 while_stepping_control,
430 /* * Structure for saved commands lines (for breakpoints, defined
435 struct command_line *next;
437 enum command_control_type control_type;
442 enum compile_i_scope_types scope;
448 /* * The number of elements in body_list. */
450 /* * For composite commands, the nested lists of commands. For
451 example, for "if" command this will contain the then branch and
452 the else branch, if that is available. */
453 struct command_line **body_list;
456 extern struct command_line *read_command_lines (char *, int, int,
457 void (*)(char *, void *),
459 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
460 void (*)(char *, void *),
463 extern void free_command_lines (struct command_line **);
465 /* * Parameters of the "info proc" command. */
469 /* * Display the default cmdline, cwd and exe outputs. */
472 /* * Display `info proc mappings'. */
475 /* * Display `info proc status'. */
478 /* * Display `info proc stat'. */
481 /* * Display `info proc cmdline'. */
484 /* * Display `info proc exe'. */
487 /* * Display `info proc cwd'. */
490 /* * Display all of the above. */
494 /* * String containing the current directory (what getwd would return). */
496 extern char *current_directory;
498 /* * Default radixes for input and output. Only some values supported. */
499 extern unsigned input_radix;
500 extern unsigned output_radix;
502 /* * Possibilities for prettyformat parameters to routines which print
503 things. Like enum language, this should be in value.h, but needs
504 to be here for the same reason. FIXME: If we can eliminate this
505 as an arg to LA_VAL_PRINT, then we can probably move it back to
508 enum val_prettyformat
510 Val_no_prettyformat = 0,
512 /* * Use the default setting which the user has specified. */
513 Val_prettyformat_default
516 /* * Optional native machine support. Non-native (and possibly pure
517 multi-arch) targets do not need a "nm.h" file. This will be a
518 symlink to one of the nm-*.h files, built by the `configure'
525 /* Assume that fopen accepts the letter "b" in the mode string.
526 It is demanded by ISO C9X, and should be supported on all
527 platforms that claim to have a standard-conforming C library. On
528 true POSIX systems it will be ignored and have no effect. There
529 may still be systems without a standard-conforming C library where
530 an ISO C9X compiler (GCC) is available. Known examples are SunOS
531 4.x and 4.3BSD. This assumption means these systems are no longer
534 # include "fopen-bin.h"
537 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
538 FIXME: Assumes 2's complement arithmetic. */
540 #if !defined (UINT_MAX)
541 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
544 #if !defined (INT_MAX)
545 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
548 #if !defined (INT_MIN)
549 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
552 #if !defined (ULONG_MAX)
553 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
556 #if !defined (LONG_MAX)
557 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
560 #if !defined (ULONGEST_MAX)
561 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
564 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
565 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
568 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
569 arguments to a function, number in a value history, register number, etc.)
570 where the value must not be larger than can fit in an int. */
572 extern int longest_to_int (LONGEST);
574 /* * List of known OS ABIs. If you change this, make sure to update the
578 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
580 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
586 GDB_OSABI_FREEBSD_AOUT,
587 GDB_OSABI_FREEBSD_ELF,
588 GDB_OSABI_NETBSD_AOUT,
589 GDB_OSABI_NETBSD_ELF,
590 GDB_OSABI_OPENBSD_ELF,
607 GDB_OSABI_INVALID /* keep this last */
610 /* Global functions from other, non-gdb GNU thingies.
611 Libiberty thingies are no longer declared here. We include libiberty.h
614 /* From other system libraries */
617 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
620 /* Dynamic target-system-dependent parameters for GDB. */
623 /* * Maximum size of a register. Something small, but large enough for
624 all known ISAs. If it turns out to be too small, make it bigger. */
626 enum { MAX_REGISTER_SIZE = 64 };
630 extern LONGEST extract_signed_integer (const gdb_byte *, int,
633 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
636 extern int extract_long_unsigned_integer (const gdb_byte *, int,
637 enum bfd_endian, LONGEST *);
639 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
642 extern void store_signed_integer (gdb_byte *, int,
643 enum bfd_endian, LONGEST);
645 extern void store_unsigned_integer (gdb_byte *, int,
646 enum bfd_endian, ULONGEST);
648 extern void store_typed_address (gdb_byte *buf, struct type *type,
656 /* Hooks for alternate command interfaces. */
658 /* * The name of the interpreter if specified on the command line. */
659 extern char *interpreter_p;
661 struct target_waitstatus;
662 struct cmd_list_element;
664 extern void (*deprecated_pre_add_symbol_hook) (const char *);
665 extern void (*deprecated_post_add_symbol_hook) (void);
666 extern void (*selected_frame_level_changed_hook) (int);
667 extern int (*deprecated_ui_loop_hook) (int signo);
668 extern void (*deprecated_show_load_progress) (const char *section,
669 unsigned long section_sent,
670 unsigned long section_size,
671 unsigned long total_sent,
672 unsigned long total_size);
673 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
677 extern int (*deprecated_query_hook) (const char *, va_list)
678 ATTRIBUTE_FPTR_PRINTF(1,0);
679 extern void (*deprecated_warning_hook) (const char *, va_list)
680 ATTRIBUTE_FPTR_PRINTF(1,0);
681 extern void (*deprecated_interactive_hook) (void);
682 extern void (*deprecated_readline_begin_hook) (char *, ...)
683 ATTRIBUTE_FPTR_PRINTF_1;
684 extern char *(*deprecated_readline_hook) (const char *);
685 extern void (*deprecated_readline_end_hook) (void);
686 extern void (*deprecated_context_hook) (int);
687 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
688 struct target_waitstatus *status,
691 extern void (*deprecated_attach_hook) (void);
692 extern void (*deprecated_detach_hook) (void);
693 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
694 char *cmd, int from_tty);
696 extern int (*deprecated_ui_load_progress_hook) (const char *section,
699 /* If this definition isn't overridden by the header files, assume
700 that isatty and fileno exist on this system. */
702 #define ISATTY(FP) (isatty (fileno (FP)))
705 /* * A width that can achieve a better legibility for GDB MI mode. */
706 #define GDB_MI_MSG_WIDTH 80
708 /* From progspace.c */
710 extern void initialize_progspace (void);
711 extern void initialize_inferiors (void);
713 /* * Special block numbers */
719 FIRST_LOCAL_BLOCK = 2
724 #endif /* #ifndef DEFS_H */