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 "config.h" /* Generated by configure. */
29 #include "build-gnulib/config.h"
31 #include <sys/types.h>
33 #include <errno.h> /* System call error return status. */
37 /* The libdecnumber library, on which GDB depends, includes a header file
38 called gstdint.h instead of relying directly on stdint.h. GDB, on the
39 other hand, includes stdint.h directly, relying on the fact that gnulib
40 generates a copy if the system doesn't provide one or if it is missing
41 some features. Unfortunately, gstdint.h and stdint.h cannot be included
42 at the same time, which may happen when we include a file from
45 The following macro definition effectively prevents the inclusion of
46 gstdint.h, as all the definitions it provides are guarded against
47 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
48 included, so it's ok to blank out gstdint.h. */
49 #define GCC_GENERATED_STDINT_H 1
55 /* For gnulib's PATH_MAX. */
60 /* First include ansidecl.h so we can use the various macro definitions
61 here and in all subsequent file inclusions. */
65 #include "gdb_locale.h"
67 #include "gdb_wchar.h"
69 /* For ``enum gdb_signal''. */
70 #include "gdb/signals.h"
74 #include "host-defs.h"
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. */
95 #include <stdarg.h> /* For va_list. */
97 #include "libiberty.h"
100 /* Rather than duplicate all the logic in BFD for figuring out what
101 types to use (which can be pretty complicated), symply define them
102 in terms of the corresponding type from BFD. */
106 /* * A byte from the program being debugged. */
107 typedef bfd_byte gdb_byte;
109 /* * An address in the program being debugged. Host byte order. */
110 typedef bfd_vma CORE_ADDR;
112 /* * The largest CORE_ADDR value. */
113 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
115 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
119 #define LONGEST BFD_HOST_64_BIT
120 #define ULONGEST BFD_HOST_U_64_BIT
124 #define LONGEST long long
125 #define ULONGEST unsigned long long
127 #endif /* No BFD64 */
130 #define min(a, b) ((a) < (b) ? (a) : (b))
133 #define max(a, b) ((a) > (b) ? (a) : (b))
138 /* * Enable xdb commands if set. */
139 extern int xdb_commands;
141 /* * Enable dbx commands if set. */
142 extern int dbx_commands;
144 /* * System root path, used to find libraries etc. */
145 extern char *gdb_sysroot;
147 /* * GDB datadir, used to store data files. */
148 extern char *gdb_datadir;
150 /* * If non-NULL, the possibly relocated path to python's "lib" directory
151 specified with --with-python. */
152 extern char *python_libdir;
154 /* * Search path for separate debug files. */
155 extern char *debug_file_directory;
157 /* GDB has two methods for handling SIGINT. When immediate_quit is
158 nonzero, a SIGINT results in an immediate longjmp out of the signal
159 handler. Otherwise, SIGINT simply sets a flag; code that might
160 take a long time, and which ought to be interruptible, checks this
161 flag using the QUIT macro.
163 These functions use the extension_language_ops API to allow extension
164 language(s) and GDB SIGINT handling to coexist seamlessly. */
166 /* * Clear the quit flag. */
167 extern void clear_quit_flag (void);
168 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
169 will clear the quit flag as a side effect. */
170 extern int check_quit_flag (void);
171 /* * Set the quit flag. */
172 extern void set_quit_flag (void);
174 extern int immediate_quit;
176 extern void quit (void);
178 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
179 benefits of having a ``QUIT'' macro rather than a function are
180 marginal. If the overhead of a QUIT function call is proving
181 significant then its calling frequency should probably be reduced
182 [kingdon]. A profile analyzing the current situtation is
186 if (check_quit_flag ()) quit (); \
187 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
190 /* * Languages represented in the symbol table and elsewhere.
191 This should probably be in language.h, but since enum's can't
192 be forward declared to satisfy opaque references before their
193 actual definition, needs to be here. */
197 language_unknown, /* Language not known */
198 language_auto, /* Placeholder for automatic setting */
200 language_cplus, /* C++ */
202 language_go, /* Go */
203 language_objc, /* Objective-C */
204 language_java, /* Java */
205 language_fortran, /* Fortran */
206 language_m2, /* Modula-2 */
207 language_asm, /* Assembly language */
208 language_pascal, /* Pascal */
209 language_ada, /* Ada */
210 language_opencl, /* OpenCL */
211 language_minimal, /* All other languages, minimal support only */
219 unspecified_precision
222 /* * A generic, not quite boolean, enumeration. This is used for
223 set/show commands in which the options are on/off/automatic. */
231 /* * Potential ways that a function can return a value of a given
234 enum return_value_convention
236 /* * Where the return value has been squeezed into one or more
238 RETURN_VALUE_REGISTER_CONVENTION,
239 /* * Commonly known as the "struct return convention". The caller
240 passes an additional hidden first parameter to the caller. That
241 parameter contains the address at which the value being returned
242 should be stored. While typically, and historically, used for
243 large structs, this is convention is applied to values of many
245 RETURN_VALUE_STRUCT_CONVENTION,
246 /* * Like the "struct return convention" above, but where the ABI
247 guarantees that the called function stores the address at which
248 the value being returned is stored in a well-defined location,
249 such as a register or memory slot in the stack frame. Don't use
250 this if the ABI doesn't explicitly guarantees this. */
251 RETURN_VALUE_ABI_RETURNS_ADDRESS,
252 /* * Like the "struct return convention" above, but where the ABI
253 guarantees that the address at which the value being returned is
254 stored will be available in a well-defined location, such as a
255 register or memory slot in the stack frame. Don't use this if
256 the ABI doesn't explicitly guarantees this. */
257 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
260 /* Needed for various prototypes */
270 /* This really belong in utils.c (path-utils.c?), but it references some
271 globals that are currently only available to main.c. */
272 extern char *relocate_gdb_directory (const char *initial, int flag);
275 /* Annotation stuff. */
277 extern int annotation_level; /* in stack.c */
280 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
281 "const char *" in unistd.h, so we can't declare the argument
284 extern char *re_comp (const char *);
288 extern void symbol_file_command (char *, int);
290 /* * Remote targets may wish to use this as their load function. */
291 extern void generic_load (char *name, int from_tty);
293 /* * Report on STREAM the performance of memory transfer operation,
295 @param DATA_COUNT is the number of bytes transferred.
296 @param WRITE_COUNT is the number of separate write operations, or 0,
297 if that information is not available.
298 @param START_TIME is the time at which an operation was started.
299 @param END_TIME is the time at which an operation ended. */
301 extern void print_transfer_performance (struct ui_file *stream,
302 unsigned long data_count,
303 unsigned long write_count,
304 const struct timeval *start_time,
305 const struct timeval *end_time);
309 typedef void initialize_file_ftype (void);
311 extern char *gdb_readline (char *);
313 extern char *gdb_readline_wrapper (char *);
315 extern char *command_line_input (char *, int, char *);
317 extern void print_prompt (void);
319 extern int input_from_terminal_p (void);
321 extern int info_verbose;
323 /* From printcmd.c */
325 extern void set_next_address (struct gdbarch *, CORE_ADDR);
327 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
328 struct ui_file *, int, char *);
330 extern int build_address_symbolic (struct gdbarch *,
339 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
340 extern const char *pc_prefix (CORE_ADDR);
344 /* See openp function definition for their description. */
345 #define OPF_TRY_CWD_FIRST 0x01
346 #define OPF_SEARCH_IN_PATH 0x02
347 #define OPF_RETURN_REALPATH 0x04
349 extern int openp (const char *, int, const char *, int, char **);
351 extern int source_full_path_of (const char *, char **);
353 extern void mod_path (char *, char **);
355 extern void add_path (char *, char **, int);
357 extern void directory_switch (char *, int);
359 extern char *source_path;
361 extern void init_source_path (void);
365 /* * Process memory area starting at ADDR with length SIZE. Area is
366 readable iff READ is non-zero, writable if WRITE is non-zero,
367 executable if EXEC is non-zero. Area is possibly changed against
368 its original file based copy if MODIFIED is non-zero. DATA is
369 passed without changes from a caller. */
371 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
372 int read, int write, int exec,
373 int modified, void *data);
375 /* * Possible lvalue types. Like enum language, this should be in
376 value.h, but needs to be here for the same reason. */
384 /* * In a register. Registers are relative to a frame. */
386 /* * In a gdb internal variable. */
388 /* * Part of a gdb internal variable (structure field). */
389 lval_internalvar_component,
390 /* * Value's bits are fetched and stored using functions provided
395 /* * Control types for commands. */
397 enum misc_command_type
405 enum command_control_type
415 while_stepping_control,
419 /* * Structure for saved commands lines (for breakpoints, defined
424 struct command_line *next;
426 enum command_control_type control_type;
427 /* * The number of elements in body_list. */
429 /* * For composite commands, the nested lists of commands. For
430 example, for "if" command this will contain the then branch and
431 the else branch, if that is available. */
432 struct command_line **body_list;
435 extern struct command_line *read_command_lines (char *, int, int,
436 void (*)(char *, void *),
438 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
439 void (*)(char *, void *),
442 extern void free_command_lines (struct command_line **);
444 /* * Parameters of the "info proc" command. */
448 /* * Display the default cmdline, cwd and exe outputs. */
451 /* * Display `info proc mappings'. */
454 /* * Display `info proc status'. */
457 /* * Display `info proc stat'. */
460 /* * Display `info proc cmdline'. */
463 /* * Display `info proc exe'. */
466 /* * Display `info proc cwd'. */
469 /* * Display all of the above. */
473 /* * String containing the current directory (what getwd would return). */
475 extern char *current_directory;
477 /* * Default radixes for input and output. Only some values supported. */
478 extern unsigned input_radix;
479 extern unsigned output_radix;
481 /* * Possibilities for prettyformat parameters to routines which print
482 things. Like enum language, this should be in value.h, but needs
483 to be here for the same reason. FIXME: If we can eliminate this
484 as an arg to LA_VAL_PRINT, then we can probably move it back to
487 enum val_prettyformat
489 Val_no_prettyformat = 0,
491 /* * Use the default setting which the user has specified. */
492 Val_prettyformat_default
495 /* * Optional native machine support. Non-native (and possibly pure
496 multi-arch) targets do not need a "nm.h" file. This will be a
497 symlink to one of the nm-*.h files, built by the `configure'
504 /* Assume that fopen accepts the letter "b" in the mode string.
505 It is demanded by ISO C9X, and should be supported on all
506 platforms that claim to have a standard-conforming C library. On
507 true POSIX systems it will be ignored and have no effect. There
508 may still be systems without a standard-conforming C library where
509 an ISO C9X compiler (GCC) is available. Known examples are SunOS
510 4.x and 4.3BSD. This assumption means these systems are no longer
513 # include "fopen-bin.h"
516 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
517 FIXME: Assumes 2's complement arithmetic. */
519 #if !defined (UINT_MAX)
520 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
523 #if !defined (INT_MAX)
524 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
527 #if !defined (INT_MIN)
528 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
531 #if !defined (ULONG_MAX)
532 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
535 #if !defined (LONG_MAX)
536 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
539 #if !defined (ULONGEST_MAX)
540 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
543 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
544 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
547 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
548 arguments to a function, number in a value history, register number, etc.)
549 where the value must not be larger than can fit in an int. */
551 extern int longest_to_int (LONGEST);
553 #include "common-utils.h"
555 /* * List of known OS ABIs. If you change this, make sure to update the
559 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
561 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
568 GDB_OSABI_FREEBSD_AOUT,
569 GDB_OSABI_FREEBSD_ELF,
570 GDB_OSABI_NETBSD_AOUT,
571 GDB_OSABI_NETBSD_ELF,
572 GDB_OSABI_OPENBSD_ELF,
588 GDB_OSABI_INVALID /* keep this last */
591 /* Global functions from other, non-gdb GNU thingies.
592 Libiberty thingies are no longer declared here. We include libiberty.h
595 /* From other system libraries */
601 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
604 /* Various possibilities for alloca. */
607 #define alloca __builtin_alloca
608 #else /* Not GNU C */
616 /* We need to be careful not to declare this in a way which conflicts with
617 bison. Bison never declares it as char *, but under various circumstances
618 (like __hpux) we need to use void *. */
619 extern void *alloca ();
620 #endif /* Not _AIX */
621 #endif /* Not HAVE_ALLOCA_H */
622 #endif /* Not GNU C */
623 #endif /* alloca not defined */
625 /* Dynamic target-system-dependent parameters for GDB. */
628 /* * Maximum size of a register. Something small, but large enough for
629 all known ISAs. If it turns out to be too small, make it bigger. */
631 enum { MAX_REGISTER_SIZE = 64 };
633 /* Static target-system-dependent parameters for GDB. */
635 /* * Number of bits in a char or unsigned char for the target machine.
636 Just like CHAR_BIT in <limits.h> but describes the target machine. */
637 #if !defined (TARGET_CHAR_BIT)
638 #define TARGET_CHAR_BIT 8
641 /* * If we picked up a copy of CHAR_BIT from a configuration file
642 (which may get it by including <limits.h>) then use it to set
643 the number of bits in a host char. If not, use the same size
646 #if defined (CHAR_BIT)
647 #define HOST_CHAR_BIT CHAR_BIT
649 #define HOST_CHAR_BIT TARGET_CHAR_BIT
654 extern LONGEST extract_signed_integer (const gdb_byte *, int,
657 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
660 extern int extract_long_unsigned_integer (const gdb_byte *, int,
661 enum bfd_endian, LONGEST *);
663 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
666 extern void store_signed_integer (gdb_byte *, int,
667 enum bfd_endian, LONGEST);
669 extern void store_unsigned_integer (gdb_byte *, int,
670 enum bfd_endian, ULONGEST);
672 extern void store_typed_address (gdb_byte *buf, struct type *type,
680 /* Hooks for alternate command interfaces. */
682 /* * The name of the interpreter if specified on the command line. */
683 extern char *interpreter_p;
685 /* If a given interpreter matches INTERPRETER_P then it should update
686 deprecated_init_ui_hook with the per-interpreter implementation. */
687 /* FIXME: deprecated_init_ui_hook should be moved here. */
689 struct target_waitstatus;
690 struct cmd_list_element;
692 extern void (*deprecated_pre_add_symbol_hook) (const char *);
693 extern void (*deprecated_post_add_symbol_hook) (void);
694 extern void (*selected_frame_level_changed_hook) (int);
695 extern int (*deprecated_ui_loop_hook) (int signo);
696 extern void (*deprecated_init_ui_hook) (char *argv0);
697 extern void (*deprecated_show_load_progress) (const char *section,
698 unsigned long section_sent,
699 unsigned long section_size,
700 unsigned long total_sent,
701 unsigned long total_size);
702 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
706 extern int (*deprecated_query_hook) (const char *, va_list)
707 ATTRIBUTE_FPTR_PRINTF(1,0);
708 extern void (*deprecated_warning_hook) (const char *, va_list)
709 ATTRIBUTE_FPTR_PRINTF(1,0);
710 extern void (*deprecated_interactive_hook) (void);
711 extern void (*deprecated_readline_begin_hook) (char *, ...)
712 ATTRIBUTE_FPTR_PRINTF_1;
713 extern char *(*deprecated_readline_hook) (char *);
714 extern void (*deprecated_readline_end_hook) (void);
715 extern void (*deprecated_register_changed_hook) (int regno);
716 extern void (*deprecated_context_hook) (int);
717 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
718 struct target_waitstatus *status,
721 extern void (*deprecated_attach_hook) (void);
722 extern void (*deprecated_detach_hook) (void);
723 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
724 char *cmd, int from_tty);
726 extern int (*deprecated_ui_load_progress_hook) (const char *section,
729 /* If this definition isn't overridden by the header files, assume
730 that isatty and fileno exist on this system. */
732 #define ISATTY(FP) (isatty (fileno (FP)))
735 /* * A width that can achieve a better legibility for GDB MI mode. */
736 #define GDB_MI_MSG_WIDTH 80
738 /* From progspace.c */
740 extern void initialize_progspace (void);
741 extern void initialize_inferiors (void);
743 /* * Special block numbers */
749 FIRST_LOCAL_BLOCK = 2
754 #endif /* #ifndef DEFS_H */