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>
34 /* The libdecnumber library, on which GDB depends, includes a header file
35 called gstdint.h instead of relying directly on stdint.h. GDB, on the
36 other hand, includes stdint.h directly, relying on the fact that gnulib
37 generates a copy if the system doesn't provide one or if it is missing
38 some features. Unfortunately, gstdint.h and stdint.h cannot be included
39 at the same time, which may happen when we include a file from
42 The following macro definition effectively prevents the inclusion of
43 gstdint.h, as all the definitions it provides are guarded against
44 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
45 included, so it's ok to blank out gstdint.h. */
46 #define GCC_GENERATED_STDINT_H 1
52 #include "gdb_wchar.h"
56 #include "host-defs.h"
58 /* Scope types enumerator. List the types of scopes the compiler will
61 enum compile_i_scope_types
63 COMPILE_I_INVALID_SCOPE,
65 /* A simple scope. Wrap an expression into a simple scope that
66 takes no arguments, returns no value, and uses the generic
67 function name "_gdb_expr". */
69 COMPILE_I_SIMPLE_SCOPE,
71 /* Do not wrap the expression,
72 it has to provide function "_gdb_expr" on its own. */
76 /* Just in case they're not defined in stdio.h. */
85 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
86 It is used as an access modifier in calls to open(), where it acts
87 similarly to the "b" character in fopen()'s MODE argument. On Posix
88 platforms it should be a no-op, so it is defined as 0 here. This
89 ensures that the symbol may be used freely elsewhere in gdb. */
98 #define min(a, b) ((a) < (b) ? (a) : (b))
101 #define max(a, b) ((a) > (b) ? (a) : (b))
104 /* * Enable xdb commands if set. */
105 extern int xdb_commands;
107 /* * Enable dbx commands if set. */
108 extern int dbx_commands;
110 /* * System root path, used to find libraries etc. */
111 extern char *gdb_sysroot;
113 /* * GDB datadir, used to store data files. */
114 extern char *gdb_datadir;
116 /* * If non-NULL, the possibly relocated path to python's "lib" directory
117 specified with --with-python. */
118 extern char *python_libdir;
120 /* * Search path for separate debug files. */
121 extern char *debug_file_directory;
123 /* GDB has two methods for handling SIGINT. When immediate_quit is
124 nonzero, a SIGINT results in an immediate longjmp out of the signal
125 handler. Otherwise, SIGINT simply sets a flag; code that might
126 take a long time, and which ought to be interruptible, checks this
127 flag using the QUIT macro.
129 These functions use the extension_language_ops API to allow extension
130 language(s) and GDB SIGINT handling to coexist seamlessly. */
132 /* * Clear the quit flag. */
133 extern void clear_quit_flag (void);
134 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
135 will clear the quit flag as a side effect. */
136 extern int check_quit_flag (void);
137 /* * Set the quit flag. */
138 extern void set_quit_flag (void);
140 /* Flag that function quit should call quit_force. */
141 extern volatile int sync_quit_force_run;
143 extern int immediate_quit;
145 extern void quit (void);
147 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
148 benefits of having a ``QUIT'' macro rather than a function are
149 marginal. If the overhead of a QUIT function call is proving
150 significant then its calling frequency should probably be reduced
151 [kingdon]. A profile analyzing the current situtation is
155 if (check_quit_flag () || sync_quit_force_run) quit (); \
156 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
159 /* * Languages represented in the symbol table and elsewhere.
160 This should probably be in language.h, but since enum's can't
161 be forward declared to satisfy opaque references before their
162 actual definition, needs to be here. */
166 language_unknown, /* Language not known */
167 language_auto, /* Placeholder for automatic setting */
169 language_cplus, /* C++ */
171 language_go, /* Go */
172 language_objc, /* Objective-C */
173 language_java, /* Java */
174 language_fortran, /* Fortran */
175 language_m2, /* Modula-2 */
176 language_asm, /* Assembly language */
177 language_pascal, /* Pascal */
178 language_ada, /* Ada */
179 language_opencl, /* OpenCL */
180 language_minimal, /* All other languages, minimal support only */
188 unspecified_precision
191 /* * A generic, not quite boolean, enumeration. This is used for
192 set/show commands in which the options are on/off/automatic. */
200 /* * Potential ways that a function can return a value of a given
203 enum return_value_convention
205 /* * Where the return value has been squeezed into one or more
207 RETURN_VALUE_REGISTER_CONVENTION,
208 /* * Commonly known as the "struct return convention". The caller
209 passes an additional hidden first parameter to the caller. That
210 parameter contains the address at which the value being returned
211 should be stored. While typically, and historically, used for
212 large structs, this is convention is applied to values of many
214 RETURN_VALUE_STRUCT_CONVENTION,
215 /* * Like the "struct return convention" above, but where the ABI
216 guarantees that the called function stores the address at which
217 the value being returned is stored in a well-defined location,
218 such as a register or memory slot in the stack frame. Don't use
219 this if the ABI doesn't explicitly guarantees this. */
220 RETURN_VALUE_ABI_RETURNS_ADDRESS,
221 /* * Like the "struct return convention" above, but where the ABI
222 guarantees that the address at which the value being returned is
223 stored will be available in a well-defined location, such as a
224 register or memory slot in the stack frame. Don't use this if
225 the ABI doesn't explicitly guarantees this. */
226 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
229 /* Needed for various prototypes */
239 /* This really belong in utils.c (path-utils.c?), but it references some
240 globals that are currently only available to main.c. */
241 extern char *relocate_gdb_directory (const char *initial, int flag);
244 /* Annotation stuff. */
246 extern int annotation_level; /* in stack.c */
249 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
250 "const char *" in unistd.h, so we can't declare the argument
253 extern char *re_comp (const char *);
257 extern void symbol_file_command (char *, int);
259 /* * Remote targets may wish to use this as their load function. */
260 extern void generic_load (const char *name, int from_tty);
262 /* * Report on STREAM the performance of memory transfer operation,
264 @param DATA_COUNT is the number of bytes transferred.
265 @param WRITE_COUNT is the number of separate write operations, or 0,
266 if that information is not available.
267 @param START_TIME is the time at which an operation was started.
268 @param END_TIME is the time at which an operation ended. */
270 extern void print_transfer_performance (struct ui_file *stream,
271 unsigned long data_count,
272 unsigned long write_count,
273 const struct timeval *start_time,
274 const struct timeval *end_time);
278 typedef void initialize_file_ftype (void);
280 extern char *gdb_readline (const char *);
282 extern char *gdb_readline_wrapper (const char *);
284 extern char *command_line_input (const char *, int, char *);
286 extern void print_prompt (void);
288 extern int input_from_terminal_p (void);
290 extern int info_verbose;
292 /* From printcmd.c */
294 extern void set_next_address (struct gdbarch *, CORE_ADDR);
296 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
297 struct ui_file *, int, char *);
299 extern int build_address_symbolic (struct gdbarch *,
308 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
309 extern const char *pc_prefix (CORE_ADDR);
313 /* See openp function definition for their description. */
314 #define OPF_TRY_CWD_FIRST 0x01
315 #define OPF_SEARCH_IN_PATH 0x02
316 #define OPF_RETURN_REALPATH 0x04
318 extern int openp (const char *, int, const char *, int, char **);
320 extern int source_full_path_of (const char *, char **);
322 extern void mod_path (char *, char **);
324 extern void add_path (char *, char **, int);
326 extern void directory_switch (char *, int);
328 extern char *source_path;
330 extern void init_source_path (void);
334 /* * Process memory area starting at ADDR with length SIZE. Area is
335 readable iff READ is non-zero, writable if WRITE is non-zero,
336 executable if EXEC is non-zero. Area is possibly changed against
337 its original file based copy if MODIFIED is non-zero. DATA is
338 passed without changes from a caller. */
340 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
341 int read, int write, int exec,
342 int modified, void *data);
344 /* * Possible lvalue types. Like enum language, this should be in
345 value.h, but needs to be here for the same reason. */
353 /* * In a register. Registers are relative to a frame. */
355 /* * In a gdb internal variable. */
357 /* * Value encapsulates a callable defined in an extension language. */
359 /* * Part of a gdb internal variable (structure field). */
360 lval_internalvar_component,
361 /* * Value's bits are fetched and stored using functions provided
366 /* * Control types for commands. */
368 enum misc_command_type
376 enum command_control_type
387 while_stepping_control,
391 /* * Structure for saved commands lines (for breakpoints, defined
396 struct command_line *next;
398 enum command_control_type control_type;
403 enum compile_i_scope_types scope;
408 /* * The number of elements in body_list. */
410 /* * For composite commands, the nested lists of commands. For
411 example, for "if" command this will contain the then branch and
412 the else branch, if that is available. */
413 struct command_line **body_list;
416 extern struct command_line *read_command_lines (char *, int, int,
417 void (*)(char *, void *),
419 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
420 void (*)(char *, void *),
423 extern void free_command_lines (struct command_line **);
425 /* * Parameters of the "info proc" command. */
429 /* * Display the default cmdline, cwd and exe outputs. */
432 /* * Display `info proc mappings'. */
435 /* * Display `info proc status'. */
438 /* * Display `info proc stat'. */
441 /* * Display `info proc cmdline'. */
444 /* * Display `info proc exe'. */
447 /* * Display `info proc cwd'. */
450 /* * Display all of the above. */
454 /* * String containing the current directory (what getwd would return). */
456 extern char *current_directory;
458 /* * Default radixes for input and output. Only some values supported. */
459 extern unsigned input_radix;
460 extern unsigned output_radix;
462 /* * Possibilities for prettyformat parameters to routines which print
463 things. Like enum language, this should be in value.h, but needs
464 to be here for the same reason. FIXME: If we can eliminate this
465 as an arg to LA_VAL_PRINT, then we can probably move it back to
468 enum val_prettyformat
470 Val_no_prettyformat = 0,
472 /* * Use the default setting which the user has specified. */
473 Val_prettyformat_default
476 /* * Optional native machine support. Non-native (and possibly pure
477 multi-arch) targets do not need a "nm.h" file. This will be a
478 symlink to one of the nm-*.h files, built by the `configure'
485 /* Assume that fopen accepts the letter "b" in the mode string.
486 It is demanded by ISO C9X, and should be supported on all
487 platforms that claim to have a standard-conforming C library. On
488 true POSIX systems it will be ignored and have no effect. There
489 may still be systems without a standard-conforming C library where
490 an ISO C9X compiler (GCC) is available. Known examples are SunOS
491 4.x and 4.3BSD. This assumption means these systems are no longer
494 # include "fopen-bin.h"
497 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
498 FIXME: Assumes 2's complement arithmetic. */
500 #if !defined (UINT_MAX)
501 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
504 #if !defined (INT_MAX)
505 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
508 #if !defined (INT_MIN)
509 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
512 #if !defined (ULONG_MAX)
513 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
516 #if !defined (LONG_MAX)
517 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
520 #if !defined (ULONGEST_MAX)
521 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
524 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
525 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
528 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
529 arguments to a function, number in a value history, register number, etc.)
530 where the value must not be larger than can fit in an int. */
532 extern int longest_to_int (LONGEST);
534 /* * List of known OS ABIs. If you change this, make sure to update the
538 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
540 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
546 GDB_OSABI_FREEBSD_AOUT,
547 GDB_OSABI_FREEBSD_ELF,
548 GDB_OSABI_NETBSD_AOUT,
549 GDB_OSABI_NETBSD_ELF,
550 GDB_OSABI_OPENBSD_ELF,
567 GDB_OSABI_INVALID /* keep this last */
570 /* Global functions from other, non-gdb GNU thingies.
571 Libiberty thingies are no longer declared here. We include libiberty.h
574 /* From other system libraries */
577 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
580 /* Dynamic target-system-dependent parameters for GDB. */
583 /* * Maximum size of a register. Something small, but large enough for
584 all known ISAs. If it turns out to be too small, make it bigger. */
586 enum { MAX_REGISTER_SIZE = 64 };
588 /* Static target-system-dependent parameters for GDB. */
590 /* * Number of bits in a char or unsigned char for the target machine.
591 Just like CHAR_BIT in <limits.h> but describes the target machine. */
592 #if !defined (TARGET_CHAR_BIT)
593 #define TARGET_CHAR_BIT 8
596 /* * If we picked up a copy of CHAR_BIT from a configuration file
597 (which may get it by including <limits.h>) then use it to set
598 the number of bits in a host char. If not, use the same size
601 #if defined (CHAR_BIT)
602 #define HOST_CHAR_BIT CHAR_BIT
604 #define HOST_CHAR_BIT TARGET_CHAR_BIT
609 extern LONGEST extract_signed_integer (const gdb_byte *, int,
612 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
615 extern int extract_long_unsigned_integer (const gdb_byte *, int,
616 enum bfd_endian, LONGEST *);
618 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
621 extern void store_signed_integer (gdb_byte *, int,
622 enum bfd_endian, LONGEST);
624 extern void store_unsigned_integer (gdb_byte *, int,
625 enum bfd_endian, ULONGEST);
627 extern void store_typed_address (gdb_byte *buf, struct type *type,
635 /* Hooks for alternate command interfaces. */
637 /* * The name of the interpreter if specified on the command line. */
638 extern char *interpreter_p;
640 /* If a given interpreter matches INTERPRETER_P then it should update
641 deprecated_init_ui_hook with the per-interpreter implementation. */
642 /* FIXME: deprecated_init_ui_hook should be moved here. */
644 struct target_waitstatus;
645 struct cmd_list_element;
647 extern void (*deprecated_pre_add_symbol_hook) (const char *);
648 extern void (*deprecated_post_add_symbol_hook) (void);
649 extern void (*selected_frame_level_changed_hook) (int);
650 extern int (*deprecated_ui_loop_hook) (int signo);
651 extern void (*deprecated_init_ui_hook) (char *argv0);
652 extern void (*deprecated_show_load_progress) (const char *section,
653 unsigned long section_sent,
654 unsigned long section_size,
655 unsigned long total_sent,
656 unsigned long total_size);
657 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
661 extern int (*deprecated_query_hook) (const char *, va_list)
662 ATTRIBUTE_FPTR_PRINTF(1,0);
663 extern void (*deprecated_warning_hook) (const char *, va_list)
664 ATTRIBUTE_FPTR_PRINTF(1,0);
665 extern void (*deprecated_interactive_hook) (void);
666 extern void (*deprecated_readline_begin_hook) (char *, ...)
667 ATTRIBUTE_FPTR_PRINTF_1;
668 extern char *(*deprecated_readline_hook) (const char *);
669 extern void (*deprecated_readline_end_hook) (void);
670 extern void (*deprecated_register_changed_hook) (int regno);
671 extern void (*deprecated_context_hook) (int);
672 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
673 struct target_waitstatus *status,
676 extern void (*deprecated_attach_hook) (void);
677 extern void (*deprecated_detach_hook) (void);
678 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
679 char *cmd, int from_tty);
681 extern int (*deprecated_ui_load_progress_hook) (const char *section,
684 /* If this definition isn't overridden by the header files, assume
685 that isatty and fileno exist on this system. */
687 #define ISATTY(FP) (isatty (fileno (FP)))
690 /* * A width that can achieve a better legibility for GDB MI mode. */
691 #define GDB_MI_MSG_WIDTH 80
693 /* From progspace.c */
695 extern void initialize_progspace (void);
696 extern void initialize_inferiors (void);
698 /* * Special block numbers */
704 FIRST_LOCAL_BLOCK = 2
709 #endif /* #ifndef DEFS_H */