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>
32 #include <errno.h> /* System call error return status. */
36 /* The libdecnumber library, on which GDB depends, includes a header file
37 called gstdint.h instead of relying directly on stdint.h. GDB, on the
38 other hand, includes stdint.h directly, relying on the fact that gnulib
39 generates a copy if the system doesn't provide one or if it is missing
40 some features. Unfortunately, gstdint.h and stdint.h cannot be included
41 at the same time, which may happen when we include a file from
44 The following macro definition effectively prevents the inclusion of
45 gstdint.h, as all the definitions it provides are guarded against
46 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
47 included, so it's ok to blank out gstdint.h. */
48 #define GCC_GENERATED_STDINT_H 1
54 /* For gnulib's PATH_MAX. */
59 /* First include ansidecl.h so we can use the various macro definitions
60 here and in all subsequent file inclusions. */
64 #include "gdb_locale.h"
66 #include "gdb_wchar.h"
68 /* For ``enum gdb_signal''. */
69 #include "gdb/signals.h"
73 #include "host-defs.h"
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. */
94 #include <stdarg.h> /* For va_list. */
96 #include "libiberty.h"
99 /* Rather than duplicate all the logic in BFD for figuring out what
100 types to use (which can be pretty complicated), symply define them
101 in terms of the corresponding type from BFD. */
105 /* * A byte from the program being debugged. */
106 typedef bfd_byte gdb_byte
;
108 /* * An address in the program being debugged. Host byte order. */
109 typedef bfd_vma CORE_ADDR
;
111 /* * The largest CORE_ADDR value. */
112 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
114 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
118 #define LONGEST BFD_HOST_64_BIT
119 #define ULONGEST BFD_HOST_U_64_BIT
123 #define LONGEST long long
124 #define ULONGEST unsigned long long
126 #endif /* No BFD64 */
129 #define min(a, b) ((a) < (b) ? (a) : (b))
132 #define max(a, b) ((a) > (b) ? (a) : (b))
137 /* * Enable xdb commands if set. */
138 extern int xdb_commands
;
140 /* * Enable dbx commands if set. */
141 extern int dbx_commands
;
143 /* * System root path, used to find libraries etc. */
144 extern char *gdb_sysroot
;
146 /* * GDB datadir, used to store data files. */
147 extern char *gdb_datadir
;
149 /* * If non-NULL, the possibly relocated path to python's "lib" directory
150 specified with --with-python. */
151 extern char *python_libdir
;
153 /* * Search path for separate debug files. */
154 extern char *debug_file_directory
;
156 /* GDB has two methods for handling SIGINT. When immediate_quit is
157 nonzero, a SIGINT results in an immediate longjmp out of the signal
158 handler. Otherwise, SIGINT simply sets a flag; code that might
159 take a long time, and which ought to be interruptible, checks this
160 flag using the QUIT macro.
162 These functions use the extension_language_ops API to allow extension
163 language(s) and GDB SIGINT handling to coexist seamlessly. */
165 /* * Clear the quit flag. */
166 extern void clear_quit_flag (void);
167 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
168 will clear the quit flag as a side effect. */
169 extern int check_quit_flag (void);
170 /* * Set the quit flag. */
171 extern void set_quit_flag (void);
173 /* Flag that function quit should call quit_force. */
174 extern volatile int sync_quit_force_run
;
176 extern int immediate_quit
;
178 extern void quit (void);
180 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
181 benefits of having a ``QUIT'' macro rather than a function are
182 marginal. If the overhead of a QUIT function call is proving
183 significant then its calling frequency should probably be reduced
184 [kingdon]. A profile analyzing the current situtation is
188 if (check_quit_flag () || sync_quit_force_run) quit (); \
189 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
192 /* * Languages represented in the symbol table and elsewhere.
193 This should probably be in language.h, but since enum's can't
194 be forward declared to satisfy opaque references before their
195 actual definition, needs to be here. */
199 language_unknown
, /* Language not known */
200 language_auto
, /* Placeholder for automatic setting */
202 language_cplus
, /* C++ */
204 language_go
, /* Go */
205 language_objc
, /* Objective-C */
206 language_java
, /* Java */
207 language_fortran
, /* Fortran */
208 language_m2
, /* Modula-2 */
209 language_asm
, /* Assembly language */
210 language_pascal
, /* Pascal */
211 language_ada
, /* Ada */
212 language_opencl
, /* OpenCL */
213 language_minimal
, /* All other languages, minimal support only */
221 unspecified_precision
224 /* * A generic, not quite boolean, enumeration. This is used for
225 set/show commands in which the options are on/off/automatic. */
233 /* * Potential ways that a function can return a value of a given
236 enum return_value_convention
238 /* * Where the return value has been squeezed into one or more
240 RETURN_VALUE_REGISTER_CONVENTION
,
241 /* * Commonly known as the "struct return convention". The caller
242 passes an additional hidden first parameter to the caller. That
243 parameter contains the address at which the value being returned
244 should be stored. While typically, and historically, used for
245 large structs, this is convention is applied to values of many
247 RETURN_VALUE_STRUCT_CONVENTION
,
248 /* * Like the "struct return convention" above, but where the ABI
249 guarantees that the called function stores the address at which
250 the value being returned is stored in a well-defined location,
251 such as a register or memory slot in the stack frame. Don't use
252 this if the ABI doesn't explicitly guarantees this. */
253 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
254 /* * Like the "struct return convention" above, but where the ABI
255 guarantees that the address at which the value being returned is
256 stored will be available in a well-defined location, such as a
257 register or memory slot in the stack frame. Don't use this if
258 the ABI doesn't explicitly guarantees this. */
259 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
262 /* Needed for various prototypes */
272 /* This really belong in utils.c (path-utils.c?), but it references some
273 globals that are currently only available to main.c. */
274 extern char *relocate_gdb_directory (const char *initial
, int flag
);
277 /* Annotation stuff. */
279 extern int annotation_level
; /* in stack.c */
282 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
283 "const char *" in unistd.h, so we can't declare the argument
286 extern char *re_comp (const char *);
290 extern void symbol_file_command (char *, int);
292 /* * Remote targets may wish to use this as their load function. */
293 extern void generic_load (const char *name
, int from_tty
);
295 /* * Report on STREAM the performance of memory transfer operation,
297 @param DATA_COUNT is the number of bytes transferred.
298 @param WRITE_COUNT is the number of separate write operations, or 0,
299 if that information is not available.
300 @param START_TIME is the time at which an operation was started.
301 @param END_TIME is the time at which an operation ended. */
303 extern void print_transfer_performance (struct ui_file
*stream
,
304 unsigned long data_count
,
305 unsigned long write_count
,
306 const struct timeval
*start_time
,
307 const struct timeval
*end_time
);
311 typedef void initialize_file_ftype (void);
313 extern char *gdb_readline (char *);
315 extern char *gdb_readline_wrapper (char *);
317 extern char *command_line_input (char *, int, char *);
319 extern void print_prompt (void);
321 extern int input_from_terminal_p (void);
323 extern int info_verbose
;
325 /* From printcmd.c */
327 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
329 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
330 struct ui_file
*, int, char *);
332 extern int build_address_symbolic (struct gdbarch
*,
341 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
342 extern const char *pc_prefix (CORE_ADDR
);
346 /* See openp function definition for their description. */
347 #define OPF_TRY_CWD_FIRST 0x01
348 #define OPF_SEARCH_IN_PATH 0x02
349 #define OPF_RETURN_REALPATH 0x04
351 extern int openp (const char *, int, const char *, int, char **);
353 extern int source_full_path_of (const char *, char **);
355 extern void mod_path (char *, char **);
357 extern void add_path (char *, char **, int);
359 extern void directory_switch (char *, int);
361 extern char *source_path
;
363 extern void init_source_path (void);
367 /* * Process memory area starting at ADDR with length SIZE. Area is
368 readable iff READ is non-zero, writable if WRITE is non-zero,
369 executable if EXEC is non-zero. Area is possibly changed against
370 its original file based copy if MODIFIED is non-zero. DATA is
371 passed without changes from a caller. */
373 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
374 int read
, int write
, int exec
,
375 int modified
, void *data
);
377 /* * Possible lvalue types. Like enum language, this should be in
378 value.h, but needs to be here for the same reason. */
386 /* * In a register. Registers are relative to a frame. */
388 /* * In a gdb internal variable. */
390 /* * Value encapsulates a callable defined in an extension language. */
392 /* * Part of a gdb internal variable (structure field). */
393 lval_internalvar_component
,
394 /* * Value's bits are fetched and stored using functions provided
399 /* * Control types for commands. */
401 enum misc_command_type
409 enum command_control_type
419 while_stepping_control
,
423 /* * Structure for saved commands lines (for breakpoints, defined
428 struct command_line
*next
;
430 enum command_control_type control_type
;
431 /* * The number of elements in body_list. */
433 /* * For composite commands, the nested lists of commands. For
434 example, for "if" command this will contain the then branch and
435 the else branch, if that is available. */
436 struct command_line
**body_list
;
439 extern struct command_line
*read_command_lines (char *, int, int,
440 void (*)(char *, void *),
442 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
443 void (*)(char *, void *),
446 extern void free_command_lines (struct command_line
**);
448 /* * Parameters of the "info proc" command. */
452 /* * Display the default cmdline, cwd and exe outputs. */
455 /* * Display `info proc mappings'. */
458 /* * Display `info proc status'. */
461 /* * Display `info proc stat'. */
464 /* * Display `info proc cmdline'. */
467 /* * Display `info proc exe'. */
470 /* * Display `info proc cwd'. */
473 /* * Display all of the above. */
477 /* * String containing the current directory (what getwd would return). */
479 extern char *current_directory
;
481 /* * Default radixes for input and output. Only some values supported. */
482 extern unsigned input_radix
;
483 extern unsigned output_radix
;
485 /* * Possibilities for prettyformat parameters to routines which print
486 things. Like enum language, this should be in value.h, but needs
487 to be here for the same reason. FIXME: If we can eliminate this
488 as an arg to LA_VAL_PRINT, then we can probably move it back to
491 enum val_prettyformat
493 Val_no_prettyformat
= 0,
495 /* * Use the default setting which the user has specified. */
496 Val_prettyformat_default
499 /* * Optional native machine support. Non-native (and possibly pure
500 multi-arch) targets do not need a "nm.h" file. This will be a
501 symlink to one of the nm-*.h files, built by the `configure'
508 /* Assume that fopen accepts the letter "b" in the mode string.
509 It is demanded by ISO C9X, and should be supported on all
510 platforms that claim to have a standard-conforming C library. On
511 true POSIX systems it will be ignored and have no effect. There
512 may still be systems without a standard-conforming C library where
513 an ISO C9X compiler (GCC) is available. Known examples are SunOS
514 4.x and 4.3BSD. This assumption means these systems are no longer
517 # include "fopen-bin.h"
520 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
521 FIXME: Assumes 2's complement arithmetic. */
523 #if !defined (UINT_MAX)
524 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
527 #if !defined (INT_MAX)
528 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
531 #if !defined (INT_MIN)
532 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
535 #if !defined (ULONG_MAX)
536 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
539 #if !defined (LONG_MAX)
540 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
543 #if !defined (ULONGEST_MAX)
544 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
547 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
548 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
551 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
552 arguments to a function, number in a value history, register number, etc.)
553 where the value must not be larger than can fit in an int. */
555 extern int longest_to_int (LONGEST
);
557 #include "common-utils.h"
559 /* * List of known OS ABIs. If you change this, make sure to update the
563 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
565 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
572 GDB_OSABI_FREEBSD_AOUT
,
573 GDB_OSABI_FREEBSD_ELF
,
574 GDB_OSABI_NETBSD_AOUT
,
575 GDB_OSABI_NETBSD_ELF
,
576 GDB_OSABI_OPENBSD_ELF
,
592 GDB_OSABI_INVALID
/* keep this last */
595 /* Global functions from other, non-gdb GNU thingies.
596 Libiberty thingies are no longer declared here. We include libiberty.h
599 /* From other system libraries */
605 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
608 /* Various possibilities for alloca. */
611 #define alloca __builtin_alloca
612 #else /* Not GNU C */
620 /* We need to be careful not to declare this in a way which conflicts with
621 bison. Bison never declares it as char *, but under various circumstances
622 (like __hpux) we need to use void *. */
623 extern void *alloca ();
624 #endif /* Not _AIX */
625 #endif /* Not HAVE_ALLOCA_H */
626 #endif /* Not GNU C */
627 #endif /* alloca not defined */
629 /* Dynamic target-system-dependent parameters for GDB. */
632 /* * Maximum size of a register. Something small, but large enough for
633 all known ISAs. If it turns out to be too small, make it bigger. */
635 enum { MAX_REGISTER_SIZE
= 64 };
637 /* Static target-system-dependent parameters for GDB. */
639 /* * Number of bits in a char or unsigned char for the target machine.
640 Just like CHAR_BIT in <limits.h> but describes the target machine. */
641 #if !defined (TARGET_CHAR_BIT)
642 #define TARGET_CHAR_BIT 8
645 /* * If we picked up a copy of CHAR_BIT from a configuration file
646 (which may get it by including <limits.h>) then use it to set
647 the number of bits in a host char. If not, use the same size
650 #if defined (CHAR_BIT)
651 #define HOST_CHAR_BIT CHAR_BIT
653 #define HOST_CHAR_BIT TARGET_CHAR_BIT
658 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
661 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
664 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
665 enum bfd_endian
, LONGEST
*);
667 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
670 extern void store_signed_integer (gdb_byte
*, int,
671 enum bfd_endian
, LONGEST
);
673 extern void store_unsigned_integer (gdb_byte
*, int,
674 enum bfd_endian
, ULONGEST
);
676 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
684 /* Hooks for alternate command interfaces. */
686 /* * The name of the interpreter if specified on the command line. */
687 extern char *interpreter_p
;
689 /* If a given interpreter matches INTERPRETER_P then it should update
690 deprecated_init_ui_hook with the per-interpreter implementation. */
691 /* FIXME: deprecated_init_ui_hook should be moved here. */
693 struct target_waitstatus
;
694 struct cmd_list_element
;
696 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
697 extern void (*deprecated_post_add_symbol_hook
) (void);
698 extern void (*selected_frame_level_changed_hook
) (int);
699 extern int (*deprecated_ui_loop_hook
) (int signo
);
700 extern void (*deprecated_init_ui_hook
) (char *argv0
);
701 extern void (*deprecated_show_load_progress
) (const char *section
,
702 unsigned long section_sent
,
703 unsigned long section_size
,
704 unsigned long total_sent
,
705 unsigned long total_size
);
706 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
710 extern int (*deprecated_query_hook
) (const char *, va_list)
711 ATTRIBUTE_FPTR_PRINTF(1,0);
712 extern void (*deprecated_warning_hook
) (const char *, va_list)
713 ATTRIBUTE_FPTR_PRINTF(1,0);
714 extern void (*deprecated_interactive_hook
) (void);
715 extern void (*deprecated_readline_begin_hook
) (char *, ...)
716 ATTRIBUTE_FPTR_PRINTF_1
;
717 extern char *(*deprecated_readline_hook
) (char *);
718 extern void (*deprecated_readline_end_hook
) (void);
719 extern void (*deprecated_register_changed_hook
) (int regno
);
720 extern void (*deprecated_context_hook
) (int);
721 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
722 struct target_waitstatus
*status
,
725 extern void (*deprecated_attach_hook
) (void);
726 extern void (*deprecated_detach_hook
) (void);
727 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
728 char *cmd
, int from_tty
);
730 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
733 /* If this definition isn't overridden by the header files, assume
734 that isatty and fileno exist on this system. */
736 #define ISATTY(FP) (isatty (fileno (FP)))
739 /* * A width that can achieve a better legibility for GDB MI mode. */
740 #define GDB_MI_MSG_WIDTH 80
742 /* From progspace.c */
744 extern void initialize_progspace (void);
745 extern void initialize_inferiors (void);
747 /* * Special block numbers */
753 FIRST_LOCAL_BLOCK
= 2
758 #endif /* #ifndef DEFS_H */