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 These functions use the extension_language_ops API to allow extension
135 language(s) and GDB SIGINT handling to coexist seamlessly. */
137 /* * Clear the quit flag. */
138 extern void clear_quit_flag (void);
139 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
140 will clear the quit flag as a side effect. */
141 extern int check_quit_flag (void);
142 /* * Set the quit flag. */
143 extern void set_quit_flag (void);
145 /* Flag that function quit should call quit_force. */
146 extern volatile int sync_quit_force_run
;
148 extern int immediate_quit
;
150 extern void quit (void);
152 /* Helper for the QUIT macro. */
154 extern void maybe_quit (void);
156 /* Check whether a Ctrl-C was typed, and if so, call quit. The target
157 is given a chance to process the Ctrl-C. E.g., it may detect that
158 repeated Ctrl-C requests were issued, and choose to close the
160 #define QUIT maybe_quit ()
162 /* * Languages represented in the symbol table and elsewhere.
163 This should probably be in language.h, but since enum's can't
164 be forward declared to satisfy opaque references before their
165 actual definition, needs to be here. */
169 language_unknown
, /* Language not known */
170 language_auto
, /* Placeholder for automatic setting */
172 language_cplus
, /* C++ */
174 language_go
, /* Go */
175 language_objc
, /* Objective-C */
176 language_java
, /* Java */
177 language_fortran
, /* Fortran */
178 language_m2
, /* Modula-2 */
179 language_asm
, /* Assembly language */
180 language_pascal
, /* Pascal */
181 language_ada
, /* Ada */
182 language_opencl
, /* OpenCL */
183 language_minimal
, /* All other languages, minimal support only */
187 /* The number of bits needed to represent all languages, with enough
188 padding to allow for reasonable growth. */
189 #define LANGUAGE_BITS 5
190 gdb_static_assert (nr_languages
<= (1 << LANGUAGE_BITS
));
196 unspecified_precision
199 /* * A generic, not quite boolean, enumeration. This is used for
200 set/show commands in which the options are on/off/automatic. */
208 /* * Potential ways that a function can return a value of a given
211 enum return_value_convention
213 /* * Where the return value has been squeezed into one or more
215 RETURN_VALUE_REGISTER_CONVENTION
,
216 /* * Commonly known as the "struct return convention". The caller
217 passes an additional hidden first parameter to the caller. That
218 parameter contains the address at which the value being returned
219 should be stored. While typically, and historically, used for
220 large structs, this is convention is applied to values of many
222 RETURN_VALUE_STRUCT_CONVENTION
,
223 /* * Like the "struct return convention" above, but where the ABI
224 guarantees that the called function stores the address at which
225 the value being returned is stored in a well-defined location,
226 such as a register or memory slot in the stack frame. Don't use
227 this if the ABI doesn't explicitly guarantees this. */
228 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
229 /* * Like the "struct return convention" above, but where the ABI
230 guarantees that the address at which the value being returned is
231 stored will be available in a well-defined location, such as a
232 register or memory slot in the stack frame. Don't use this if
233 the ABI doesn't explicitly guarantees this. */
234 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
237 /* Needed for various prototypes */
247 /* This really belong in utils.c (path-utils.c?), but it references some
248 globals that are currently only available to main.c. */
249 extern char *relocate_gdb_directory (const char *initial
, int flag
);
252 /* Annotation stuff. */
254 extern int annotation_level
; /* in stack.c */
257 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
258 "const char *" in unistd.h, so we can't declare the argument
261 EXTERN_C
char *re_comp (const char *);
265 extern void symbol_file_command (char *, int);
267 /* * Remote targets may wish to use this as their load function. */
268 extern void generic_load (const char *name
, int from_tty
);
270 /* * Report on STREAM the performance of memory transfer operation,
272 @param DATA_COUNT is the number of bytes transferred.
273 @param WRITE_COUNT is the number of separate write operations, or 0,
274 if that information is not available.
275 @param START_TIME is the time at which an operation was started.
276 @param END_TIME is the time at which an operation ended. */
278 extern void print_transfer_performance (struct ui_file
*stream
,
279 unsigned long data_count
,
280 unsigned long write_count
,
281 const struct timeval
*start_time
,
282 const struct timeval
*end_time
);
286 typedef void initialize_file_ftype (void);
288 extern char *gdb_readline_wrapper (const char *);
290 extern char *command_line_input (const char *, int, char *);
292 extern void print_prompt (void);
294 extern int input_from_terminal_p (void);
296 extern int info_verbose
;
298 /* From printcmd.c */
300 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
302 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
303 struct ui_file
*, int, char *);
305 extern int build_address_symbolic (struct gdbarch
*,
314 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
315 extern const char *pc_prefix (CORE_ADDR
);
319 /* See openp function definition for their description. */
320 #define OPF_TRY_CWD_FIRST 0x01
321 #define OPF_SEARCH_IN_PATH 0x02
322 #define OPF_RETURN_REALPATH 0x04
324 extern int openp (const char *, int, const char *, int, char **);
326 extern int source_full_path_of (const char *, char **);
328 extern void mod_path (char *, char **);
330 extern void add_path (char *, char **, int);
332 extern void directory_switch (char *, int);
334 extern char *source_path
;
336 extern void init_source_path (void);
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. DATA is
344 passed without changes from a caller. */
346 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
347 int read
, int write
, int exec
,
348 int modified
, void *data
);
350 /* * Possible lvalue types. Like enum language, this should be in
351 value.h, but needs to be here for the same reason. */
359 /* * In a register. Registers are relative to a frame. */
361 /* * In a gdb internal variable. */
363 /* * Value encapsulates a callable defined in an extension language. */
365 /* * Part of a gdb internal variable (structure field). */
366 lval_internalvar_component
,
367 /* * Value's bits are fetched and stored using functions provided
372 /* * Control types for commands. */
374 enum misc_command_type
382 enum command_control_type
393 while_stepping_control
,
397 /* * Structure for saved commands lines (for breakpoints, defined
402 struct command_line
*next
;
404 enum command_control_type control_type
;
409 enum compile_i_scope_types scope
;
415 /* * The number of elements in body_list. */
417 /* * For composite commands, the nested lists of commands. For
418 example, for "if" command this will contain the then branch and
419 the else branch, if that is available. */
420 struct command_line
**body_list
;
423 extern struct command_line
*read_command_lines (char *, int, int,
424 void (*)(char *, void *),
426 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
427 void (*)(char *, void *),
430 extern void free_command_lines (struct command_line
**);
432 /* * Parameters of the "info proc" command. */
436 /* * Display the default cmdline, cwd and exe outputs. */
439 /* * Display `info proc mappings'. */
442 /* * Display `info proc status'. */
445 /* * Display `info proc stat'. */
448 /* * Display `info proc cmdline'. */
451 /* * Display `info proc exe'. */
454 /* * Display `info proc cwd'. */
457 /* * Display all of the above. */
461 /* * String containing the current directory (what getwd would return). */
463 extern char *current_directory
;
465 /* * Default radixes for input and output. Only some values supported. */
466 extern unsigned input_radix
;
467 extern unsigned output_radix
;
469 /* * Possibilities for prettyformat parameters to routines which print
470 things. Like enum language, this should be in value.h, but needs
471 to be here for the same reason. FIXME: If we can eliminate this
472 as an arg to LA_VAL_PRINT, then we can probably move it back to
475 enum val_prettyformat
477 Val_no_prettyformat
= 0,
479 /* * Use the default setting which the user has specified. */
480 Val_prettyformat_default
483 /* * Optional native machine support. Non-native (and possibly pure
484 multi-arch) targets do not need a "nm.h" file. This will be a
485 symlink to one of the nm-*.h files, built by the `configure'
492 /* Assume that fopen accepts the letter "b" in the mode string.
493 It is demanded by ISO C9X, and should be supported on all
494 platforms that claim to have a standard-conforming C library. On
495 true POSIX systems it will be ignored and have no effect. There
496 may still be systems without a standard-conforming C library where
497 an ISO C9X compiler (GCC) is available. Known examples are SunOS
498 4.x and 4.3BSD. This assumption means these systems are no longer
501 # include "fopen-bin.h"
504 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
505 FIXME: Assumes 2's complement arithmetic. */
507 #if !defined (UINT_MAX)
508 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
511 #if !defined (INT_MAX)
512 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
515 #if !defined (INT_MIN)
516 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
519 #if !defined (ULONG_MAX)
520 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
523 #if !defined (LONG_MAX)
524 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
527 #if !defined (ULONGEST_MAX)
528 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
531 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
532 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
535 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
536 arguments to a function, number in a value history, register number, etc.)
537 where the value must not be larger than can fit in an int. */
539 extern int longest_to_int (LONGEST
);
541 /* * List of known OS ABIs. If you change this, make sure to update the
545 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
547 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
553 GDB_OSABI_FREEBSD_AOUT
,
554 GDB_OSABI_FREEBSD_ELF
,
555 GDB_OSABI_NETBSD_AOUT
,
556 GDB_OSABI_NETBSD_ELF
,
557 GDB_OSABI_OPENBSD_ELF
,
574 GDB_OSABI_INVALID
/* keep this last */
577 /* Global functions from other, non-gdb GNU thingies.
578 Libiberty thingies are no longer declared here. We include libiberty.h
581 /* From other system libraries */
584 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
587 /* Dynamic target-system-dependent parameters for GDB. */
590 /* * Maximum size of a register. Something small, but large enough for
591 all known ISAs. If it turns out to be too small, make it bigger. */
593 enum { MAX_REGISTER_SIZE
= 64 };
597 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
600 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
603 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
604 enum bfd_endian
, LONGEST
*);
606 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
609 extern void store_signed_integer (gdb_byte
*, int,
610 enum bfd_endian
, LONGEST
);
612 extern void store_unsigned_integer (gdb_byte
*, int,
613 enum bfd_endian
, ULONGEST
);
615 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
623 /* Hooks for alternate command interfaces. */
625 /* * The name of the interpreter if specified on the command line. */
626 extern char *interpreter_p
;
628 struct target_waitstatus
;
629 struct cmd_list_element
;
631 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
632 extern void (*deprecated_post_add_symbol_hook
) (void);
633 extern void (*selected_frame_level_changed_hook
) (int);
634 extern int (*deprecated_ui_loop_hook
) (int signo
);
635 extern void (*deprecated_show_load_progress
) (const char *section
,
636 unsigned long section_sent
,
637 unsigned long section_size
,
638 unsigned long total_sent
,
639 unsigned long total_size
);
640 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
644 extern int (*deprecated_query_hook
) (const char *, va_list)
645 ATTRIBUTE_FPTR_PRINTF(1,0);
646 extern void (*deprecated_warning_hook
) (const char *, va_list)
647 ATTRIBUTE_FPTR_PRINTF(1,0);
648 extern void (*deprecated_interactive_hook
) (void);
649 extern void (*deprecated_readline_begin_hook
) (char *, ...)
650 ATTRIBUTE_FPTR_PRINTF_1
;
651 extern char *(*deprecated_readline_hook
) (const char *);
652 extern void (*deprecated_readline_end_hook
) (void);
653 extern void (*deprecated_context_hook
) (int);
654 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
655 struct target_waitstatus
*status
,
658 extern void (*deprecated_attach_hook
) (void);
659 extern void (*deprecated_detach_hook
) (void);
660 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
661 char *cmd
, int from_tty
);
663 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
666 /* If this definition isn't overridden by the header files, assume
667 that isatty and fileno exist on this system. */
669 #define ISATTY(FP) (isatty (fileno (FP)))
672 /* * A width that can achieve a better legibility for GDB MI mode. */
673 #define GDB_MI_MSG_WIDTH 80
675 /* From progspace.c */
677 extern void initialize_progspace (void);
678 extern void initialize_inferiors (void);
680 /* * Special block numbers */
686 FIRST_LOCAL_BLOCK
= 2
691 #endif /* #ifndef DEFS_H */