1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
3 /* Basic, host-specific, and target-specific definitions for GDB.
4 Copyright (C) 1986-2014 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 /* Just in case they're not defined in stdio.h. */
67 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
68 It is used as an access modifier in calls to open(), where it acts
69 similarly to the "b" character in fopen()'s MODE argument. On Posix
70 platforms it should be a no-op, so it is defined as 0 here. This
71 ensures that the symbol may be used freely elsewhere in gdb. */
80 #define min(a, b) ((a) < (b) ? (a) : (b))
83 #define max(a, b) ((a) > (b) ? (a) : (b))
86 /* * Enable xdb commands if set. */
87 extern int xdb_commands;
89 /* * Enable dbx commands if set. */
90 extern int dbx_commands;
92 /* * System root path, used to find libraries etc. */
93 extern char *gdb_sysroot;
95 /* * GDB datadir, used to store data files. */
96 extern char *gdb_datadir;
98 /* * If non-NULL, the possibly relocated path to python's "lib" directory
99 specified with --with-python. */
100 extern char *python_libdir;
102 /* * Search path for separate debug files. */
103 extern char *debug_file_directory;
105 /* GDB has two methods for handling SIGINT. When immediate_quit is
106 nonzero, a SIGINT results in an immediate longjmp out of the signal
107 handler. Otherwise, SIGINT simply sets a flag; code that might
108 take a long time, and which ought to be interruptible, checks this
109 flag using the QUIT macro.
111 These functions use the extension_language_ops API to allow extension
112 language(s) and GDB SIGINT handling to coexist seamlessly. */
114 /* * Clear the quit flag. */
115 extern void clear_quit_flag (void);
116 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
117 will clear the quit flag as a side effect. */
118 extern int check_quit_flag (void);
119 /* * Set the quit flag. */
120 extern void set_quit_flag (void);
122 /* Flag that function quit should call quit_force. */
123 extern volatile int sync_quit_force_run;
125 extern int immediate_quit;
127 extern void quit (void);
129 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
130 benefits of having a ``QUIT'' macro rather than a function are
131 marginal. If the overhead of a QUIT function call is proving
132 significant then its calling frequency should probably be reduced
133 [kingdon]. A profile analyzing the current situtation is
137 if (check_quit_flag () || sync_quit_force_run) quit (); \
138 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
141 /* * Languages represented in the symbol table and elsewhere.
142 This should probably be in language.h, but since enum's can't
143 be forward declared to satisfy opaque references before their
144 actual definition, needs to be here. */
148 language_unknown, /* Language not known */
149 language_auto, /* Placeholder for automatic setting */
151 language_cplus, /* C++ */
153 language_go, /* Go */
154 language_objc, /* Objective-C */
155 language_java, /* Java */
156 language_fortran, /* Fortran */
157 language_m2, /* Modula-2 */
158 language_asm, /* Assembly language */
159 language_pascal, /* Pascal */
160 language_ada, /* Ada */
161 language_opencl, /* OpenCL */
162 language_minimal, /* All other languages, minimal support only */
170 unspecified_precision
173 /* * A generic, not quite boolean, enumeration. This is used for
174 set/show commands in which the options are on/off/automatic. */
182 /* * Potential ways that a function can return a value of a given
185 enum return_value_convention
187 /* * Where the return value has been squeezed into one or more
189 RETURN_VALUE_REGISTER_CONVENTION,
190 /* * Commonly known as the "struct return convention". The caller
191 passes an additional hidden first parameter to the caller. That
192 parameter contains the address at which the value being returned
193 should be stored. While typically, and historically, used for
194 large structs, this is convention is applied to values of many
196 RETURN_VALUE_STRUCT_CONVENTION,
197 /* * Like the "struct return convention" above, but where the ABI
198 guarantees that the called function stores the address at which
199 the value being returned is stored in a well-defined location,
200 such as a register or memory slot in the stack frame. Don't use
201 this if the ABI doesn't explicitly guarantees this. */
202 RETURN_VALUE_ABI_RETURNS_ADDRESS,
203 /* * Like the "struct return convention" above, but where the ABI
204 guarantees that the address at which the value being returned is
205 stored will be available in a well-defined location, such as a
206 register or memory slot in the stack frame. Don't use this if
207 the ABI doesn't explicitly guarantees this. */
208 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
211 /* Needed for various prototypes */
221 /* This really belong in utils.c (path-utils.c?), but it references some
222 globals that are currently only available to main.c. */
223 extern char *relocate_gdb_directory (const char *initial, int flag);
226 /* Annotation stuff. */
228 extern int annotation_level; /* in stack.c */
231 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
232 "const char *" in unistd.h, so we can't declare the argument
235 extern char *re_comp (const char *);
239 extern void symbol_file_command (char *, int);
241 /* * Remote targets may wish to use this as their load function. */
242 extern void generic_load (const char *name, int from_tty);
244 /* * Report on STREAM the performance of memory transfer operation,
246 @param DATA_COUNT is the number of bytes transferred.
247 @param WRITE_COUNT is the number of separate write operations, or 0,
248 if that information is not available.
249 @param START_TIME is the time at which an operation was started.
250 @param END_TIME is the time at which an operation ended. */
252 extern void print_transfer_performance (struct ui_file *stream,
253 unsigned long data_count,
254 unsigned long write_count,
255 const struct timeval *start_time,
256 const struct timeval *end_time);
260 typedef void initialize_file_ftype (void);
262 extern char *gdb_readline (char *);
264 extern char *gdb_readline_wrapper (char *);
266 extern char *command_line_input (char *, int, char *);
268 extern void print_prompt (void);
270 extern int input_from_terminal_p (void);
272 extern int info_verbose;
274 /* From printcmd.c */
276 extern void set_next_address (struct gdbarch *, CORE_ADDR);
278 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
279 struct ui_file *, int, char *);
281 extern int build_address_symbolic (struct gdbarch *,
290 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
291 extern const char *pc_prefix (CORE_ADDR);
295 /* See openp function definition for their description. */
296 #define OPF_TRY_CWD_FIRST 0x01
297 #define OPF_SEARCH_IN_PATH 0x02
298 #define OPF_RETURN_REALPATH 0x04
300 extern int openp (const char *, int, const char *, int, char **);
302 extern int source_full_path_of (const char *, char **);
304 extern void mod_path (char *, char **);
306 extern void add_path (char *, char **, int);
308 extern void directory_switch (char *, int);
310 extern char *source_path;
312 extern void init_source_path (void);
316 /* * Process memory area starting at ADDR with length SIZE. Area is
317 readable iff READ is non-zero, writable if WRITE is non-zero,
318 executable if EXEC is non-zero. Area is possibly changed against
319 its original file based copy if MODIFIED is non-zero. DATA is
320 passed without changes from a caller. */
322 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
323 int read, int write, int exec,
324 int modified, void *data);
326 /* * Possible lvalue types. Like enum language, this should be in
327 value.h, but needs to be here for the same reason. */
335 /* * In a register. Registers are relative to a frame. */
337 /* * In a gdb internal variable. */
339 /* * Value encapsulates a callable defined in an extension language. */
341 /* * Part of a gdb internal variable (structure field). */
342 lval_internalvar_component,
343 /* * Value's bits are fetched and stored using functions provided
348 /* * Control types for commands. */
350 enum misc_command_type
358 enum command_control_type
368 while_stepping_control,
372 /* * Structure for saved commands lines (for breakpoints, defined
377 struct command_line *next;
379 enum command_control_type control_type;
380 /* * The number of elements in body_list. */
382 /* * For composite commands, the nested lists of commands. For
383 example, for "if" command this will contain the then branch and
384 the else branch, if that is available. */
385 struct command_line **body_list;
388 extern struct command_line *read_command_lines (char *, int, int,
389 void (*)(char *, void *),
391 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
392 void (*)(char *, void *),
395 extern void free_command_lines (struct command_line **);
397 /* * Parameters of the "info proc" command. */
401 /* * Display the default cmdline, cwd and exe outputs. */
404 /* * Display `info proc mappings'. */
407 /* * Display `info proc status'. */
410 /* * Display `info proc stat'. */
413 /* * Display `info proc cmdline'. */
416 /* * Display `info proc exe'. */
419 /* * Display `info proc cwd'. */
422 /* * Display all of the above. */
426 /* * String containing the current directory (what getwd would return). */
428 extern char *current_directory;
430 /* * Default radixes for input and output. Only some values supported. */
431 extern unsigned input_radix;
432 extern unsigned output_radix;
434 /* * Possibilities for prettyformat parameters to routines which print
435 things. Like enum language, this should be in value.h, but needs
436 to be here for the same reason. FIXME: If we can eliminate this
437 as an arg to LA_VAL_PRINT, then we can probably move it back to
440 enum val_prettyformat
442 Val_no_prettyformat = 0,
444 /* * Use the default setting which the user has specified. */
445 Val_prettyformat_default
448 /* * Optional native machine support. Non-native (and possibly pure
449 multi-arch) targets do not need a "nm.h" file. This will be a
450 symlink to one of the nm-*.h files, built by the `configure'
457 /* Assume that fopen accepts the letter "b" in the mode string.
458 It is demanded by ISO C9X, and should be supported on all
459 platforms that claim to have a standard-conforming C library. On
460 true POSIX systems it will be ignored and have no effect. There
461 may still be systems without a standard-conforming C library where
462 an ISO C9X compiler (GCC) is available. Known examples are SunOS
463 4.x and 4.3BSD. This assumption means these systems are no longer
466 # include "fopen-bin.h"
469 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
470 FIXME: Assumes 2's complement arithmetic. */
472 #if !defined (UINT_MAX)
473 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
476 #if !defined (INT_MAX)
477 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
480 #if !defined (INT_MIN)
481 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
484 #if !defined (ULONG_MAX)
485 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
488 #if !defined (LONG_MAX)
489 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
492 #if !defined (ULONGEST_MAX)
493 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
496 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
497 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
500 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
501 arguments to a function, number in a value history, register number, etc.)
502 where the value must not be larger than can fit in an int. */
504 extern int longest_to_int (LONGEST);
506 /* * List of known OS ABIs. If you change this, make sure to update the
510 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
512 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
518 GDB_OSABI_FREEBSD_AOUT,
519 GDB_OSABI_FREEBSD_ELF,
520 GDB_OSABI_NETBSD_AOUT,
521 GDB_OSABI_NETBSD_ELF,
522 GDB_OSABI_OPENBSD_ELF,
538 GDB_OSABI_INVALID /* keep this last */
541 /* Global functions from other, non-gdb GNU thingies.
542 Libiberty thingies are no longer declared here. We include libiberty.h
545 /* From other system libraries */
548 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
551 /* Dynamic target-system-dependent parameters for GDB. */
554 /* * Maximum size of a register. Something small, but large enough for
555 all known ISAs. If it turns out to be too small, make it bigger. */
557 enum { MAX_REGISTER_SIZE = 64 };
559 /* Static target-system-dependent parameters for GDB. */
561 /* * Number of bits in a char or unsigned char for the target machine.
562 Just like CHAR_BIT in <limits.h> but describes the target machine. */
563 #if !defined (TARGET_CHAR_BIT)
564 #define TARGET_CHAR_BIT 8
567 /* * If we picked up a copy of CHAR_BIT from a configuration file
568 (which may get it by including <limits.h>) then use it to set
569 the number of bits in a host char. If not, use the same size
572 #if defined (CHAR_BIT)
573 #define HOST_CHAR_BIT CHAR_BIT
575 #define HOST_CHAR_BIT TARGET_CHAR_BIT
580 extern LONGEST extract_signed_integer (const gdb_byte *, int,
583 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
586 extern int extract_long_unsigned_integer (const gdb_byte *, int,
587 enum bfd_endian, LONGEST *);
589 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
592 extern void store_signed_integer (gdb_byte *, int,
593 enum bfd_endian, LONGEST);
595 extern void store_unsigned_integer (gdb_byte *, int,
596 enum bfd_endian, ULONGEST);
598 extern void store_typed_address (gdb_byte *buf, struct type *type,
606 /* Hooks for alternate command interfaces. */
608 /* * The name of the interpreter if specified on the command line. */
609 extern char *interpreter_p;
611 /* If a given interpreter matches INTERPRETER_P then it should update
612 deprecated_init_ui_hook with the per-interpreter implementation. */
613 /* FIXME: deprecated_init_ui_hook should be moved here. */
615 struct target_waitstatus;
616 struct cmd_list_element;
618 extern void (*deprecated_pre_add_symbol_hook) (const char *);
619 extern void (*deprecated_post_add_symbol_hook) (void);
620 extern void (*selected_frame_level_changed_hook) (int);
621 extern int (*deprecated_ui_loop_hook) (int signo);
622 extern void (*deprecated_init_ui_hook) (char *argv0);
623 extern void (*deprecated_show_load_progress) (const char *section,
624 unsigned long section_sent,
625 unsigned long section_size,
626 unsigned long total_sent,
627 unsigned long total_size);
628 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
632 extern int (*deprecated_query_hook) (const char *, va_list)
633 ATTRIBUTE_FPTR_PRINTF(1,0);
634 extern void (*deprecated_warning_hook) (const char *, va_list)
635 ATTRIBUTE_FPTR_PRINTF(1,0);
636 extern void (*deprecated_interactive_hook) (void);
637 extern void (*deprecated_readline_begin_hook) (char *, ...)
638 ATTRIBUTE_FPTR_PRINTF_1;
639 extern char *(*deprecated_readline_hook) (char *);
640 extern void (*deprecated_readline_end_hook) (void);
641 extern void (*deprecated_register_changed_hook) (int regno);
642 extern void (*deprecated_context_hook) (int);
643 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
644 struct target_waitstatus *status,
647 extern void (*deprecated_attach_hook) (void);
648 extern void (*deprecated_detach_hook) (void);
649 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
650 char *cmd, int from_tty);
652 extern int (*deprecated_ui_load_progress_hook) (const char *section,
655 /* If this definition isn't overridden by the header files, assume
656 that isatty and fileno exist on this system. */
658 #define ISATTY(FP) (isatty (fileno (FP)))
661 /* * A width that can achieve a better legibility for GDB MI mode. */
662 #define GDB_MI_MSG_WIDTH 80
664 /* From progspace.c */
666 extern void initialize_progspace (void);
667 extern void initialize_inferiors (void);
669 /* * Special block numbers */
675 FIRST_LOCAL_BLOCK = 2
680 #endif /* #ifndef DEFS_H */