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>
31 #include <errno.h> /* System call error return status. */
35 /* The libdecnumber library, on which GDB depends, includes a header file
36 called gstdint.h instead of relying directly on stdint.h. GDB, on the
37 other hand, includes stdint.h directly, relying on the fact that gnulib
38 generates a copy if the system doesn't provide one or if it is missing
39 some features. Unfortunately, gstdint.h and stdint.h cannot be included
40 at the same time, which may happen when we include a file from
43 The following macro definition effectively prevents the inclusion of
44 gstdint.h, as all the definitions it provides are guarded against
45 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
46 included, so it's ok to blank out gstdint.h. */
47 #define GCC_GENERATED_STDINT_H 1
53 #include "gdb_locale.h"
55 #include "gdb_wchar.h"
59 #include "host-defs.h"
61 /* Just in case they're not defined in stdio.h. */
70 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
71 It is used as an access modifier in calls to open(), where it acts
72 similarly to the "b" character in fopen()'s MODE argument. On Posix
73 platforms it should be a no-op, so it is defined as 0 here. This
74 ensures that the symbol may be used freely elsewhere in gdb. */
82 /* Rather than duplicate all the logic in BFD for figuring out what
83 types to use (which can be pretty complicated), symply define them
84 in terms of the corresponding type from BFD. */
88 /* * A byte from the program being debugged. */
89 typedef bfd_byte gdb_byte;
91 /* * An address in the program being debugged. Host byte order. */
92 typedef bfd_vma CORE_ADDR;
94 /* * The largest CORE_ADDR value. */
95 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
97 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
101 #define LONGEST BFD_HOST_64_BIT
102 #define ULONGEST BFD_HOST_U_64_BIT
106 #define LONGEST long long
107 #define ULONGEST unsigned long long
109 #endif /* No BFD64 */
112 #define min(a, b) ((a) < (b) ? (a) : (b))
115 #define max(a, b) ((a) > (b) ? (a) : (b))
120 /* * Enable xdb commands if set. */
121 extern int xdb_commands;
123 /* * Enable dbx commands if set. */
124 extern int dbx_commands;
126 /* * System root path, used to find libraries etc. */
127 extern char *gdb_sysroot;
129 /* * GDB datadir, used to store data files. */
130 extern char *gdb_datadir;
132 /* * If non-NULL, the possibly relocated path to python's "lib" directory
133 specified with --with-python. */
134 extern char *python_libdir;
136 /* * Search path for separate debug files. */
137 extern char *debug_file_directory;
139 /* GDB has two methods for handling SIGINT. When immediate_quit is
140 nonzero, a SIGINT results in an immediate longjmp out of the signal
141 handler. Otherwise, SIGINT simply sets a flag; code that might
142 take a long time, and which ought to be interruptible, checks this
143 flag using the QUIT macro.
145 These functions use the extension_language_ops API to allow extension
146 language(s) and GDB SIGINT handling to coexist seamlessly. */
148 /* * Clear the quit flag. */
149 extern void clear_quit_flag (void);
150 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
151 will clear the quit flag as a side effect. */
152 extern int check_quit_flag (void);
153 /* * Set the quit flag. */
154 extern void set_quit_flag (void);
156 /* Flag that function quit should call quit_force. */
157 extern volatile int sync_quit_force_run;
159 extern int immediate_quit;
161 extern void quit (void);
163 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
164 benefits of having a ``QUIT'' macro rather than a function are
165 marginal. If the overhead of a QUIT function call is proving
166 significant then its calling frequency should probably be reduced
167 [kingdon]. A profile analyzing the current situtation is
171 if (check_quit_flag () || sync_quit_force_run) quit (); \
172 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
175 /* * Languages represented in the symbol table and elsewhere.
176 This should probably be in language.h, but since enum's can't
177 be forward declared to satisfy opaque references before their
178 actual definition, needs to be here. */
182 language_unknown, /* Language not known */
183 language_auto, /* Placeholder for automatic setting */
185 language_cplus, /* C++ */
187 language_go, /* Go */
188 language_objc, /* Objective-C */
189 language_java, /* Java */
190 language_fortran, /* Fortran */
191 language_m2, /* Modula-2 */
192 language_asm, /* Assembly language */
193 language_pascal, /* Pascal */
194 language_ada, /* Ada */
195 language_opencl, /* OpenCL */
196 language_minimal, /* All other languages, minimal support only */
204 unspecified_precision
207 /* * A generic, not quite boolean, enumeration. This is used for
208 set/show commands in which the options are on/off/automatic. */
216 /* * Potential ways that a function can return a value of a given
219 enum return_value_convention
221 /* * Where the return value has been squeezed into one or more
223 RETURN_VALUE_REGISTER_CONVENTION,
224 /* * Commonly known as the "struct return convention". The caller
225 passes an additional hidden first parameter to the caller. That
226 parameter contains the address at which the value being returned
227 should be stored. While typically, and historically, used for
228 large structs, this is convention is applied to values of many
230 RETURN_VALUE_STRUCT_CONVENTION,
231 /* * Like the "struct return convention" above, but where the ABI
232 guarantees that the called function stores the address at which
233 the value being returned is stored in a well-defined location,
234 such as a register or memory slot in the stack frame. Don't use
235 this if the ABI doesn't explicitly guarantees this. */
236 RETURN_VALUE_ABI_RETURNS_ADDRESS,
237 /* * Like the "struct return convention" above, but where the ABI
238 guarantees that the address at which the value being returned is
239 stored will be available in a well-defined location, such as a
240 register or memory slot in the stack frame. Don't use this if
241 the ABI doesn't explicitly guarantees this. */
242 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
245 /* Needed for various prototypes */
255 /* This really belong in utils.c (path-utils.c?), but it references some
256 globals that are currently only available to main.c. */
257 extern char *relocate_gdb_directory (const char *initial, int flag);
260 /* Annotation stuff. */
262 extern int annotation_level; /* in stack.c */
265 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
266 "const char *" in unistd.h, so we can't declare the argument
269 extern char *re_comp (const char *);
273 extern void symbol_file_command (char *, int);
275 /* * Remote targets may wish to use this as their load function. */
276 extern void generic_load (const char *name, int from_tty);
278 /* * Report on STREAM the performance of memory transfer operation,
280 @param DATA_COUNT is the number of bytes transferred.
281 @param WRITE_COUNT is the number of separate write operations, or 0,
282 if that information is not available.
283 @param START_TIME is the time at which an operation was started.
284 @param END_TIME is the time at which an operation ended. */
286 extern void print_transfer_performance (struct ui_file *stream,
287 unsigned long data_count,
288 unsigned long write_count,
289 const struct timeval *start_time,
290 const struct timeval *end_time);
294 typedef void initialize_file_ftype (void);
296 extern char *gdb_readline (char *);
298 extern char *gdb_readline_wrapper (char *);
300 extern char *command_line_input (char *, int, char *);
302 extern void print_prompt (void);
304 extern int input_from_terminal_p (void);
306 extern int info_verbose;
308 /* From printcmd.c */
310 extern void set_next_address (struct gdbarch *, CORE_ADDR);
312 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
313 struct ui_file *, int, char *);
315 extern int build_address_symbolic (struct gdbarch *,
324 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
325 extern const char *pc_prefix (CORE_ADDR);
329 /* See openp function definition for their description. */
330 #define OPF_TRY_CWD_FIRST 0x01
331 #define OPF_SEARCH_IN_PATH 0x02
332 #define OPF_RETURN_REALPATH 0x04
334 extern int openp (const char *, int, const char *, int, char **);
336 extern int source_full_path_of (const char *, char **);
338 extern void mod_path (char *, char **);
340 extern void add_path (char *, char **, int);
342 extern void directory_switch (char *, int);
344 extern char *source_path;
346 extern void init_source_path (void);
350 /* * Process memory area starting at ADDR with length SIZE. Area is
351 readable iff READ is non-zero, writable if WRITE is non-zero,
352 executable if EXEC is non-zero. Area is possibly changed against
353 its original file based copy if MODIFIED is non-zero. DATA is
354 passed without changes from a caller. */
356 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
357 int read, int write, int exec,
358 int modified, void *data);
360 /* * Possible lvalue types. Like enum language, this should be in
361 value.h, but needs to be here for the same reason. */
369 /* * In a register. Registers are relative to a frame. */
371 /* * In a gdb internal variable. */
373 /* * Value encapsulates a callable defined in an extension language. */
375 /* * Part of a gdb internal variable (structure field). */
376 lval_internalvar_component,
377 /* * Value's bits are fetched and stored using functions provided
382 /* * Control types for commands. */
384 enum misc_command_type
392 enum command_control_type
402 while_stepping_control,
406 /* * Structure for saved commands lines (for breakpoints, defined
411 struct command_line *next;
413 enum command_control_type control_type;
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 #include "common-utils.h"
542 /* * List of known OS ABIs. If you change this, make sure to update the
546 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
548 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
555 GDB_OSABI_FREEBSD_AOUT,
556 GDB_OSABI_FREEBSD_ELF,
557 GDB_OSABI_NETBSD_AOUT,
558 GDB_OSABI_NETBSD_ELF,
559 GDB_OSABI_OPENBSD_ELF,
575 GDB_OSABI_INVALID /* keep this last */
578 /* Global functions from other, non-gdb GNU thingies.
579 Libiberty thingies are no longer declared here. We include libiberty.h
582 /* From other system libraries */
585 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
588 /* Various possibilities for alloca. */
591 #define alloca __builtin_alloca
592 #else /* Not GNU C */
600 /* We need to be careful not to declare this in a way which conflicts with
601 bison. Bison never declares it as char *, but under various circumstances
602 (like __hpux) we need to use void *. */
603 extern void *alloca ();
604 #endif /* Not _AIX */
605 #endif /* Not HAVE_ALLOCA_H */
606 #endif /* Not GNU C */
607 #endif /* alloca not defined */
609 /* Dynamic target-system-dependent parameters for GDB. */
612 /* * Maximum size of a register. Something small, but large enough for
613 all known ISAs. If it turns out to be too small, make it bigger. */
615 enum { MAX_REGISTER_SIZE = 64 };
617 /* Static target-system-dependent parameters for GDB. */
619 /* * Number of bits in a char or unsigned char for the target machine.
620 Just like CHAR_BIT in <limits.h> but describes the target machine. */
621 #if !defined (TARGET_CHAR_BIT)
622 #define TARGET_CHAR_BIT 8
625 /* * If we picked up a copy of CHAR_BIT from a configuration file
626 (which may get it by including <limits.h>) then use it to set
627 the number of bits in a host char. If not, use the same size
630 #if defined (CHAR_BIT)
631 #define HOST_CHAR_BIT CHAR_BIT
633 #define HOST_CHAR_BIT TARGET_CHAR_BIT
638 extern LONGEST extract_signed_integer (const gdb_byte *, int,
641 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
644 extern int extract_long_unsigned_integer (const gdb_byte *, int,
645 enum bfd_endian, LONGEST *);
647 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
650 extern void store_signed_integer (gdb_byte *, int,
651 enum bfd_endian, LONGEST);
653 extern void store_unsigned_integer (gdb_byte *, int,
654 enum bfd_endian, ULONGEST);
656 extern void store_typed_address (gdb_byte *buf, struct type *type,
664 /* Hooks for alternate command interfaces. */
666 /* * The name of the interpreter if specified on the command line. */
667 extern char *interpreter_p;
669 /* If a given interpreter matches INTERPRETER_P then it should update
670 deprecated_init_ui_hook with the per-interpreter implementation. */
671 /* FIXME: deprecated_init_ui_hook should be moved here. */
673 struct target_waitstatus;
674 struct cmd_list_element;
676 extern void (*deprecated_pre_add_symbol_hook) (const char *);
677 extern void (*deprecated_post_add_symbol_hook) (void);
678 extern void (*selected_frame_level_changed_hook) (int);
679 extern int (*deprecated_ui_loop_hook) (int signo);
680 extern void (*deprecated_init_ui_hook) (char *argv0);
681 extern void (*deprecated_show_load_progress) (const char *section,
682 unsigned long section_sent,
683 unsigned long section_size,
684 unsigned long total_sent,
685 unsigned long total_size);
686 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
690 extern int (*deprecated_query_hook) (const char *, va_list)
691 ATTRIBUTE_FPTR_PRINTF(1,0);
692 extern void (*deprecated_warning_hook) (const char *, va_list)
693 ATTRIBUTE_FPTR_PRINTF(1,0);
694 extern void (*deprecated_interactive_hook) (void);
695 extern void (*deprecated_readline_begin_hook) (char *, ...)
696 ATTRIBUTE_FPTR_PRINTF_1;
697 extern char *(*deprecated_readline_hook) (char *);
698 extern void (*deprecated_readline_end_hook) (void);
699 extern void (*deprecated_register_changed_hook) (int regno);
700 extern void (*deprecated_context_hook) (int);
701 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
702 struct target_waitstatus *status,
705 extern void (*deprecated_attach_hook) (void);
706 extern void (*deprecated_detach_hook) (void);
707 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
708 char *cmd, int from_tty);
710 extern int (*deprecated_ui_load_progress_hook) (const char *section,
713 /* If this definition isn't overridden by the header files, assume
714 that isatty and fileno exist on this system. */
716 #define ISATTY(FP) (isatty (fileno (FP)))
719 /* * A width that can achieve a better legibility for GDB MI mode. */
720 #define GDB_MI_MSG_WIDTH 80
722 /* From progspace.c */
724 extern void initialize_progspace (void);
725 extern void initialize_inferiors (void);
727 /* * Special block numbers */
733 FIRST_LOCAL_BLOCK = 2
738 #endif /* #ifndef DEFS_H */