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 /* * Clear the quit flag. */
143 extern void clear_quit_flag (void);
144 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
145 will clear the quit flag as a side effect. */
146 extern int check_quit_flag (void);
147 /* * Set the quit flag. */
148 extern void set_quit_flag (void);
150 /* Flag that function quit should call quit_force. */
151 extern volatile int sync_quit_force_run;
153 extern int immediate_quit;
155 extern void quit (void);
157 /* Helper for the QUIT macro. */
159 extern void maybe_quit (void);
161 /* Check whether a Ctrl-C was typed, and if so, call quit. The target
162 is given a chance to process the Ctrl-C. E.g., it may detect that
163 repeated Ctrl-C requests were issued, and choose to close the
165 #define QUIT maybe_quit ()
167 /* Set the serial event associated with the quit flag. */
168 extern void quit_serial_event_set (void);
170 /* Clear the serial event associated with the quit flag. */
171 extern void quit_serial_event_clear (void);
173 /* * Languages represented in the symbol table and elsewhere.
174 This should probably be in language.h, but since enum's can't
175 be forward declared to satisfy opaque references before their
176 actual definition, needs to be here. */
180 language_unknown, /* Language not known */
181 language_auto, /* Placeholder for automatic setting */
183 language_cplus, /* C++ */
185 language_go, /* Go */
186 language_objc, /* Objective-C */
187 language_java, /* Java */
188 language_fortran, /* Fortran */
189 language_m2, /* Modula-2 */
190 language_asm, /* Assembly language */
191 language_pascal, /* Pascal */
192 language_ada, /* Ada */
193 language_opencl, /* OpenCL */
194 language_minimal, /* All other languages, minimal support only */
198 /* The number of bits needed to represent all languages, with enough
199 padding to allow for reasonable growth. */
200 #define LANGUAGE_BITS 5
201 gdb_static_assert (nr_languages <= (1 << LANGUAGE_BITS));
207 unspecified_precision
210 /* * A generic, not quite boolean, enumeration. This is used for
211 set/show commands in which the options are on/off/automatic. */
219 /* * Potential ways that a function can return a value of a given
222 enum return_value_convention
224 /* * Where the return value has been squeezed into one or more
226 RETURN_VALUE_REGISTER_CONVENTION,
227 /* * Commonly known as the "struct return convention". The caller
228 passes an additional hidden first parameter to the caller. That
229 parameter contains the address at which the value being returned
230 should be stored. While typically, and historically, used for
231 large structs, this is convention is applied to values of many
233 RETURN_VALUE_STRUCT_CONVENTION,
234 /* * Like the "struct return convention" above, but where the ABI
235 guarantees that the called function stores the address at which
236 the value being returned is stored in a well-defined location,
237 such as a register or memory slot in the stack frame. Don't use
238 this if the ABI doesn't explicitly guarantees this. */
239 RETURN_VALUE_ABI_RETURNS_ADDRESS,
240 /* * Like the "struct return convention" above, but where the ABI
241 guarantees that the address at which the value being returned is
242 stored will be available in a well-defined location, such as a
243 register or memory slot in the stack frame. Don't use this if
244 the ABI doesn't explicitly guarantees this. */
245 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
248 /* Needed for various prototypes */
258 /* This really belong in utils.c (path-utils.c?), but it references some
259 globals that are currently only available to main.c. */
260 extern char *relocate_gdb_directory (const char *initial, int flag);
263 /* Annotation stuff. */
265 extern int annotation_level; /* in stack.c */
268 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
269 "const char *" in unistd.h, so we can't declare the argument
272 EXTERN_C char *re_comp (const char *);
276 extern void symbol_file_command (char *, int);
278 /* * Remote targets may wish to use this as their load function. */
279 extern void generic_load (const char *name, int from_tty);
281 /* * Report on STREAM the performance of memory transfer operation,
283 @param DATA_COUNT is the number of bytes transferred.
284 @param WRITE_COUNT is the number of separate write operations, or 0,
285 if that information is not available.
286 @param START_TIME is the time at which an operation was started.
287 @param END_TIME is the time at which an operation ended. */
289 extern void print_transfer_performance (struct ui_file *stream,
290 unsigned long data_count,
291 unsigned long write_count,
292 const struct timeval *start_time,
293 const struct timeval *end_time);
297 typedef void initialize_file_ftype (void);
299 extern char *gdb_readline_wrapper (const char *);
301 extern char *command_line_input (const char *, int, char *);
303 extern void print_prompt (void);
305 extern int input_from_terminal_p (void);
307 extern int info_verbose;
309 /* From printcmd.c */
311 extern void set_next_address (struct gdbarch *, CORE_ADDR);
313 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
314 struct ui_file *, int, char *);
316 extern int build_address_symbolic (struct gdbarch *,
325 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
326 extern const char *pc_prefix (CORE_ADDR);
330 /* See openp function definition for their description. */
331 #define OPF_TRY_CWD_FIRST 0x01
332 #define OPF_SEARCH_IN_PATH 0x02
333 #define OPF_RETURN_REALPATH 0x04
335 extern int openp (const char *, int, const char *, int, char **);
337 extern int source_full_path_of (const char *, char **);
339 extern void mod_path (char *, char **);
341 extern void add_path (char *, char **, int);
343 extern void directory_switch (char *, int);
345 extern char *source_path;
347 extern void init_source_path (void);
351 /* * Process memory area starting at ADDR with length SIZE. Area is
352 readable iff READ is non-zero, writable if WRITE is non-zero,
353 executable if EXEC is non-zero. Area is possibly changed against
354 its original file based copy if MODIFIED is non-zero. DATA is
355 passed without changes from a caller. */
357 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
358 int read, int write, int exec,
359 int modified, void *data);
361 /* * Possible lvalue types. Like enum language, this should be in
362 value.h, but needs to be here for the same reason. */
370 /* * In a register. Registers are relative to a frame. */
372 /* * In a gdb internal variable. */
374 /* * Value encapsulates a callable defined in an extension language. */
376 /* * Part of a gdb internal variable (structure field). */
377 lval_internalvar_component,
378 /* * Value's bits are fetched and stored using functions provided
383 /* * Control types for commands. */
385 enum misc_command_type
393 enum command_control_type
404 while_stepping_control,
408 /* * Structure for saved commands lines (for breakpoints, defined
413 struct command_line *next;
415 enum command_control_type control_type;
420 enum compile_i_scope_types scope;
426 /* * The number of elements in body_list. */
428 /* * For composite commands, the nested lists of commands. For
429 example, for "if" command this will contain the then branch and
430 the else branch, if that is available. */
431 struct command_line **body_list;
434 extern struct command_line *read_command_lines (char *, int, int,
435 void (*)(char *, void *),
437 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
438 void (*)(char *, void *),
441 extern void free_command_lines (struct command_line **);
443 /* * Parameters of the "info proc" command. */
447 /* * Display the default cmdline, cwd and exe outputs. */
450 /* * Display `info proc mappings'. */
453 /* * Display `info proc status'. */
456 /* * Display `info proc stat'. */
459 /* * Display `info proc cmdline'. */
462 /* * Display `info proc exe'. */
465 /* * Display `info proc cwd'. */
468 /* * Display all of the above. */
472 /* * String containing the current directory (what getwd would return). */
474 extern char *current_directory;
476 /* * Default radixes for input and output. Only some values supported. */
477 extern unsigned input_radix;
478 extern unsigned output_radix;
480 /* * Possibilities for prettyformat parameters to routines which print
481 things. Like enum language, this should be in value.h, but needs
482 to be here for the same reason. FIXME: If we can eliminate this
483 as an arg to LA_VAL_PRINT, then we can probably move it back to
486 enum val_prettyformat
488 Val_no_prettyformat = 0,
490 /* * Use the default setting which the user has specified. */
491 Val_prettyformat_default
494 /* * Optional native machine support. Non-native (and possibly pure
495 multi-arch) targets do not need a "nm.h" file. This will be a
496 symlink to one of the nm-*.h files, built by the `configure'
503 /* Assume that fopen accepts the letter "b" in the mode string.
504 It is demanded by ISO C9X, and should be supported on all
505 platforms that claim to have a standard-conforming C library. On
506 true POSIX systems it will be ignored and have no effect. There
507 may still be systems without a standard-conforming C library where
508 an ISO C9X compiler (GCC) is available. Known examples are SunOS
509 4.x and 4.3BSD. This assumption means these systems are no longer
512 # include "fopen-bin.h"
515 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
516 FIXME: Assumes 2's complement arithmetic. */
518 #if !defined (UINT_MAX)
519 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
522 #if !defined (INT_MAX)
523 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
526 #if !defined (INT_MIN)
527 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
530 #if !defined (ULONG_MAX)
531 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
534 #if !defined (LONG_MAX)
535 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
538 #if !defined (ULONGEST_MAX)
539 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
542 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
543 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
546 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
547 arguments to a function, number in a value history, register number, etc.)
548 where the value must not be larger than can fit in an int. */
550 extern int longest_to_int (LONGEST);
552 /* * List of known OS ABIs. If you change this, make sure to update the
556 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
558 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
564 GDB_OSABI_FREEBSD_AOUT,
565 GDB_OSABI_FREEBSD_ELF,
566 GDB_OSABI_NETBSD_AOUT,
567 GDB_OSABI_NETBSD_ELF,
568 GDB_OSABI_OPENBSD_ELF,
585 GDB_OSABI_INVALID /* keep this last */
588 /* Global functions from other, non-gdb GNU thingies.
589 Libiberty thingies are no longer declared here. We include libiberty.h
592 /* From other system libraries */
595 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
598 /* Dynamic target-system-dependent parameters for GDB. */
601 /* * Maximum size of a register. Something small, but large enough for
602 all known ISAs. If it turns out to be too small, make it bigger. */
604 enum { MAX_REGISTER_SIZE = 64 };
608 extern LONGEST extract_signed_integer (const gdb_byte *, int,
611 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
614 extern int extract_long_unsigned_integer (const gdb_byte *, int,
615 enum bfd_endian, LONGEST *);
617 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
620 extern void store_signed_integer (gdb_byte *, int,
621 enum bfd_endian, LONGEST);
623 extern void store_unsigned_integer (gdb_byte *, int,
624 enum bfd_endian, ULONGEST);
626 extern void store_typed_address (gdb_byte *buf, struct type *type,
634 /* Hooks for alternate command interfaces. */
636 /* * The name of the interpreter if specified on the command line. */
637 extern char *interpreter_p;
639 struct target_waitstatus;
640 struct cmd_list_element;
642 extern void (*deprecated_pre_add_symbol_hook) (const char *);
643 extern void (*deprecated_post_add_symbol_hook) (void);
644 extern void (*selected_frame_level_changed_hook) (int);
645 extern int (*deprecated_ui_loop_hook) (int signo);
646 extern void (*deprecated_show_load_progress) (const char *section,
647 unsigned long section_sent,
648 unsigned long section_size,
649 unsigned long total_sent,
650 unsigned long total_size);
651 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
655 extern int (*deprecated_query_hook) (const char *, va_list)
656 ATTRIBUTE_FPTR_PRINTF(1,0);
657 extern void (*deprecated_warning_hook) (const char *, va_list)
658 ATTRIBUTE_FPTR_PRINTF(1,0);
659 extern void (*deprecated_interactive_hook) (void);
660 extern void (*deprecated_readline_begin_hook) (char *, ...)
661 ATTRIBUTE_FPTR_PRINTF_1;
662 extern char *(*deprecated_readline_hook) (const char *);
663 extern void (*deprecated_readline_end_hook) (void);
664 extern void (*deprecated_context_hook) (int);
665 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
666 struct target_waitstatus *status,
669 extern void (*deprecated_attach_hook) (void);
670 extern void (*deprecated_detach_hook) (void);
671 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
672 char *cmd, int from_tty);
674 extern int (*deprecated_ui_load_progress_hook) (const char *section,
677 /* If this definition isn't overridden by the header files, assume
678 that isatty and fileno exist on this system. */
680 #define ISATTY(FP) (isatty (fileno (FP)))
683 /* * A width that can achieve a better legibility for GDB MI mode. */
684 #define GDB_MI_MSG_WIDTH 80
686 /* From progspace.c */
688 extern void initialize_progspace (void);
689 extern void initialize_inferiors (void);
691 /* * Special block numbers */
697 FIRST_LOCAL_BLOCK = 2
702 #endif /* #ifndef DEFS_H */