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
51 /* For gnulib's PATH_MAX. */
56 #include "gdb_locale.h"
58 #include "gdb_wchar.h"
60 /* For ``enum gdb_signal''. */
61 #include "gdb/signals.h"
65 #include "host-defs.h"
67 /* Just in case they're not defined in stdio.h. */
76 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
77 It is used as an access modifier in calls to open(), where it acts
78 similarly to the "b" character in fopen()'s MODE argument. On Posix
79 platforms it should be a no-op, so it is defined as 0 here. This
80 ensures that the symbol may be used freely elsewhere in gdb. */
88 /* Rather than duplicate all the logic in BFD for figuring out what
89 types to use (which can be pretty complicated), symply define them
90 in terms of the corresponding type from BFD. */
94 /* * A byte from the program being debugged. */
95 typedef bfd_byte gdb_byte
;
97 /* * An address in the program being debugged. Host byte order. */
98 typedef bfd_vma CORE_ADDR
;
100 /* * The largest CORE_ADDR value. */
101 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
103 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
107 #define LONGEST BFD_HOST_64_BIT
108 #define ULONGEST BFD_HOST_U_64_BIT
112 #define LONGEST long long
113 #define ULONGEST unsigned long long
115 #endif /* No BFD64 */
118 #define min(a, b) ((a) < (b) ? (a) : (b))
121 #define max(a, b) ((a) > (b) ? (a) : (b))
126 /* * Enable xdb commands if set. */
127 extern int xdb_commands
;
129 /* * Enable dbx commands if set. */
130 extern int dbx_commands
;
132 /* * System root path, used to find libraries etc. */
133 extern char *gdb_sysroot
;
135 /* * GDB datadir, used to store data files. */
136 extern char *gdb_datadir
;
138 /* * If non-NULL, the possibly relocated path to python's "lib" directory
139 specified with --with-python. */
140 extern char *python_libdir
;
142 /* * Search path for separate debug files. */
143 extern char *debug_file_directory
;
145 /* GDB has two methods for handling SIGINT. When immediate_quit is
146 nonzero, a SIGINT results in an immediate longjmp out of the signal
147 handler. Otherwise, SIGINT simply sets a flag; code that might
148 take a long time, and which ought to be interruptible, checks this
149 flag using the QUIT macro.
151 These functions use the extension_language_ops API to allow extension
152 language(s) and GDB SIGINT handling to coexist seamlessly. */
154 /* * Clear the quit flag. */
155 extern void clear_quit_flag (void);
156 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
157 will clear the quit flag as a side effect. */
158 extern int check_quit_flag (void);
159 /* * Set the quit flag. */
160 extern void set_quit_flag (void);
162 /* Flag that function quit should call quit_force. */
163 extern volatile int sync_quit_force_run
;
165 extern int immediate_quit
;
167 extern void quit (void);
169 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
170 benefits of having a ``QUIT'' macro rather than a function are
171 marginal. If the overhead of a QUIT function call is proving
172 significant then its calling frequency should probably be reduced
173 [kingdon]. A profile analyzing the current situtation is
177 if (check_quit_flag () || sync_quit_force_run) quit (); \
178 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
181 /* * Languages represented in the symbol table and elsewhere.
182 This should probably be in language.h, but since enum's can't
183 be forward declared to satisfy opaque references before their
184 actual definition, needs to be here. */
188 language_unknown
, /* Language not known */
189 language_auto
, /* Placeholder for automatic setting */
191 language_cplus
, /* C++ */
193 language_go
, /* Go */
194 language_objc
, /* Objective-C */
195 language_java
, /* Java */
196 language_fortran
, /* Fortran */
197 language_m2
, /* Modula-2 */
198 language_asm
, /* Assembly language */
199 language_pascal
, /* Pascal */
200 language_ada
, /* Ada */
201 language_opencl
, /* OpenCL */
202 language_minimal
, /* All other languages, minimal support only */
210 unspecified_precision
213 /* * A generic, not quite boolean, enumeration. This is used for
214 set/show commands in which the options are on/off/automatic. */
222 /* * Potential ways that a function can return a value of a given
225 enum return_value_convention
227 /* * Where the return value has been squeezed into one or more
229 RETURN_VALUE_REGISTER_CONVENTION
,
230 /* * Commonly known as the "struct return convention". The caller
231 passes an additional hidden first parameter to the caller. That
232 parameter contains the address at which the value being returned
233 should be stored. While typically, and historically, used for
234 large structs, this is convention is applied to values of many
236 RETURN_VALUE_STRUCT_CONVENTION
,
237 /* * Like the "struct return convention" above, but where the ABI
238 guarantees that the called function stores the address at which
239 the value being returned is stored in a well-defined location,
240 such as a register or memory slot in the stack frame. Don't use
241 this if the ABI doesn't explicitly guarantees this. */
242 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
243 /* * Like the "struct return convention" above, but where the ABI
244 guarantees that the address at which the value being returned is
245 stored will be available in a well-defined location, such as a
246 register or memory slot in the stack frame. Don't use this if
247 the ABI doesn't explicitly guarantees this. */
248 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
251 /* Needed for various prototypes */
261 /* This really belong in utils.c (path-utils.c?), but it references some
262 globals that are currently only available to main.c. */
263 extern char *relocate_gdb_directory (const char *initial
, int flag
);
266 /* Annotation stuff. */
268 extern int annotation_level
; /* in stack.c */
271 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
272 "const char *" in unistd.h, so we can't declare the argument
275 extern char *re_comp (const char *);
279 extern void symbol_file_command (char *, int);
281 /* * Remote targets may wish to use this as their load function. */
282 extern void generic_load (const char *name
, int from_tty
);
284 /* * Report on STREAM the performance of memory transfer operation,
286 @param DATA_COUNT is the number of bytes transferred.
287 @param WRITE_COUNT is the number of separate write operations, or 0,
288 if that information is not available.
289 @param START_TIME is the time at which an operation was started.
290 @param END_TIME is the time at which an operation ended. */
292 extern void print_transfer_performance (struct ui_file
*stream
,
293 unsigned long data_count
,
294 unsigned long write_count
,
295 const struct timeval
*start_time
,
296 const struct timeval
*end_time
);
300 typedef void initialize_file_ftype (void);
302 extern char *gdb_readline (char *);
304 extern char *gdb_readline_wrapper (char *);
306 extern char *command_line_input (char *, int, char *);
308 extern void print_prompt (void);
310 extern int input_from_terminal_p (void);
312 extern int info_verbose
;
314 /* From printcmd.c */
316 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
318 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
319 struct ui_file
*, int, char *);
321 extern int build_address_symbolic (struct gdbarch
*,
330 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
331 extern const char *pc_prefix (CORE_ADDR
);
335 /* See openp function definition for their description. */
336 #define OPF_TRY_CWD_FIRST 0x01
337 #define OPF_SEARCH_IN_PATH 0x02
338 #define OPF_RETURN_REALPATH 0x04
340 extern int openp (const char *, int, const char *, int, char **);
342 extern int source_full_path_of (const char *, char **);
344 extern void mod_path (char *, char **);
346 extern void add_path (char *, char **, int);
348 extern void directory_switch (char *, int);
350 extern char *source_path
;
352 extern void init_source_path (void);
356 /* * Process memory area starting at ADDR with length SIZE. Area is
357 readable iff READ is non-zero, writable if WRITE is non-zero,
358 executable if EXEC is non-zero. Area is possibly changed against
359 its original file based copy if MODIFIED is non-zero. DATA is
360 passed without changes from a caller. */
362 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
363 int read
, int write
, int exec
,
364 int modified
, void *data
);
366 /* * Possible lvalue types. Like enum language, this should be in
367 value.h, but needs to be here for the same reason. */
375 /* * In a register. Registers are relative to a frame. */
377 /* * In a gdb internal variable. */
379 /* * Value encapsulates a callable defined in an extension language. */
381 /* * Part of a gdb internal variable (structure field). */
382 lval_internalvar_component
,
383 /* * Value's bits are fetched and stored using functions provided
388 /* * Control types for commands. */
390 enum misc_command_type
398 enum command_control_type
408 while_stepping_control
,
412 /* * Structure for saved commands lines (for breakpoints, defined
417 struct command_line
*next
;
419 enum command_control_type control_type
;
420 /* * The number of elements in body_list. */
422 /* * For composite commands, the nested lists of commands. For
423 example, for "if" command this will contain the then branch and
424 the else branch, if that is available. */
425 struct command_line
**body_list
;
428 extern struct command_line
*read_command_lines (char *, int, int,
429 void (*)(char *, void *),
431 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
432 void (*)(char *, void *),
435 extern void free_command_lines (struct command_line
**);
437 /* * Parameters of the "info proc" command. */
441 /* * Display the default cmdline, cwd and exe outputs. */
444 /* * Display `info proc mappings'. */
447 /* * Display `info proc status'. */
450 /* * Display `info proc stat'. */
453 /* * Display `info proc cmdline'. */
456 /* * Display `info proc exe'. */
459 /* * Display `info proc cwd'. */
462 /* * Display all of the above. */
466 /* * String containing the current directory (what getwd would return). */
468 extern char *current_directory
;
470 /* * Default radixes for input and output. Only some values supported. */
471 extern unsigned input_radix
;
472 extern unsigned output_radix
;
474 /* * Possibilities for prettyformat parameters to routines which print
475 things. Like enum language, this should be in value.h, but needs
476 to be here for the same reason. FIXME: If we can eliminate this
477 as an arg to LA_VAL_PRINT, then we can probably move it back to
480 enum val_prettyformat
482 Val_no_prettyformat
= 0,
484 /* * Use the default setting which the user has specified. */
485 Val_prettyformat_default
488 /* * Optional native machine support. Non-native (and possibly pure
489 multi-arch) targets do not need a "nm.h" file. This will be a
490 symlink to one of the nm-*.h files, built by the `configure'
497 /* Assume that fopen accepts the letter "b" in the mode string.
498 It is demanded by ISO C9X, and should be supported on all
499 platforms that claim to have a standard-conforming C library. On
500 true POSIX systems it will be ignored and have no effect. There
501 may still be systems without a standard-conforming C library where
502 an ISO C9X compiler (GCC) is available. Known examples are SunOS
503 4.x and 4.3BSD. This assumption means these systems are no longer
506 # include "fopen-bin.h"
509 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
510 FIXME: Assumes 2's complement arithmetic. */
512 #if !defined (UINT_MAX)
513 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
516 #if !defined (INT_MAX)
517 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
520 #if !defined (INT_MIN)
521 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
524 #if !defined (ULONG_MAX)
525 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
528 #if !defined (LONG_MAX)
529 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
532 #if !defined (ULONGEST_MAX)
533 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
536 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
537 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
540 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
541 arguments to a function, number in a value history, register number, etc.)
542 where the value must not be larger than can fit in an int. */
544 extern int longest_to_int (LONGEST
);
546 #include "common-utils.h"
548 /* * List of known OS ABIs. If you change this, make sure to update the
552 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
554 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
561 GDB_OSABI_FREEBSD_AOUT
,
562 GDB_OSABI_FREEBSD_ELF
,
563 GDB_OSABI_NETBSD_AOUT
,
564 GDB_OSABI_NETBSD_ELF
,
565 GDB_OSABI_OPENBSD_ELF
,
581 GDB_OSABI_INVALID
/* keep this last */
584 /* Global functions from other, non-gdb GNU thingies.
585 Libiberty thingies are no longer declared here. We include libiberty.h
588 /* From other system libraries */
591 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
594 /* Various possibilities for alloca. */
597 #define alloca __builtin_alloca
598 #else /* Not GNU C */
606 /* We need to be careful not to declare this in a way which conflicts with
607 bison. Bison never declares it as char *, but under various circumstances
608 (like __hpux) we need to use void *. */
609 extern void *alloca ();
610 #endif /* Not _AIX */
611 #endif /* Not HAVE_ALLOCA_H */
612 #endif /* Not GNU C */
613 #endif /* alloca not defined */
615 /* Dynamic target-system-dependent parameters for GDB. */
618 /* * Maximum size of a register. Something small, but large enough for
619 all known ISAs. If it turns out to be too small, make it bigger. */
621 enum { MAX_REGISTER_SIZE
= 64 };
623 /* Static target-system-dependent parameters for GDB. */
625 /* * Number of bits in a char or unsigned char for the target machine.
626 Just like CHAR_BIT in <limits.h> but describes the target machine. */
627 #if !defined (TARGET_CHAR_BIT)
628 #define TARGET_CHAR_BIT 8
631 /* * If we picked up a copy of CHAR_BIT from a configuration file
632 (which may get it by including <limits.h>) then use it to set
633 the number of bits in a host char. If not, use the same size
636 #if defined (CHAR_BIT)
637 #define HOST_CHAR_BIT CHAR_BIT
639 #define HOST_CHAR_BIT TARGET_CHAR_BIT
644 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
647 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
650 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
651 enum bfd_endian
, LONGEST
*);
653 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
656 extern void store_signed_integer (gdb_byte
*, int,
657 enum bfd_endian
, LONGEST
);
659 extern void store_unsigned_integer (gdb_byte
*, int,
660 enum bfd_endian
, ULONGEST
);
662 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
670 /* Hooks for alternate command interfaces. */
672 /* * The name of the interpreter if specified on the command line. */
673 extern char *interpreter_p
;
675 /* If a given interpreter matches INTERPRETER_P then it should update
676 deprecated_init_ui_hook with the per-interpreter implementation. */
677 /* FIXME: deprecated_init_ui_hook should be moved here. */
679 struct target_waitstatus
;
680 struct cmd_list_element
;
682 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
683 extern void (*deprecated_post_add_symbol_hook
) (void);
684 extern void (*selected_frame_level_changed_hook
) (int);
685 extern int (*deprecated_ui_loop_hook
) (int signo
);
686 extern void (*deprecated_init_ui_hook
) (char *argv0
);
687 extern void (*deprecated_show_load_progress
) (const char *section
,
688 unsigned long section_sent
,
689 unsigned long section_size
,
690 unsigned long total_sent
,
691 unsigned long total_size
);
692 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
696 extern int (*deprecated_query_hook
) (const char *, va_list)
697 ATTRIBUTE_FPTR_PRINTF(1,0);
698 extern void (*deprecated_warning_hook
) (const char *, va_list)
699 ATTRIBUTE_FPTR_PRINTF(1,0);
700 extern void (*deprecated_interactive_hook
) (void);
701 extern void (*deprecated_readline_begin_hook
) (char *, ...)
702 ATTRIBUTE_FPTR_PRINTF_1
;
703 extern char *(*deprecated_readline_hook
) (char *);
704 extern void (*deprecated_readline_end_hook
) (void);
705 extern void (*deprecated_register_changed_hook
) (int regno
);
706 extern void (*deprecated_context_hook
) (int);
707 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
708 struct target_waitstatus
*status
,
711 extern void (*deprecated_attach_hook
) (void);
712 extern void (*deprecated_detach_hook
) (void);
713 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
714 char *cmd
, int from_tty
);
716 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
719 /* If this definition isn't overridden by the header files, assume
720 that isatty and fileno exist on this system. */
722 #define ISATTY(FP) (isatty (fileno (FP)))
725 /* * A width that can achieve a better legibility for GDB MI mode. */
726 #define GDB_MI_MSG_WIDTH 80
728 /* From progspace.c */
730 extern void initialize_progspace (void);
731 extern void initialize_inferiors (void);
733 /* * Special block numbers */
739 FIRST_LOCAL_BLOCK
= 2
744 #endif /* #ifndef DEFS_H */