1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
3 /* Basic, host-specific, and target-specific definitions for GDB.
4 Copyright (C) 1986-2015 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 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
153 benefits of having a ``QUIT'' macro rather than a function are
154 marginal. If the overhead of a QUIT function call is proving
155 significant then its calling frequency should probably be reduced
156 [kingdon]. A profile analyzing the current situtation is
160 if (check_quit_flag () || sync_quit_force_run) quit (); \
161 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
164 /* * Languages represented in the symbol table and elsewhere.
165 This should probably be in language.h, but since enum's can't
166 be forward declared to satisfy opaque references before their
167 actual definition, needs to be here. */
171 language_unknown, /* Language not known */
172 language_auto, /* Placeholder for automatic setting */
174 language_cplus, /* C++ */
176 language_go, /* Go */
177 language_objc, /* Objective-C */
178 language_java, /* Java */
179 language_fortran, /* Fortran */
180 language_m2, /* Modula-2 */
181 language_asm, /* Assembly language */
182 language_pascal, /* Pascal */
183 language_ada, /* Ada */
184 language_opencl, /* OpenCL */
185 language_minimal, /* All other languages, minimal support only */
193 unspecified_precision
196 /* * A generic, not quite boolean, enumeration. This is used for
197 set/show commands in which the options are on/off/automatic. */
205 /* * Potential ways that a function can return a value of a given
208 enum return_value_convention
210 /* * Where the return value has been squeezed into one or more
212 RETURN_VALUE_REGISTER_CONVENTION,
213 /* * Commonly known as the "struct return convention". The caller
214 passes an additional hidden first parameter to the caller. That
215 parameter contains the address at which the value being returned
216 should be stored. While typically, and historically, used for
217 large structs, this is convention is applied to values of many
219 RETURN_VALUE_STRUCT_CONVENTION,
220 /* * Like the "struct return convention" above, but where the ABI
221 guarantees that the called function stores the address at which
222 the value being returned is stored in a well-defined location,
223 such as a register or memory slot in the stack frame. Don't use
224 this if the ABI doesn't explicitly guarantees this. */
225 RETURN_VALUE_ABI_RETURNS_ADDRESS,
226 /* * Like the "struct return convention" above, but where the ABI
227 guarantees that the address at which the value being returned is
228 stored will be available in a well-defined location, such as a
229 register or memory slot in the stack frame. Don't use this if
230 the ABI doesn't explicitly guarantees this. */
231 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
234 /* Needed for various prototypes */
244 /* This really belong in utils.c (path-utils.c?), but it references some
245 globals that are currently only available to main.c. */
246 extern char *relocate_gdb_directory (const char *initial, int flag);
249 /* Annotation stuff. */
251 extern int annotation_level; /* in stack.c */
254 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
255 "const char *" in unistd.h, so we can't declare the argument
258 EXTERN_C char *re_comp (const char *);
262 extern void symbol_file_command (char *, int);
264 /* * Remote targets may wish to use this as their load function. */
265 extern void generic_load (const char *name, int from_tty);
267 /* * Report on STREAM the performance of memory transfer operation,
269 @param DATA_COUNT is the number of bytes transferred.
270 @param WRITE_COUNT is the number of separate write operations, or 0,
271 if that information is not available.
272 @param START_TIME is the time at which an operation was started.
273 @param END_TIME is the time at which an operation ended. */
275 extern void print_transfer_performance (struct ui_file *stream,
276 unsigned long data_count,
277 unsigned long write_count,
278 const struct timeval *start_time,
279 const struct timeval *end_time);
283 typedef void initialize_file_ftype (void);
285 extern char *gdb_readline (const char *);
287 extern char *gdb_readline_wrapper (const char *);
289 extern char *command_line_input (const char *, int, char *);
291 extern void print_prompt (void);
293 extern int input_from_terminal_p (void);
295 extern int info_verbose;
297 /* From printcmd.c */
299 extern void set_next_address (struct gdbarch *, CORE_ADDR);
301 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
302 struct ui_file *, int, char *);
304 extern int build_address_symbolic (struct gdbarch *,
313 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
314 extern const char *pc_prefix (CORE_ADDR);
318 /* See openp function definition for their description. */
319 #define OPF_TRY_CWD_FIRST 0x01
320 #define OPF_SEARCH_IN_PATH 0x02
321 #define OPF_RETURN_REALPATH 0x04
323 extern int openp (const char *, int, const char *, int, char **);
325 extern int source_full_path_of (const char *, char **);
327 extern void mod_path (char *, char **);
329 extern void add_path (char *, char **, int);
331 extern void directory_switch (char *, int);
333 extern char *source_path;
335 extern void init_source_path (void);
339 /* * Process memory area starting at ADDR with length SIZE. Area is
340 readable iff READ is non-zero, writable if WRITE is non-zero,
341 executable if EXEC is non-zero. Area is possibly changed against
342 its original file based copy if MODIFIED is non-zero. DATA is
343 passed without changes from a caller. */
345 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
346 int read, int write, int exec,
347 int modified, void *data);
349 /* * Possible lvalue types. Like enum language, this should be in
350 value.h, but needs to be here for the same reason. */
358 /* * In a register. Registers are relative to a frame. */
360 /* * In a gdb internal variable. */
362 /* * Value encapsulates a callable defined in an extension language. */
364 /* * Part of a gdb internal variable (structure field). */
365 lval_internalvar_component,
366 /* * Value's bits are fetched and stored using functions provided
371 /* * Control types for commands. */
373 enum misc_command_type
381 enum command_control_type
392 while_stepping_control,
396 /* * Structure for saved commands lines (for breakpoints, defined
401 struct command_line *next;
403 enum command_control_type control_type;
408 enum compile_i_scope_types scope;
414 /* * The number of elements in body_list. */
416 /* * For composite commands, the nested lists of commands. For
417 example, for "if" command this will contain the then branch and
418 the else branch, if that is available. */
419 struct command_line **body_list;
422 extern struct command_line *read_command_lines (char *, int, int,
423 void (*)(char *, void *),
425 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
426 void (*)(char *, void *),
429 extern void free_command_lines (struct command_line **);
431 /* * Parameters of the "info proc" command. */
435 /* * Display the default cmdline, cwd and exe outputs. */
438 /* * Display `info proc mappings'. */
441 /* * Display `info proc status'. */
444 /* * Display `info proc stat'. */
447 /* * Display `info proc cmdline'. */
450 /* * Display `info proc exe'. */
453 /* * Display `info proc cwd'. */
456 /* * Display all of the above. */
460 /* * String containing the current directory (what getwd would return). */
462 extern char *current_directory;
464 /* * Default radixes for input and output. Only some values supported. */
465 extern unsigned input_radix;
466 extern unsigned output_radix;
468 /* * Possibilities for prettyformat parameters to routines which print
469 things. Like enum language, this should be in value.h, but needs
470 to be here for the same reason. FIXME: If we can eliminate this
471 as an arg to LA_VAL_PRINT, then we can probably move it back to
474 enum val_prettyformat
476 Val_no_prettyformat = 0,
478 /* * Use the default setting which the user has specified. */
479 Val_prettyformat_default
482 /* * Optional native machine support. Non-native (and possibly pure
483 multi-arch) targets do not need a "nm.h" file. This will be a
484 symlink to one of the nm-*.h files, built by the `configure'
491 /* Assume that fopen accepts the letter "b" in the mode string.
492 It is demanded by ISO C9X, and should be supported on all
493 platforms that claim to have a standard-conforming C library. On
494 true POSIX systems it will be ignored and have no effect. There
495 may still be systems without a standard-conforming C library where
496 an ISO C9X compiler (GCC) is available. Known examples are SunOS
497 4.x and 4.3BSD. This assumption means these systems are no longer
500 # include "fopen-bin.h"
503 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
504 FIXME: Assumes 2's complement arithmetic. */
506 #if !defined (UINT_MAX)
507 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
510 #if !defined (INT_MAX)
511 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
514 #if !defined (INT_MIN)
515 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
518 #if !defined (ULONG_MAX)
519 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
522 #if !defined (LONG_MAX)
523 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
526 #if !defined (ULONGEST_MAX)
527 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
530 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
531 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
534 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
535 arguments to a function, number in a value history, register number, etc.)
536 where the value must not be larger than can fit in an int. */
538 extern int longest_to_int (LONGEST);
540 /* * List of known OS ABIs. If you change this, make sure to update the
544 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
546 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
552 GDB_OSABI_FREEBSD_AOUT,
553 GDB_OSABI_FREEBSD_ELF,
554 GDB_OSABI_NETBSD_AOUT,
555 GDB_OSABI_NETBSD_ELF,
556 GDB_OSABI_OPENBSD_ELF,
573 GDB_OSABI_INVALID /* keep this last */
576 /* Global functions from other, non-gdb GNU thingies.
577 Libiberty thingies are no longer declared here. We include libiberty.h
580 /* From other system libraries */
583 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
586 /* Dynamic target-system-dependent parameters for GDB. */
589 /* * Maximum size of a register. Something small, but large enough for
590 all known ISAs. If it turns out to be too small, make it bigger. */
592 enum { MAX_REGISTER_SIZE = 64 };
594 /* Static target-system-dependent parameters for GDB. */
596 /* * Number of bits in a char or unsigned char for the target machine.
597 Just like CHAR_BIT in <limits.h> but describes the target machine. */
598 #if !defined (TARGET_CHAR_BIT)
599 #define TARGET_CHAR_BIT 8
602 /* * If we picked up a copy of CHAR_BIT from a configuration file
603 (which may get it by including <limits.h>) then use it to set
604 the number of bits in a host char. If not, use the same size
607 #if defined (CHAR_BIT)
608 #define HOST_CHAR_BIT CHAR_BIT
610 #define HOST_CHAR_BIT TARGET_CHAR_BIT
615 extern LONGEST extract_signed_integer (const gdb_byte *, int,
618 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
621 extern int extract_long_unsigned_integer (const gdb_byte *, int,
622 enum bfd_endian, LONGEST *);
624 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
627 extern void store_signed_integer (gdb_byte *, int,
628 enum bfd_endian, LONGEST);
630 extern void store_unsigned_integer (gdb_byte *, int,
631 enum bfd_endian, ULONGEST);
633 extern void store_typed_address (gdb_byte *buf, struct type *type,
641 /* Hooks for alternate command interfaces. */
643 /* * The name of the interpreter if specified on the command line. */
644 extern char *interpreter_p;
646 struct target_waitstatus;
647 struct cmd_list_element;
649 extern void (*deprecated_pre_add_symbol_hook) (const char *);
650 extern void (*deprecated_post_add_symbol_hook) (void);
651 extern void (*selected_frame_level_changed_hook) (int);
652 extern int (*deprecated_ui_loop_hook) (int signo);
653 extern void (*deprecated_show_load_progress) (const char *section,
654 unsigned long section_sent,
655 unsigned long section_size,
656 unsigned long total_sent,
657 unsigned long total_size);
658 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
662 extern int (*deprecated_query_hook) (const char *, va_list)
663 ATTRIBUTE_FPTR_PRINTF(1,0);
664 extern void (*deprecated_warning_hook) (const char *, va_list)
665 ATTRIBUTE_FPTR_PRINTF(1,0);
666 extern void (*deprecated_interactive_hook) (void);
667 extern void (*deprecated_readline_begin_hook) (char *, ...)
668 ATTRIBUTE_FPTR_PRINTF_1;
669 extern char *(*deprecated_readline_hook) (const char *);
670 extern void (*deprecated_readline_end_hook) (void);
671 extern void (*deprecated_register_changed_hook) (int regno);
672 extern void (*deprecated_context_hook) (int);
673 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
674 struct target_waitstatus *status,
677 extern void (*deprecated_attach_hook) (void);
678 extern void (*deprecated_detach_hook) (void);
679 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
680 char *cmd, int from_tty);
682 extern int (*deprecated_ui_load_progress_hook) (const char *section,
685 /* If this definition isn't overridden by the header files, assume
686 that isatty and fileno exist on this system. */
688 #define ISATTY(FP) (isatty (fileno (FP)))
691 /* * A width that can achieve a better legibility for GDB MI mode. */
692 #define GDB_MI_MSG_WIDTH 80
694 /* From progspace.c */
696 extern void initialize_progspace (void);
697 extern void initialize_inferiors (void);
699 /* * Special block numbers */
705 FIRST_LOCAL_BLOCK = 2
710 #endif /* #ifndef DEFS_H */