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_wchar.h"
57 #include "host-defs.h"
59 /* Just in case they're not defined in stdio.h. */
68 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
69 It is used as an access modifier in calls to open(), where it acts
70 similarly to the "b" character in fopen()'s MODE argument. On Posix
71 platforms it should be a no-op, so it is defined as 0 here. This
72 ensures that the symbol may be used freely elsewhere in gdb. */
80 /* Rather than duplicate all the logic in BFD for figuring out what
81 types to use (which can be pretty complicated), symply define them
82 in terms of the corresponding type from BFD. */
86 /* * A byte from the program being debugged. */
87 typedef bfd_byte gdb_byte;
89 /* * An address in the program being debugged. Host byte order. */
90 typedef bfd_vma CORE_ADDR;
92 /* * The largest CORE_ADDR value. */
93 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
95 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
99 #define LONGEST BFD_HOST_64_BIT
100 #define ULONGEST BFD_HOST_U_64_BIT
104 #define LONGEST long long
105 #define ULONGEST unsigned long long
107 #endif /* No BFD64 */
110 #define min(a, b) ((a) < (b) ? (a) : (b))
113 #define max(a, b) ((a) > (b) ? (a) : (b))
118 /* * Enable xdb commands if set. */
119 extern int xdb_commands;
121 /* * Enable dbx commands if set. */
122 extern int dbx_commands;
124 /* * System root path, used to find libraries etc. */
125 extern char *gdb_sysroot;
127 /* * GDB datadir, used to store data files. */
128 extern char *gdb_datadir;
130 /* * If non-NULL, the possibly relocated path to python's "lib" directory
131 specified with --with-python. */
132 extern char *python_libdir;
134 /* * Search path for separate debug files. */
135 extern char *debug_file_directory;
137 /* GDB has two methods for handling SIGINT. When immediate_quit is
138 nonzero, a SIGINT results in an immediate longjmp out of the signal
139 handler. Otherwise, SIGINT simply sets a flag; code that might
140 take a long time, and which ought to be interruptible, checks this
141 flag using the QUIT macro.
143 These functions use the extension_language_ops API to allow extension
144 language(s) and GDB SIGINT handling to coexist seamlessly. */
146 /* * Clear the quit flag. */
147 extern void clear_quit_flag (void);
148 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
149 will clear the quit flag as a side effect. */
150 extern int check_quit_flag (void);
151 /* * Set the quit flag. */
152 extern void set_quit_flag (void);
154 /* Flag that function quit should call quit_force. */
155 extern volatile int sync_quit_force_run;
157 extern int immediate_quit;
159 extern void quit (void);
161 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
162 benefits of having a ``QUIT'' macro rather than a function are
163 marginal. If the overhead of a QUIT function call is proving
164 significant then its calling frequency should probably be reduced
165 [kingdon]. A profile analyzing the current situtation is
169 if (check_quit_flag () || sync_quit_force_run) quit (); \
170 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
173 /* * Languages represented in the symbol table and elsewhere.
174 This should probably be in language.h, but since enum's can't
175 be forward declared to satisfy opaque references before their
176 actual definition, needs to be here. */
180 language_unknown, /* Language not known */
181 language_auto, /* Placeholder for automatic setting */
183 language_cplus, /* C++ */
185 language_go, /* Go */
186 language_objc, /* Objective-C */
187 language_java, /* Java */
188 language_fortran, /* Fortran */
189 language_m2, /* Modula-2 */
190 language_asm, /* Assembly language */
191 language_pascal, /* Pascal */
192 language_ada, /* Ada */
193 language_opencl, /* OpenCL */
194 language_minimal, /* All other languages, minimal support only */
202 unspecified_precision
205 /* * A generic, not quite boolean, enumeration. This is used for
206 set/show commands in which the options are on/off/automatic. */
214 /* * Potential ways that a function can return a value of a given
217 enum return_value_convention
219 /* * Where the return value has been squeezed into one or more
221 RETURN_VALUE_REGISTER_CONVENTION,
222 /* * Commonly known as the "struct return convention". The caller
223 passes an additional hidden first parameter to the caller. That
224 parameter contains the address at which the value being returned
225 should be stored. While typically, and historically, used for
226 large structs, this is convention is applied to values of many
228 RETURN_VALUE_STRUCT_CONVENTION,
229 /* * Like the "struct return convention" above, but where the ABI
230 guarantees that the called function stores the address at which
231 the value being returned is stored in a well-defined location,
232 such as a register or memory slot in the stack frame. Don't use
233 this if the ABI doesn't explicitly guarantees this. */
234 RETURN_VALUE_ABI_RETURNS_ADDRESS,
235 /* * Like the "struct return convention" above, but where the ABI
236 guarantees that the address at which the value being returned is
237 stored will be available in a well-defined location, such as a
238 register or memory slot in the stack frame. Don't use this if
239 the ABI doesn't explicitly guarantees this. */
240 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
243 /* Needed for various prototypes */
253 /* This really belong in utils.c (path-utils.c?), but it references some
254 globals that are currently only available to main.c. */
255 extern char *relocate_gdb_directory (const char *initial, int flag);
258 /* Annotation stuff. */
260 extern int annotation_level; /* in stack.c */
263 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
264 "const char *" in unistd.h, so we can't declare the argument
267 extern char *re_comp (const char *);
271 extern void symbol_file_command (char *, int);
273 /* * Remote targets may wish to use this as their load function. */
274 extern void generic_load (const char *name, int from_tty);
276 /* * Report on STREAM the performance of memory transfer operation,
278 @param DATA_COUNT is the number of bytes transferred.
279 @param WRITE_COUNT is the number of separate write operations, or 0,
280 if that information is not available.
281 @param START_TIME is the time at which an operation was started.
282 @param END_TIME is the time at which an operation ended. */
284 extern void print_transfer_performance (struct ui_file *stream,
285 unsigned long data_count,
286 unsigned long write_count,
287 const struct timeval *start_time,
288 const struct timeval *end_time);
292 typedef void initialize_file_ftype (void);
294 extern char *gdb_readline (char *);
296 extern char *gdb_readline_wrapper (char *);
298 extern char *command_line_input (char *, int, char *);
300 extern void print_prompt (void);
302 extern int input_from_terminal_p (void);
304 extern int info_verbose;
306 /* From printcmd.c */
308 extern void set_next_address (struct gdbarch *, CORE_ADDR);
310 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
311 struct ui_file *, int, char *);
313 extern int build_address_symbolic (struct gdbarch *,
322 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
323 extern const char *pc_prefix (CORE_ADDR);
327 /* See openp function definition for their description. */
328 #define OPF_TRY_CWD_FIRST 0x01
329 #define OPF_SEARCH_IN_PATH 0x02
330 #define OPF_RETURN_REALPATH 0x04
332 extern int openp (const char *, int, const char *, int, char **);
334 extern int source_full_path_of (const char *, char **);
336 extern void mod_path (char *, char **);
338 extern void add_path (char *, char **, int);
340 extern void directory_switch (char *, int);
342 extern char *source_path;
344 extern void init_source_path (void);
348 /* * Process memory area starting at ADDR with length SIZE. Area is
349 readable iff READ is non-zero, writable if WRITE is non-zero,
350 executable if EXEC is non-zero. Area is possibly changed against
351 its original file based copy if MODIFIED is non-zero. DATA is
352 passed without changes from a caller. */
354 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
355 int read, int write, int exec,
356 int modified, void *data);
358 /* * Possible lvalue types. Like enum language, this should be in
359 value.h, but needs to be here for the same reason. */
367 /* * In a register. Registers are relative to a frame. */
369 /* * In a gdb internal variable. */
371 /* * Value encapsulates a callable defined in an extension language. */
373 /* * Part of a gdb internal variable (structure field). */
374 lval_internalvar_component,
375 /* * Value's bits are fetched and stored using functions provided
380 /* * Control types for commands. */
382 enum misc_command_type
390 enum command_control_type
400 while_stepping_control,
404 /* * Structure for saved commands lines (for breakpoints, defined
409 struct command_line *next;
411 enum command_control_type control_type;
412 /* * The number of elements in body_list. */
414 /* * For composite commands, the nested lists of commands. For
415 example, for "if" command this will contain the then branch and
416 the else branch, if that is available. */
417 struct command_line **body_list;
420 extern struct command_line *read_command_lines (char *, int, int,
421 void (*)(char *, void *),
423 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
424 void (*)(char *, void *),
427 extern void free_command_lines (struct command_line **);
429 /* * Parameters of the "info proc" command. */
433 /* * Display the default cmdline, cwd and exe outputs. */
436 /* * Display `info proc mappings'. */
439 /* * Display `info proc status'. */
442 /* * Display `info proc stat'. */
445 /* * Display `info proc cmdline'. */
448 /* * Display `info proc exe'. */
451 /* * Display `info proc cwd'. */
454 /* * Display all of the above. */
458 /* * String containing the current directory (what getwd would return). */
460 extern char *current_directory;
462 /* * Default radixes for input and output. Only some values supported. */
463 extern unsigned input_radix;
464 extern unsigned output_radix;
466 /* * Possibilities for prettyformat parameters to routines which print
467 things. Like enum language, this should be in value.h, but needs
468 to be here for the same reason. FIXME: If we can eliminate this
469 as an arg to LA_VAL_PRINT, then we can probably move it back to
472 enum val_prettyformat
474 Val_no_prettyformat = 0,
476 /* * Use the default setting which the user has specified. */
477 Val_prettyformat_default
480 /* * Optional native machine support. Non-native (and possibly pure
481 multi-arch) targets do not need a "nm.h" file. This will be a
482 symlink to one of the nm-*.h files, built by the `configure'
489 /* Assume that fopen accepts the letter "b" in the mode string.
490 It is demanded by ISO C9X, and should be supported on all
491 platforms that claim to have a standard-conforming C library. On
492 true POSIX systems it will be ignored and have no effect. There
493 may still be systems without a standard-conforming C library where
494 an ISO C9X compiler (GCC) is available. Known examples are SunOS
495 4.x and 4.3BSD. This assumption means these systems are no longer
498 # include "fopen-bin.h"
501 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
502 FIXME: Assumes 2's complement arithmetic. */
504 #if !defined (UINT_MAX)
505 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
508 #if !defined (INT_MAX)
509 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
512 #if !defined (INT_MIN)
513 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
516 #if !defined (ULONG_MAX)
517 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
520 #if !defined (LONG_MAX)
521 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
524 #if !defined (ULONGEST_MAX)
525 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
528 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
529 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
532 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
533 arguments to a function, number in a value history, register number, etc.)
534 where the value must not be larger than can fit in an int. */
536 extern int longest_to_int (LONGEST);
538 #include "common-utils.h"
540 /* * List of known OS ABIs. If you change this, make sure to update the
544 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
546 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
553 GDB_OSABI_FREEBSD_AOUT,
554 GDB_OSABI_FREEBSD_ELF,
555 GDB_OSABI_NETBSD_AOUT,
556 GDB_OSABI_NETBSD_ELF,
557 GDB_OSABI_OPENBSD_ELF,
573 GDB_OSABI_INVALID /* keep this last */
576 /* Global functions from other, non-gdb GNU thingies.
577 Libiberty thingies are no longer declared here. We include libiberty.h
580 /* From other system libraries */
583 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
586 /* Various possibilities for alloca. */
589 #define alloca __builtin_alloca
590 #else /* Not GNU C */
598 /* We need to be careful not to declare this in a way which conflicts with
599 bison. Bison never declares it as char *, but under various circumstances
600 (like __hpux) we need to use void *. */
601 extern void *alloca ();
602 #endif /* Not _AIX */
603 #endif /* Not HAVE_ALLOCA_H */
604 #endif /* Not GNU C */
605 #endif /* alloca not defined */
607 /* Dynamic target-system-dependent parameters for GDB. */
610 /* * Maximum size of a register. Something small, but large enough for
611 all known ISAs. If it turns out to be too small, make it bigger. */
613 enum { MAX_REGISTER_SIZE = 64 };
615 /* Static target-system-dependent parameters for GDB. */
617 /* * Number of bits in a char or unsigned char for the target machine.
618 Just like CHAR_BIT in <limits.h> but describes the target machine. */
619 #if !defined (TARGET_CHAR_BIT)
620 #define TARGET_CHAR_BIT 8
623 /* * If we picked up a copy of CHAR_BIT from a configuration file
624 (which may get it by including <limits.h>) then use it to set
625 the number of bits in a host char. If not, use the same size
628 #if defined (CHAR_BIT)
629 #define HOST_CHAR_BIT CHAR_BIT
631 #define HOST_CHAR_BIT TARGET_CHAR_BIT
636 extern LONGEST extract_signed_integer (const gdb_byte *, int,
639 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
642 extern int extract_long_unsigned_integer (const gdb_byte *, int,
643 enum bfd_endian, LONGEST *);
645 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
648 extern void store_signed_integer (gdb_byte *, int,
649 enum bfd_endian, LONGEST);
651 extern void store_unsigned_integer (gdb_byte *, int,
652 enum bfd_endian, ULONGEST);
654 extern void store_typed_address (gdb_byte *buf, struct type *type,
662 /* Hooks for alternate command interfaces. */
664 /* * The name of the interpreter if specified on the command line. */
665 extern char *interpreter_p;
667 /* If a given interpreter matches INTERPRETER_P then it should update
668 deprecated_init_ui_hook with the per-interpreter implementation. */
669 /* FIXME: deprecated_init_ui_hook should be moved here. */
671 struct target_waitstatus;
672 struct cmd_list_element;
674 extern void (*deprecated_pre_add_symbol_hook) (const char *);
675 extern void (*deprecated_post_add_symbol_hook) (void);
676 extern void (*selected_frame_level_changed_hook) (int);
677 extern int (*deprecated_ui_loop_hook) (int signo);
678 extern void (*deprecated_init_ui_hook) (char *argv0);
679 extern void (*deprecated_show_load_progress) (const char *section,
680 unsigned long section_sent,
681 unsigned long section_size,
682 unsigned long total_sent,
683 unsigned long total_size);
684 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
688 extern int (*deprecated_query_hook) (const char *, va_list)
689 ATTRIBUTE_FPTR_PRINTF(1,0);
690 extern void (*deprecated_warning_hook) (const char *, va_list)
691 ATTRIBUTE_FPTR_PRINTF(1,0);
692 extern void (*deprecated_interactive_hook) (void);
693 extern void (*deprecated_readline_begin_hook) (char *, ...)
694 ATTRIBUTE_FPTR_PRINTF_1;
695 extern char *(*deprecated_readline_hook) (char *);
696 extern void (*deprecated_readline_end_hook) (void);
697 extern void (*deprecated_register_changed_hook) (int regno);
698 extern void (*deprecated_context_hook) (int);
699 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
700 struct target_waitstatus *status,
703 extern void (*deprecated_attach_hook) (void);
704 extern void (*deprecated_detach_hook) (void);
705 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
706 char *cmd, int from_tty);
708 extern int (*deprecated_ui_load_progress_hook) (const char *section,
711 /* If this definition isn't overridden by the header files, assume
712 that isatty and fileno exist on this system. */
714 #define ISATTY(FP) (isatty (fileno (FP)))
717 /* * A width that can achieve a better legibility for GDB MI mode. */
718 #define GDB_MI_MSG_WIDTH 80
720 /* From progspace.c */
722 extern void initialize_progspace (void);
723 extern void initialize_inferiors (void);
725 /* * Special block numbers */
731 FIRST_LOCAL_BLOCK = 2
736 #endif /* #ifndef DEFS_H */