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"
57 /* For ``enum gdb_signal''. */
58 #include "gdb/signals.h"
62 #include "host-defs.h"
64 /* Just in case they're not defined in stdio.h. */
73 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
74 It is used as an access modifier in calls to open(), where it acts
75 similarly to the "b" character in fopen()'s MODE argument. On Posix
76 platforms it should be a no-op, so it is defined as 0 here. This
77 ensures that the symbol may be used freely elsewhere in gdb. */
85 /* Rather than duplicate all the logic in BFD for figuring out what
86 types to use (which can be pretty complicated), symply define them
87 in terms of the corresponding type from BFD. */
91 /* * A byte from the program being debugged. */
92 typedef bfd_byte gdb_byte;
94 /* * An address in the program being debugged. Host byte order. */
95 typedef bfd_vma CORE_ADDR;
97 /* * The largest CORE_ADDR value. */
98 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
100 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
104 #define LONGEST BFD_HOST_64_BIT
105 #define ULONGEST BFD_HOST_U_64_BIT
109 #define LONGEST long long
110 #define ULONGEST unsigned long long
112 #endif /* No BFD64 */
115 #define min(a, b) ((a) < (b) ? (a) : (b))
118 #define max(a, b) ((a) > (b) ? (a) : (b))
123 /* * Enable xdb commands if set. */
124 extern int xdb_commands;
126 /* * Enable dbx commands if set. */
127 extern int dbx_commands;
129 /* * System root path, used to find libraries etc. */
130 extern char *gdb_sysroot;
132 /* * GDB datadir, used to store data files. */
133 extern char *gdb_datadir;
135 /* * If non-NULL, the possibly relocated path to python's "lib" directory
136 specified with --with-python. */
137 extern char *python_libdir;
139 /* * Search path for separate debug files. */
140 extern char *debug_file_directory;
142 /* GDB has two methods for handling SIGINT. When immediate_quit is
143 nonzero, a SIGINT results in an immediate longjmp out of the signal
144 handler. Otherwise, SIGINT simply sets a flag; code that might
145 take a long time, and which ought to be interruptible, checks this
146 flag using the QUIT macro.
148 These functions use the extension_language_ops API to allow extension
149 language(s) and GDB SIGINT handling to coexist seamlessly. */
151 /* * Clear the quit flag. */
152 extern void clear_quit_flag (void);
153 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
154 will clear the quit flag as a side effect. */
155 extern int check_quit_flag (void);
156 /* * Set the quit flag. */
157 extern void set_quit_flag (void);
159 /* Flag that function quit should call quit_force. */
160 extern volatile int sync_quit_force_run;
162 extern int immediate_quit;
164 extern void quit (void);
166 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
167 benefits of having a ``QUIT'' macro rather than a function are
168 marginal. If the overhead of a QUIT function call is proving
169 significant then its calling frequency should probably be reduced
170 [kingdon]. A profile analyzing the current situtation is
174 if (check_quit_flag () || sync_quit_force_run) quit (); \
175 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
178 /* * Languages represented in the symbol table and elsewhere.
179 This should probably be in language.h, but since enum's can't
180 be forward declared to satisfy opaque references before their
181 actual definition, needs to be here. */
185 language_unknown, /* Language not known */
186 language_auto, /* Placeholder for automatic setting */
188 language_cplus, /* C++ */
190 language_go, /* Go */
191 language_objc, /* Objective-C */
192 language_java, /* Java */
193 language_fortran, /* Fortran */
194 language_m2, /* Modula-2 */
195 language_asm, /* Assembly language */
196 language_pascal, /* Pascal */
197 language_ada, /* Ada */
198 language_opencl, /* OpenCL */
199 language_minimal, /* All other languages, minimal support only */
207 unspecified_precision
210 /* * A generic, not quite boolean, enumeration. This is used for
211 set/show commands in which the options are on/off/automatic. */
219 /* * Potential ways that a function can return a value of a given
222 enum return_value_convention
224 /* * Where the return value has been squeezed into one or more
226 RETURN_VALUE_REGISTER_CONVENTION,
227 /* * Commonly known as the "struct return convention". The caller
228 passes an additional hidden first parameter to the caller. That
229 parameter contains the address at which the value being returned
230 should be stored. While typically, and historically, used for
231 large structs, this is convention is applied to values of many
233 RETURN_VALUE_STRUCT_CONVENTION,
234 /* * Like the "struct return convention" above, but where the ABI
235 guarantees that the called function stores the address at which
236 the value being returned is stored in a well-defined location,
237 such as a register or memory slot in the stack frame. Don't use
238 this if the ABI doesn't explicitly guarantees this. */
239 RETURN_VALUE_ABI_RETURNS_ADDRESS,
240 /* * Like the "struct return convention" above, but where the ABI
241 guarantees that the address at which the value being returned is
242 stored will be available in a well-defined location, such as a
243 register or memory slot in the stack frame. Don't use this if
244 the ABI doesn't explicitly guarantees this. */
245 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
248 /* Needed for various prototypes */
258 /* This really belong in utils.c (path-utils.c?), but it references some
259 globals that are currently only available to main.c. */
260 extern char *relocate_gdb_directory (const char *initial, int flag);
263 /* Annotation stuff. */
265 extern int annotation_level; /* in stack.c */
268 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
269 "const char *" in unistd.h, so we can't declare the argument
272 extern char *re_comp (const char *);
276 extern void symbol_file_command (char *, int);
278 /* * Remote targets may wish to use this as their load function. */
279 extern void generic_load (const char *name, int from_tty);
281 /* * Report on STREAM the performance of memory transfer operation,
283 @param DATA_COUNT is the number of bytes transferred.
284 @param WRITE_COUNT is the number of separate write operations, or 0,
285 if that information is not available.
286 @param START_TIME is the time at which an operation was started.
287 @param END_TIME is the time at which an operation ended. */
289 extern void print_transfer_performance (struct ui_file *stream,
290 unsigned long data_count,
291 unsigned long write_count,
292 const struct timeval *start_time,
293 const struct timeval *end_time);
297 typedef void initialize_file_ftype (void);
299 extern char *gdb_readline (char *);
301 extern char *gdb_readline_wrapper (char *);
303 extern char *command_line_input (char *, int, char *);
305 extern void print_prompt (void);
307 extern int input_from_terminal_p (void);
309 extern int info_verbose;
311 /* From printcmd.c */
313 extern void set_next_address (struct gdbarch *, CORE_ADDR);
315 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
316 struct ui_file *, int, char *);
318 extern int build_address_symbolic (struct gdbarch *,
327 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
328 extern const char *pc_prefix (CORE_ADDR);
332 /* See openp function definition for their description. */
333 #define OPF_TRY_CWD_FIRST 0x01
334 #define OPF_SEARCH_IN_PATH 0x02
335 #define OPF_RETURN_REALPATH 0x04
337 extern int openp (const char *, int, const char *, int, char **);
339 extern int source_full_path_of (const char *, char **);
341 extern void mod_path (char *, char **);
343 extern void add_path (char *, char **, int);
345 extern void directory_switch (char *, int);
347 extern char *source_path;
349 extern void init_source_path (void);
353 /* * Process memory area starting at ADDR with length SIZE. Area is
354 readable iff READ is non-zero, writable if WRITE is non-zero,
355 executable if EXEC is non-zero. Area is possibly changed against
356 its original file based copy if MODIFIED is non-zero. DATA is
357 passed without changes from a caller. */
359 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
360 int read, int write, int exec,
361 int modified, void *data);
363 /* * Possible lvalue types. Like enum language, this should be in
364 value.h, but needs to be here for the same reason. */
372 /* * In a register. Registers are relative to a frame. */
374 /* * In a gdb internal variable. */
376 /* * Value encapsulates a callable defined in an extension language. */
378 /* * Part of a gdb internal variable (structure field). */
379 lval_internalvar_component,
380 /* * Value's bits are fetched and stored using functions provided
385 /* * Control types for commands. */
387 enum misc_command_type
395 enum command_control_type
405 while_stepping_control,
409 /* * Structure for saved commands lines (for breakpoints, defined
414 struct command_line *next;
416 enum command_control_type control_type;
417 /* * The number of elements in body_list. */
419 /* * For composite commands, the nested lists of commands. For
420 example, for "if" command this will contain the then branch and
421 the else branch, if that is available. */
422 struct command_line **body_list;
425 extern struct command_line *read_command_lines (char *, int, int,
426 void (*)(char *, void *),
428 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
429 void (*)(char *, void *),
432 extern void free_command_lines (struct command_line **);
434 /* * Parameters of the "info proc" command. */
438 /* * Display the default cmdline, cwd and exe outputs. */
441 /* * Display `info proc mappings'. */
444 /* * Display `info proc status'. */
447 /* * Display `info proc stat'. */
450 /* * Display `info proc cmdline'. */
453 /* * Display `info proc exe'. */
456 /* * Display `info proc cwd'. */
459 /* * Display all of the above. */
463 /* * String containing the current directory (what getwd would return). */
465 extern char *current_directory;
467 /* * Default radixes for input and output. Only some values supported. */
468 extern unsigned input_radix;
469 extern unsigned output_radix;
471 /* * Possibilities for prettyformat parameters to routines which print
472 things. Like enum language, this should be in value.h, but needs
473 to be here for the same reason. FIXME: If we can eliminate this
474 as an arg to LA_VAL_PRINT, then we can probably move it back to
477 enum val_prettyformat
479 Val_no_prettyformat = 0,
481 /* * Use the default setting which the user has specified. */
482 Val_prettyformat_default
485 /* * Optional native machine support. Non-native (and possibly pure
486 multi-arch) targets do not need a "nm.h" file. This will be a
487 symlink to one of the nm-*.h files, built by the `configure'
494 /* Assume that fopen accepts the letter "b" in the mode string.
495 It is demanded by ISO C9X, and should be supported on all
496 platforms that claim to have a standard-conforming C library. On
497 true POSIX systems it will be ignored and have no effect. There
498 may still be systems without a standard-conforming C library where
499 an ISO C9X compiler (GCC) is available. Known examples are SunOS
500 4.x and 4.3BSD. This assumption means these systems are no longer
503 # include "fopen-bin.h"
506 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
507 FIXME: Assumes 2's complement arithmetic. */
509 #if !defined (UINT_MAX)
510 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
513 #if !defined (INT_MAX)
514 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
517 #if !defined (INT_MIN)
518 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
521 #if !defined (ULONG_MAX)
522 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
525 #if !defined (LONG_MAX)
526 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
529 #if !defined (ULONGEST_MAX)
530 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
533 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
534 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
537 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
538 arguments to a function, number in a value history, register number, etc.)
539 where the value must not be larger than can fit in an int. */
541 extern int longest_to_int (LONGEST);
543 #include "common-utils.h"
545 /* * List of known OS ABIs. If you change this, make sure to update the
549 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
551 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
558 GDB_OSABI_FREEBSD_AOUT,
559 GDB_OSABI_FREEBSD_ELF,
560 GDB_OSABI_NETBSD_AOUT,
561 GDB_OSABI_NETBSD_ELF,
562 GDB_OSABI_OPENBSD_ELF,
578 GDB_OSABI_INVALID /* keep this last */
581 /* Global functions from other, non-gdb GNU thingies.
582 Libiberty thingies are no longer declared here. We include libiberty.h
585 /* From other system libraries */
588 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
591 /* Various possibilities for alloca. */
594 #define alloca __builtin_alloca
595 #else /* Not GNU C */
603 /* We need to be careful not to declare this in a way which conflicts with
604 bison. Bison never declares it as char *, but under various circumstances
605 (like __hpux) we need to use void *. */
606 extern void *alloca ();
607 #endif /* Not _AIX */
608 #endif /* Not HAVE_ALLOCA_H */
609 #endif /* Not GNU C */
610 #endif /* alloca not defined */
612 /* Dynamic target-system-dependent parameters for GDB. */
615 /* * Maximum size of a register. Something small, but large enough for
616 all known ISAs. If it turns out to be too small, make it bigger. */
618 enum { MAX_REGISTER_SIZE = 64 };
620 /* Static target-system-dependent parameters for GDB. */
622 /* * Number of bits in a char or unsigned char for the target machine.
623 Just like CHAR_BIT in <limits.h> but describes the target machine. */
624 #if !defined (TARGET_CHAR_BIT)
625 #define TARGET_CHAR_BIT 8
628 /* * If we picked up a copy of CHAR_BIT from a configuration file
629 (which may get it by including <limits.h>) then use it to set
630 the number of bits in a host char. If not, use the same size
633 #if defined (CHAR_BIT)
634 #define HOST_CHAR_BIT CHAR_BIT
636 #define HOST_CHAR_BIT TARGET_CHAR_BIT
641 extern LONGEST extract_signed_integer (const gdb_byte *, int,
644 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
647 extern int extract_long_unsigned_integer (const gdb_byte *, int,
648 enum bfd_endian, LONGEST *);
650 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
653 extern void store_signed_integer (gdb_byte *, int,
654 enum bfd_endian, LONGEST);
656 extern void store_unsigned_integer (gdb_byte *, int,
657 enum bfd_endian, ULONGEST);
659 extern void store_typed_address (gdb_byte *buf, struct type *type,
667 /* Hooks for alternate command interfaces. */
669 /* * The name of the interpreter if specified on the command line. */
670 extern char *interpreter_p;
672 /* If a given interpreter matches INTERPRETER_P then it should update
673 deprecated_init_ui_hook with the per-interpreter implementation. */
674 /* FIXME: deprecated_init_ui_hook should be moved here. */
676 struct target_waitstatus;
677 struct cmd_list_element;
679 extern void (*deprecated_pre_add_symbol_hook) (const char *);
680 extern void (*deprecated_post_add_symbol_hook) (void);
681 extern void (*selected_frame_level_changed_hook) (int);
682 extern int (*deprecated_ui_loop_hook) (int signo);
683 extern void (*deprecated_init_ui_hook) (char *argv0);
684 extern void (*deprecated_show_load_progress) (const char *section,
685 unsigned long section_sent,
686 unsigned long section_size,
687 unsigned long total_sent,
688 unsigned long total_size);
689 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
693 extern int (*deprecated_query_hook) (const char *, va_list)
694 ATTRIBUTE_FPTR_PRINTF(1,0);
695 extern void (*deprecated_warning_hook) (const char *, va_list)
696 ATTRIBUTE_FPTR_PRINTF(1,0);
697 extern void (*deprecated_interactive_hook) (void);
698 extern void (*deprecated_readline_begin_hook) (char *, ...)
699 ATTRIBUTE_FPTR_PRINTF_1;
700 extern char *(*deprecated_readline_hook) (char *);
701 extern void (*deprecated_readline_end_hook) (void);
702 extern void (*deprecated_register_changed_hook) (int regno);
703 extern void (*deprecated_context_hook) (int);
704 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
705 struct target_waitstatus *status,
708 extern void (*deprecated_attach_hook) (void);
709 extern void (*deprecated_detach_hook) (void);
710 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
711 char *cmd, int from_tty);
713 extern int (*deprecated_ui_load_progress_hook) (const char *section,
716 /* If this definition isn't overridden by the header files, assume
717 that isatty and fileno exist on this system. */
719 #define ISATTY(FP) (isatty (fileno (FP)))
722 /* * A width that can achieve a better legibility for GDB MI mode. */
723 #define GDB_MI_MSG_WIDTH 80
725 /* From progspace.c */
727 extern void initialize_progspace (void);
728 extern void initialize_inferiors (void);
730 /* * Special block numbers */
736 FIRST_LOCAL_BLOCK = 2
741 #endif /* #ifndef DEFS_H */