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 /* Flag that function quit should call quit_force. */
149 extern volatile int sync_quit_force_run
;
151 extern int immediate_quit
;
153 extern void quit (void);
155 /* Helper for the QUIT macro. */
157 extern void maybe_quit (void);
159 /* Check whether a Ctrl-C was typed, and if so, call quit. The target
160 is given a chance to process the Ctrl-C. E.g., it may detect that
161 repeated Ctrl-C requests were issued, and choose to close the
163 #define QUIT maybe_quit ()
165 /* Set the serial event associated with the quit flag. */
166 extern void quit_serial_event_set (void);
168 /* Clear the serial event associated with the quit flag. */
169 extern void quit_serial_event_clear (void);
171 /* * Languages represented in the symbol table and elsewhere.
172 This should probably be in language.h, but since enum's can't
173 be forward declared to satisfy opaque references before their
174 actual definition, needs to be here. */
178 language_unknown
, /* Language not known */
179 language_auto
, /* Placeholder for automatic setting */
181 language_cplus
, /* C++ */
183 language_go
, /* Go */
184 language_objc
, /* Objective-C */
185 language_java
, /* Java */
186 language_fortran
, /* Fortran */
187 language_m2
, /* Modula-2 */
188 language_asm
, /* Assembly language */
189 language_pascal
, /* Pascal */
190 language_ada
, /* Ada */
191 language_opencl
, /* OpenCL */
192 language_minimal
, /* All other languages, minimal support only */
196 /* The number of bits needed to represent all languages, with enough
197 padding to allow for reasonable growth. */
198 #define LANGUAGE_BITS 5
199 gdb_static_assert (nr_languages
<= (1 << LANGUAGE_BITS
));
205 unspecified_precision
208 /* * A generic, not quite boolean, enumeration. This is used for
209 set/show commands in which the options are on/off/automatic. */
217 /* * Potential ways that a function can return a value of a given
220 enum return_value_convention
222 /* * Where the return value has been squeezed into one or more
224 RETURN_VALUE_REGISTER_CONVENTION
,
225 /* * Commonly known as the "struct return convention". The caller
226 passes an additional hidden first parameter to the caller. That
227 parameter contains the address at which the value being returned
228 should be stored. While typically, and historically, used for
229 large structs, this is convention is applied to values of many
231 RETURN_VALUE_STRUCT_CONVENTION
,
232 /* * Like the "struct return convention" above, but where the ABI
233 guarantees that the called function stores the address at which
234 the value being returned is stored in a well-defined location,
235 such as a register or memory slot in the stack frame. Don't use
236 this if the ABI doesn't explicitly guarantees this. */
237 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
238 /* * Like the "struct return convention" above, but where the ABI
239 guarantees that the address at which the value being returned is
240 stored will be available in a well-defined location, such as a
241 register or memory slot in the stack frame. Don't use this if
242 the ABI doesn't explicitly guarantees this. */
243 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
246 /* Needed for various prototypes */
256 /* This really belong in utils.c (path-utils.c?), but it references some
257 globals that are currently only available to main.c. */
258 extern char *relocate_gdb_directory (const char *initial
, int flag
);
261 /* Annotation stuff. */
263 extern int annotation_level
; /* in stack.c */
266 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
267 "const char *" in unistd.h, so we can't declare the argument
270 EXTERN_C
char *re_comp (const char *);
274 extern void symbol_file_command (char *, int);
276 /* * Remote targets may wish to use this as their load function. */
277 extern void generic_load (const char *name
, int from_tty
);
279 /* * Report on STREAM the performance of memory transfer operation,
281 @param DATA_COUNT is the number of bytes transferred.
282 @param WRITE_COUNT is the number of separate write operations, or 0,
283 if that information is not available.
284 @param START_TIME is the time at which an operation was started.
285 @param END_TIME is the time at which an operation ended. */
287 extern void print_transfer_performance (struct ui_file
*stream
,
288 unsigned long data_count
,
289 unsigned long write_count
,
290 const struct timeval
*start_time
,
291 const struct timeval
*end_time
);
295 typedef void initialize_file_ftype (void);
297 extern char *gdb_readline_wrapper (const char *);
299 extern char *command_line_input (const char *, int, char *);
301 extern void print_prompt (void);
303 extern int input_from_terminal_p (void);
305 extern int info_verbose
;
307 /* From printcmd.c */
309 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
311 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
312 struct ui_file
*, int, char *);
314 extern int build_address_symbolic (struct gdbarch
*,
323 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
324 extern const char *pc_prefix (CORE_ADDR
);
328 /* See openp function definition for their description. */
329 #define OPF_TRY_CWD_FIRST 0x01
330 #define OPF_SEARCH_IN_PATH 0x02
331 #define OPF_RETURN_REALPATH 0x04
333 extern int openp (const char *, int, const char *, int, char **);
335 extern int source_full_path_of (const char *, char **);
337 extern void mod_path (char *, char **);
339 extern void add_path (char *, char **, int);
341 extern void directory_switch (char *, int);
343 extern char *source_path
;
345 extern void init_source_path (void);
349 /* * Process memory area starting at ADDR with length SIZE. Area is
350 readable iff READ is non-zero, writable if WRITE is non-zero,
351 executable if EXEC is non-zero. Area is possibly changed against
352 its original file based copy if MODIFIED is non-zero. DATA is
353 passed without changes from a caller. */
355 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
356 int read
, int write
, int exec
,
357 int modified
, void *data
);
359 /* * Possible lvalue types. Like enum language, this should be in
360 value.h, but needs to be here for the same reason. */
368 /* * In a register. Registers are relative to a frame. */
370 /* * In a gdb internal variable. */
372 /* * Value encapsulates a callable defined in an extension language. */
374 /* * Part of a gdb internal variable (structure field). */
375 lval_internalvar_component
,
376 /* * Value's bits are fetched and stored using functions provided
381 /* * Control types for commands. */
383 enum misc_command_type
391 enum command_control_type
402 while_stepping_control
,
406 /* * Structure for saved commands lines (for breakpoints, defined
411 struct command_line
*next
;
413 enum command_control_type control_type
;
418 enum compile_i_scope_types scope
;
424 /* * The number of elements in body_list. */
426 /* * For composite commands, the nested lists of commands. For
427 example, for "if" command this will contain the then branch and
428 the else branch, if that is available. */
429 struct command_line
**body_list
;
432 extern struct command_line
*read_command_lines (char *, int, int,
433 void (*)(char *, void *),
435 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
436 void (*)(char *, void *),
439 extern void free_command_lines (struct command_line
**);
441 /* * Parameters of the "info proc" command. */
445 /* * Display the default cmdline, cwd and exe outputs. */
448 /* * Display `info proc mappings'. */
451 /* * Display `info proc status'. */
454 /* * Display `info proc stat'. */
457 /* * Display `info proc cmdline'. */
460 /* * Display `info proc exe'. */
463 /* * Display `info proc cwd'. */
466 /* * Display all of the above. */
470 /* * String containing the current directory (what getwd would return). */
472 extern char *current_directory
;
474 /* * Default radixes for input and output. Only some values supported. */
475 extern unsigned input_radix
;
476 extern unsigned output_radix
;
478 /* * Possibilities for prettyformat parameters to routines which print
479 things. Like enum language, this should be in value.h, but needs
480 to be here for the same reason. FIXME: If we can eliminate this
481 as an arg to LA_VAL_PRINT, then we can probably move it back to
484 enum val_prettyformat
486 Val_no_prettyformat
= 0,
488 /* * Use the default setting which the user has specified. */
489 Val_prettyformat_default
492 /* * Optional native machine support. Non-native (and possibly pure
493 multi-arch) targets do not need a "nm.h" file. This will be a
494 symlink to one of the nm-*.h files, built by the `configure'
501 /* Assume that fopen accepts the letter "b" in the mode string.
502 It is demanded by ISO C9X, and should be supported on all
503 platforms that claim to have a standard-conforming C library. On
504 true POSIX systems it will be ignored and have no effect. There
505 may still be systems without a standard-conforming C library where
506 an ISO C9X compiler (GCC) is available. Known examples are SunOS
507 4.x and 4.3BSD. This assumption means these systems are no longer
510 # include "fopen-bin.h"
513 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
514 FIXME: Assumes 2's complement arithmetic. */
516 #if !defined (UINT_MAX)
517 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
520 #if !defined (INT_MAX)
521 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
524 #if !defined (INT_MIN)
525 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
528 #if !defined (ULONG_MAX)
529 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
532 #if !defined (LONG_MAX)
533 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
536 #if !defined (ULONGEST_MAX)
537 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
540 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
541 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
544 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
545 arguments to a function, number in a value history, register number, etc.)
546 where the value must not be larger than can fit in an int. */
548 extern int longest_to_int (LONGEST
);
550 /* * List of known OS ABIs. If you change this, make sure to update the
554 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
556 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
562 GDB_OSABI_FREEBSD_AOUT
,
563 GDB_OSABI_FREEBSD_ELF
,
564 GDB_OSABI_NETBSD_AOUT
,
565 GDB_OSABI_NETBSD_ELF
,
566 GDB_OSABI_OPENBSD_ELF
,
583 GDB_OSABI_INVALID
/* keep this last */
586 /* Global functions from other, non-gdb GNU thingies.
587 Libiberty thingies are no longer declared here. We include libiberty.h
590 /* From other system libraries */
593 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
596 /* Dynamic target-system-dependent parameters for GDB. */
599 /* * Maximum size of a register. Something small, but large enough for
600 all known ISAs. If it turns out to be too small, make it bigger. */
602 enum { MAX_REGISTER_SIZE
= 64 };
606 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
609 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
612 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
613 enum bfd_endian
, LONGEST
*);
615 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
618 extern void store_signed_integer (gdb_byte
*, int,
619 enum bfd_endian
, LONGEST
);
621 extern void store_unsigned_integer (gdb_byte
*, int,
622 enum bfd_endian
, ULONGEST
);
624 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
632 /* Hooks for alternate command interfaces. */
634 /* * The name of the interpreter if specified on the command line. */
635 extern char *interpreter_p
;
637 struct target_waitstatus
;
638 struct cmd_list_element
;
640 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
641 extern void (*deprecated_post_add_symbol_hook
) (void);
642 extern void (*selected_frame_level_changed_hook
) (int);
643 extern int (*deprecated_ui_loop_hook
) (int signo
);
644 extern void (*deprecated_show_load_progress
) (const char *section
,
645 unsigned long section_sent
,
646 unsigned long section_size
,
647 unsigned long total_sent
,
648 unsigned long total_size
);
649 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
653 extern int (*deprecated_query_hook
) (const char *, va_list)
654 ATTRIBUTE_FPTR_PRINTF(1,0);
655 extern void (*deprecated_warning_hook
) (const char *, va_list)
656 ATTRIBUTE_FPTR_PRINTF(1,0);
657 extern void (*deprecated_interactive_hook
) (void);
658 extern void (*deprecated_readline_begin_hook
) (char *, ...)
659 ATTRIBUTE_FPTR_PRINTF_1
;
660 extern char *(*deprecated_readline_hook
) (const char *);
661 extern void (*deprecated_readline_end_hook
) (void);
662 extern void (*deprecated_context_hook
) (int);
663 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
664 struct target_waitstatus
*status
,
667 extern void (*deprecated_attach_hook
) (void);
668 extern void (*deprecated_detach_hook
) (void);
669 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
670 char *cmd
, int from_tty
);
672 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
675 /* If this definition isn't overridden by the header files, assume
676 that isatty and fileno exist on this system. */
678 #define ISATTY(FP) (isatty (fileno (FP)))
681 /* * A width that can achieve a better legibility for GDB MI mode. */
682 #define GDB_MI_MSG_WIDTH 80
684 /* From progspace.c */
686 extern void initialize_progspace (void);
687 extern void initialize_inferiors (void);
689 /* * Special block numbers */
695 FIRST_LOCAL_BLOCK
= 2
700 #endif /* #ifndef DEFS_H */