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. */
75 /* Just in case they're not defined in stdio.h. */
84 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
85 It is used as an access modifier in calls to open(), where it acts
86 similarly to the "b" character in fopen()'s MODE argument. On Posix
87 platforms it should be a no-op, so it is defined as 0 here. This
88 ensures that the symbol may be used freely elsewhere in gdb. */
97 #define min(a, b) ((a) < (b) ? (a) : (b))
100 #define max(a, b) ((a) > (b) ? (a) : (b))
103 /* * Enable xdb commands if set. */
104 extern int xdb_commands;
106 /* * Enable dbx commands if set. */
107 extern int dbx_commands;
109 /* * System root path, used to find libraries etc. */
110 extern char *gdb_sysroot;
112 /* * GDB datadir, used to store data files. */
113 extern char *gdb_datadir;
115 /* * If non-NULL, the possibly relocated path to python's "lib" directory
116 specified with --with-python. */
117 extern char *python_libdir;
119 /* * Search path for separate debug files. */
120 extern char *debug_file_directory;
122 /* GDB has two methods for handling SIGINT. When immediate_quit is
123 nonzero, a SIGINT results in an immediate longjmp out of the signal
124 handler. Otherwise, SIGINT simply sets a flag; code that might
125 take a long time, and which ought to be interruptible, checks this
126 flag using the QUIT macro.
128 These functions use the extension_language_ops API to allow extension
129 language(s) and GDB SIGINT handling to coexist seamlessly. */
131 /* * Clear the quit flag. */
132 extern void clear_quit_flag (void);
133 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
134 will clear the quit flag as a side effect. */
135 extern int check_quit_flag (void);
136 /* * Set the quit flag. */
137 extern void set_quit_flag (void);
139 /* Flag that function quit should call quit_force. */
140 extern volatile int sync_quit_force_run;
142 extern int immediate_quit;
144 extern void quit (void);
146 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
147 benefits of having a ``QUIT'' macro rather than a function are
148 marginal. If the overhead of a QUIT function call is proving
149 significant then its calling frequency should probably be reduced
150 [kingdon]. A profile analyzing the current situtation is
154 if (check_quit_flag () || sync_quit_force_run) quit (); \
155 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
158 /* * Languages represented in the symbol table and elsewhere.
159 This should probably be in language.h, but since enum's can't
160 be forward declared to satisfy opaque references before their
161 actual definition, needs to be here. */
165 language_unknown, /* Language not known */
166 language_auto, /* Placeholder for automatic setting */
168 language_cplus, /* C++ */
170 language_go, /* Go */
171 language_objc, /* Objective-C */
172 language_java, /* Java */
173 language_fortran, /* Fortran */
174 language_m2, /* Modula-2 */
175 language_asm, /* Assembly language */
176 language_pascal, /* Pascal */
177 language_ada, /* Ada */
178 language_opencl, /* OpenCL */
179 language_minimal, /* All other languages, minimal support only */
187 unspecified_precision
190 /* * A generic, not quite boolean, enumeration. This is used for
191 set/show commands in which the options are on/off/automatic. */
199 /* * Potential ways that a function can return a value of a given
202 enum return_value_convention
204 /* * Where the return value has been squeezed into one or more
206 RETURN_VALUE_REGISTER_CONVENTION,
207 /* * Commonly known as the "struct return convention". The caller
208 passes an additional hidden first parameter to the caller. That
209 parameter contains the address at which the value being returned
210 should be stored. While typically, and historically, used for
211 large structs, this is convention is applied to values of many
213 RETURN_VALUE_STRUCT_CONVENTION,
214 /* * Like the "struct return convention" above, but where the ABI
215 guarantees that the called function stores the address at which
216 the value being returned is stored in a well-defined location,
217 such as a register or memory slot in the stack frame. Don't use
218 this if the ABI doesn't explicitly guarantees this. */
219 RETURN_VALUE_ABI_RETURNS_ADDRESS,
220 /* * Like the "struct return convention" above, but where the ABI
221 guarantees that the address at which the value being returned is
222 stored will be available in a well-defined location, such as a
223 register or memory slot in the stack frame. Don't use this if
224 the ABI doesn't explicitly guarantees this. */
225 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
228 /* Needed for various prototypes */
238 /* This really belong in utils.c (path-utils.c?), but it references some
239 globals that are currently only available to main.c. */
240 extern char *relocate_gdb_directory (const char *initial, int flag);
243 /* Annotation stuff. */
245 extern int annotation_level; /* in stack.c */
248 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
249 "const char *" in unistd.h, so we can't declare the argument
252 extern char *re_comp (const char *);
256 extern void symbol_file_command (char *, int);
258 /* * Remote targets may wish to use this as their load function. */
259 extern void generic_load (const char *name, int from_tty);
261 /* * Report on STREAM the performance of memory transfer operation,
263 @param DATA_COUNT is the number of bytes transferred.
264 @param WRITE_COUNT is the number of separate write operations, or 0,
265 if that information is not available.
266 @param START_TIME is the time at which an operation was started.
267 @param END_TIME is the time at which an operation ended. */
269 extern void print_transfer_performance (struct ui_file *stream,
270 unsigned long data_count,
271 unsigned long write_count,
272 const struct timeval *start_time,
273 const struct timeval *end_time);
277 typedef void initialize_file_ftype (void);
279 extern char *gdb_readline (const char *);
281 extern char *gdb_readline_wrapper (const char *);
283 extern char *command_line_input (const char *, int, char *);
285 extern void print_prompt (void);
287 extern int input_from_terminal_p (void);
289 extern int info_verbose;
291 /* From printcmd.c */
293 extern void set_next_address (struct gdbarch *, CORE_ADDR);
295 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
296 struct ui_file *, int, char *);
298 extern int build_address_symbolic (struct gdbarch *,
307 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
308 extern const char *pc_prefix (CORE_ADDR);
312 /* See openp function definition for their description. */
313 #define OPF_TRY_CWD_FIRST 0x01
314 #define OPF_SEARCH_IN_PATH 0x02
315 #define OPF_RETURN_REALPATH 0x04
317 extern int openp (const char *, int, const char *, int, char **);
319 extern int source_full_path_of (const char *, char **);
321 extern void mod_path (char *, char **);
323 extern void add_path (char *, char **, int);
325 extern void directory_switch (char *, int);
327 extern char *source_path;
329 extern void init_source_path (void);
333 /* * Process memory area starting at ADDR with length SIZE. Area is
334 readable iff READ is non-zero, writable if WRITE is non-zero,
335 executable if EXEC is non-zero. Area is possibly changed against
336 its original file based copy if MODIFIED is non-zero. DATA is
337 passed without changes from a caller. */
339 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
340 int read, int write, int exec,
341 int modified, void *data);
343 /* * Possible lvalue types. Like enum language, this should be in
344 value.h, but needs to be here for the same reason. */
352 /* * In a register. Registers are relative to a frame. */
354 /* * In a gdb internal variable. */
356 /* * Value encapsulates a callable defined in an extension language. */
358 /* * Part of a gdb internal variable (structure field). */
359 lval_internalvar_component,
360 /* * Value's bits are fetched and stored using functions provided
365 /* * Control types for commands. */
367 enum misc_command_type
375 enum command_control_type
386 while_stepping_control,
390 /* * Structure for saved commands lines (for breakpoints, defined
395 struct command_line *next;
397 enum command_control_type control_type;
402 enum compile_i_scope_types scope;
407 /* * The number of elements in body_list. */
409 /* * For composite commands, the nested lists of commands. For
410 example, for "if" command this will contain the then branch and
411 the else branch, if that is available. */
412 struct command_line **body_list;
415 extern struct command_line *read_command_lines (char *, int, int,
416 void (*)(char *, void *),
418 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
419 void (*)(char *, void *),
422 extern void free_command_lines (struct command_line **);
424 /* * Parameters of the "info proc" command. */
428 /* * Display the default cmdline, cwd and exe outputs. */
431 /* * Display `info proc mappings'. */
434 /* * Display `info proc status'. */
437 /* * Display `info proc stat'. */
440 /* * Display `info proc cmdline'. */
443 /* * Display `info proc exe'. */
446 /* * Display `info proc cwd'. */
449 /* * Display all of the above. */
453 /* * String containing the current directory (what getwd would return). */
455 extern char *current_directory;
457 /* * Default radixes for input and output. Only some values supported. */
458 extern unsigned input_radix;
459 extern unsigned output_radix;
461 /* * Possibilities for prettyformat parameters to routines which print
462 things. Like enum language, this should be in value.h, but needs
463 to be here for the same reason. FIXME: If we can eliminate this
464 as an arg to LA_VAL_PRINT, then we can probably move it back to
467 enum val_prettyformat
469 Val_no_prettyformat = 0,
471 /* * Use the default setting which the user has specified. */
472 Val_prettyformat_default
475 /* * Optional native machine support. Non-native (and possibly pure
476 multi-arch) targets do not need a "nm.h" file. This will be a
477 symlink to one of the nm-*.h files, built by the `configure'
484 /* Assume that fopen accepts the letter "b" in the mode string.
485 It is demanded by ISO C9X, and should be supported on all
486 platforms that claim to have a standard-conforming C library. On
487 true POSIX systems it will be ignored and have no effect. There
488 may still be systems without a standard-conforming C library where
489 an ISO C9X compiler (GCC) is available. Known examples are SunOS
490 4.x and 4.3BSD. This assumption means these systems are no longer
493 # include "fopen-bin.h"
496 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
497 FIXME: Assumes 2's complement arithmetic. */
499 #if !defined (UINT_MAX)
500 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
503 #if !defined (INT_MAX)
504 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
507 #if !defined (INT_MIN)
508 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
511 #if !defined (ULONG_MAX)
512 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
515 #if !defined (LONG_MAX)
516 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
519 #if !defined (ULONGEST_MAX)
520 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
523 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
524 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
527 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
528 arguments to a function, number in a value history, register number, etc.)
529 where the value must not be larger than can fit in an int. */
531 extern int longest_to_int (LONGEST);
533 /* * List of known OS ABIs. If you change this, make sure to update the
537 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
539 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
545 GDB_OSABI_FREEBSD_AOUT,
546 GDB_OSABI_FREEBSD_ELF,
547 GDB_OSABI_NETBSD_AOUT,
548 GDB_OSABI_NETBSD_ELF,
549 GDB_OSABI_OPENBSD_ELF,
566 GDB_OSABI_INVALID /* keep this last */
569 /* Global functions from other, non-gdb GNU thingies.
570 Libiberty thingies are no longer declared here. We include libiberty.h
573 /* From other system libraries */
576 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
579 /* Dynamic target-system-dependent parameters for GDB. */
582 /* * Maximum size of a register. Something small, but large enough for
583 all known ISAs. If it turns out to be too small, make it bigger. */
585 enum { MAX_REGISTER_SIZE = 64 };
587 /* Static target-system-dependent parameters for GDB. */
589 /* * Number of bits in a char or unsigned char for the target machine.
590 Just like CHAR_BIT in <limits.h> but describes the target machine. */
591 #if !defined (TARGET_CHAR_BIT)
592 #define TARGET_CHAR_BIT 8
595 /* * If we picked up a copy of CHAR_BIT from a configuration file
596 (which may get it by including <limits.h>) then use it to set
597 the number of bits in a host char. If not, use the same size
600 #if defined (CHAR_BIT)
601 #define HOST_CHAR_BIT CHAR_BIT
603 #define HOST_CHAR_BIT TARGET_CHAR_BIT
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 /* If a given interpreter matches INTERPRETER_P then it should update
640 deprecated_init_ui_hook with the per-interpreter implementation. */
641 /* FIXME: deprecated_init_ui_hook should be moved here. */
643 struct target_waitstatus;
644 struct cmd_list_element;
646 extern void (*deprecated_pre_add_symbol_hook) (const char *);
647 extern void (*deprecated_post_add_symbol_hook) (void);
648 extern void (*selected_frame_level_changed_hook) (int);
649 extern int (*deprecated_ui_loop_hook) (int signo);
650 extern void (*deprecated_init_ui_hook) (char *argv0);
651 extern void (*deprecated_show_load_progress) (const char *section,
652 unsigned long section_sent,
653 unsigned long section_size,
654 unsigned long total_sent,
655 unsigned long total_size);
656 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
660 extern int (*deprecated_query_hook) (const char *, va_list)
661 ATTRIBUTE_FPTR_PRINTF(1,0);
662 extern void (*deprecated_warning_hook) (const char *, va_list)
663 ATTRIBUTE_FPTR_PRINTF(1,0);
664 extern void (*deprecated_interactive_hook) (void);
665 extern void (*deprecated_readline_begin_hook) (char *, ...)
666 ATTRIBUTE_FPTR_PRINTF_1;
667 extern char *(*deprecated_readline_hook) (const char *);
668 extern void (*deprecated_readline_end_hook) (void);
669 extern void (*deprecated_register_changed_hook) (int regno);
670 extern void (*deprecated_context_hook) (int);
671 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
672 struct target_waitstatus *status,
675 extern void (*deprecated_attach_hook) (void);
676 extern void (*deprecated_detach_hook) (void);
677 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
678 char *cmd, int from_tty);
680 extern int (*deprecated_ui_load_progress_hook) (const char *section,
683 /* If this definition isn't overridden by the header files, assume
684 that isatty and fileno exist on this system. */
686 #define ISATTY(FP) (isatty (fileno (FP)))
689 /* * A width that can achieve a better legibility for GDB MI mode. */
690 #define GDB_MI_MSG_WIDTH 80
692 /* From progspace.c */
694 extern void initialize_progspace (void);
695 extern void initialize_inferiors (void);
697 /* * Special block numbers */
703 FIRST_LOCAL_BLOCK = 2
708 #endif /* #ifndef DEFS_H */