1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
3 /* Basic, host-specific, and target-specific definitions for GDB.
4 Copyright (C) 1986, 1988-2005, 2007-2012 Free Software Foundation,
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 # error gdbserver should not include gdb/defs.h
29 #include "config.h" /* Generated by configure. */
30 #include "build-gnulib/config.h"
32 #include <sys/types.h>
34 #include <errno.h> /* System call error return status. */
38 /* The libdecnumber library, on which GDB depends, includes a header file
39 called gstdint.h instead of relying directly on stdint.h. GDB, on the
40 other hand, includes stdint.h directly, relying on the fact that gnulib
41 generates a copy if the system doesn't provide one or if it is missing
42 some features. Unfortunately, gstdint.h and stdint.h cannot be included
43 at the same time, which may happen when we include a file from
46 The following macro definition effectively prevents the inclusion of
47 gstdint.h, as all the definitions it provides are guarded against
48 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
49 included, so it's ok to blank out gstdint.h. */
50 #define GCC_GENERATED_STDINT_H 1
62 /* First include ansidecl.h so we can use the various macro definitions
63 here and in all subsequent file inclusions. */
67 #include "gdb_locale.h"
69 #include "gdb_wchar.h"
71 /* For ``enum gdb_signal''. */
72 #include "gdb/signals.h"
76 #include "host-defs.h"
78 /* Just in case they're not defined in stdio.h. */
87 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
88 It is used as an access modifier in calls to open(), where it acts
89 similarly to the "b" character in fopen()'s MODE argument. On Posix
90 platforms it should be a no-op, so it is defined as 0 here. This
91 ensures that the symbol may be used freely elsewhere in gdb. */
97 #include <stdarg.h> /* For va_list. */
99 #include "libiberty.h"
102 /* Rather than duplicate all the logic in BFD for figuring out what
103 types to use (which can be pretty complicated), symply define them
104 in terms of the corresponding type from BFD. */
108 /* A byte from the program being debugged. */
109 typedef bfd_byte gdb_byte;
111 /* An address in the program being debugged. Host byte order. */
112 typedef bfd_vma CORE_ADDR;
114 /* The largest CORE_ADDR value. */
115 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
117 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
123 #define LONGEST BFD_HOST_64_BIT
124 #define ULONGEST BFD_HOST_U_64_BIT
128 #ifdef CC_HAS_LONG_LONG
129 #define LONGEST long long
130 #define ULONGEST unsigned long long
132 #ifdef BFD_HOST_64_BIT
133 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
134 (e.g. i386-windows) so try it. */
135 #define LONGEST BFD_HOST_64_BIT
136 #define ULONGEST BFD_HOST_U_64_BIT
139 #define ULONGEST unsigned long
143 #endif /* No BFD64 */
145 #endif /* ! LONGEST */
148 #define min(a, b) ((a) < (b) ? (a) : (b))
151 #define max(a, b) ((a) > (b) ? (a) : (b))
156 /* Enable xdb commands if set. */
157 extern int xdb_commands;
159 /* Enable dbx commands if set. */
160 extern int dbx_commands;
162 /* System root path, used to find libraries etc. */
163 extern char *gdb_sysroot;
165 /* GDB datadir, used to store data files. */
166 extern char *gdb_datadir;
168 /* If non-NULL, the possibly relocated path to python's "lib" directory
169 specified with --with-python. */
170 extern char *python_libdir;
172 /* Search path for separate debug files. */
173 extern char *debug_file_directory;
175 /* GDB has two methods for handling SIGINT. When immediate_quit is
176 nonzero, a SIGINT results in an immediate longjmp out of the signal
177 handler. Otherwise, SIGINT simply sets a flag; code that might
178 take a long time, and which ought to be interruptible, checks this
179 flag using the QUIT macro.
181 If GDB is built with Python support, it uses Python's low-level
182 interface to implement the flag. This approach makes it possible
183 for Python and GDB SIGINT handling to coexist seamlessly.
185 If GDB is built without Python, it instead uses its traditional
188 /* Clear the quit flag. */
189 extern void clear_quit_flag (void);
190 /* Evaluate to non-zero if the quit flag is set, zero otherwise. This
191 will clear the quit flag as a side effect. */
192 extern int check_quit_flag (void);
193 /* Set the quit flag. */
194 extern void set_quit_flag (void);
196 extern int immediate_quit;
198 extern void quit (void);
200 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
201 benefits of having a ``QUIT'' macro rather than a function are
202 marginal. If the overhead of a QUIT function call is proving
203 significant then its calling frequency should probably be reduced
204 [kingdon]. A profile analyzing the current situtation is
208 if (check_quit_flag ()) quit (); \
209 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
212 /* Languages represented in the symbol table and elsewhere.
213 This should probably be in language.h, but since enum's can't
214 be forward declared to satisfy opaque references before their
215 actual definition, needs to be here. */
219 language_unknown, /* Language not known */
220 language_auto, /* Placeholder for automatic setting */
222 language_cplus, /* C++ */
224 language_go, /* Go */
225 language_objc, /* Objective-C */
226 language_java, /* Java */
227 language_fortran, /* Fortran */
228 language_m2, /* Modula-2 */
229 language_asm, /* Assembly language */
230 language_pascal, /* Pascal */
231 language_ada, /* Ada */
232 language_opencl, /* OpenCL */
233 language_minimal, /* All other languages, minimal support only */
241 unspecified_precision
244 /* A generic, not quite boolean, enumeration. */
252 /* Potential ways that a function can return a value of a given type. */
253 enum return_value_convention
255 /* Where the return value has been squeezed into one or more
257 RETURN_VALUE_REGISTER_CONVENTION,
258 /* Commonly known as the "struct return convention". The caller
259 passes an additional hidden first parameter to the caller. That
260 parameter contains the address at which the value being returned
261 should be stored. While typically, and historically, used for
262 large structs, this is convention is applied to values of many
264 RETURN_VALUE_STRUCT_CONVENTION,
265 /* Like the "struct return convention" above, but where the ABI
266 guarantees that the called function stores the address at which
267 the value being returned is stored in a well-defined location,
268 such as a register or memory slot in the stack frame. Don't use
269 this if the ABI doesn't explicitly guarantees this. */
270 RETURN_VALUE_ABI_RETURNS_ADDRESS,
271 /* Like the "struct return convention" above, but where the ABI
272 guarantees that the address at which the value being returned is
273 stored will be available in a well-defined location, such as a
274 register or memory slot in the stack frame. Don't use this if
275 the ABI doesn't explicitly guarantees this. */
276 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
279 /* Needed for various prototypes */
289 /* This really belong in utils.c (path-utils.c?), but it references some
290 globals that are currently only available to main.c. */
291 extern char *relocate_gdb_directory (const char *initial, int flag);
294 /* Annotation stuff. */
296 extern int annotation_level; /* in stack.c */
299 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
300 "const char *" in unistd.h, so we can't declare the argument
303 extern char *re_comp (const char *);
307 extern void symbol_file_command (char *, int);
309 /* Remote targets may wish to use this as their load function. */
310 extern void generic_load (char *name, int from_tty);
312 /* Report on STREAM the performance of memory transfer operation,
314 DATA_COUNT is the number of bytes transferred.
315 WRITE_COUNT is the number of separate write operations, or 0,
316 if that information is not available.
317 START_TIME is the time at which an operation was started.
318 END_TIME is the time at which an operation ended. */
320 extern void print_transfer_performance (struct ui_file *stream,
321 unsigned long data_count,
322 unsigned long write_count,
323 const struct timeval *start_time,
324 const struct timeval *end_time);
328 typedef void initialize_file_ftype (void);
330 extern char *skip_quoted (char *);
332 extern char *gdb_readline (char *);
334 extern char *gdb_readline_wrapper (char *);
336 extern char *command_line_input (char *, int, char *);
338 extern void print_prompt (void);
340 extern int input_from_terminal_p (void);
342 extern int info_verbose;
344 /* From printcmd.c */
346 extern void set_next_address (struct gdbarch *, CORE_ADDR);
348 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
349 struct ui_file *, int, char *);
351 extern int build_address_symbolic (struct gdbarch *,
360 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
361 extern const char *pc_prefix (CORE_ADDR);
365 #define OPF_TRY_CWD_FIRST 0x01
366 #define OPF_SEARCH_IN_PATH 0x02
368 extern int openp (const char *, int, const char *, int, char **);
370 extern int source_full_path_of (const char *, char **);
372 extern void mod_path (char *, char **);
374 extern void add_path (char *, char **, int);
376 extern void directory_command (char *, int);
378 extern void directory_switch (char *, int);
380 extern char *source_path;
382 extern void init_source_path (void);
386 /* Process memory area starting at ADDR with length SIZE. Area is readable iff
387 READ is non-zero, writable if WRITE is non-zero, executable if EXEC is
388 non-zero. Area is possibly changed against its original file based copy if
389 MODIFIED is non-zero. DATA is passed without changes from a caller. */
391 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
392 int read, int write, int exec,
393 int modified, void *data);
395 /* Take over the 'find_mapped_memory' vector from exec.c. */
396 extern void exec_set_find_memory_regions
397 (int (*func) (find_memory_region_ftype func, void *data));
399 /* Possible lvalue types. Like enum language, this should be in
400 value.h, but needs to be here for the same reason. */
408 /* In a register. Registers are relative to a frame. */
410 /* In a gdb internal variable. */
412 /* Part of a gdb internal variable (structure field). */
413 lval_internalvar_component,
414 /* Value's bits are fetched and stored using functions provided by
419 /* Control types for commands */
421 enum misc_command_type
429 enum command_control_type
438 while_stepping_control,
442 /* Structure for saved commands lines
443 (for breakpoints, defined commands, etc). */
447 struct command_line *next;
449 enum command_control_type control_type;
450 /* The number of elements in body_list. */
452 /* For composite commands, the nested lists of commands. For
453 example, for "if" command this will contain the then branch and
454 the else branch, if that is available. */
455 struct command_line **body_list;
458 extern struct command_line *read_command_lines (char *, int, int,
459 void (*)(char *, void *),
461 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
462 void (*)(char *, void *),
465 extern void free_command_lines (struct command_line **);
467 /* Parameters of the "info proc" command. */
471 /* Display the default cmdline, cwd and exe outputs. */
474 /* Display `info proc mappings'. */
477 /* Display `info proc status'. */
480 /* Display `info proc stat'. */
483 /* Display `info proc cmdline'. */
486 /* Display `info proc exe'. */
489 /* Display `info proc cwd'. */
492 /* Display all of the above. */
496 /* String containing the current directory (what getwd would return). */
498 extern char *current_directory;
500 /* Default radixes for input and output. Only some values supported. */
501 extern unsigned input_radix;
502 extern unsigned output_radix;
504 /* Possibilities for prettyprint parameters to routines which print
505 things. Like enum language, this should be in value.h, but needs
506 to be here for the same reason. FIXME: If we can eliminate this
507 as an arg to LA_VAL_PRINT, then we can probably move it back to
512 Val_no_prettyprint = 0,
514 /* Use the default setting which the user has specified. */
518 /* Optional native machine support. Non-native (and possibly pure
519 multi-arch) targets do not need a "nm.h" file. This will be a
520 symlink to one of the nm-*.h files, built by the `configure'
527 /* Assume that fopen accepts the letter "b" in the mode string.
528 It is demanded by ISO C9X, and should be supported on all
529 platforms that claim to have a standard-conforming C library. On
530 true POSIX systems it will be ignored and have no effect. There
531 may still be systems without a standard-conforming C library where
532 an ISO C9X compiler (GCC) is available. Known examples are SunOS
533 4.x and 4.3BSD. This assumption means these systems are no longer
536 # include "fopen-bin.h"
539 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
540 FIXME: Assumes 2's complement arithmetic. */
542 #if !defined (UINT_MAX)
543 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
546 #if !defined (INT_MAX)
547 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
550 #if !defined (INT_MIN)
551 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
554 #if !defined (ULONG_MAX)
555 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
558 #if !defined (LONG_MAX)
559 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
562 #if !defined (ULONGEST_MAX)
563 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
566 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
567 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
570 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
571 arguments to a function, number in a value history, register number, etc.)
572 where the value must not be larger than can fit in an int. */
574 extern int longest_to_int (LONGEST);
576 /* Utility macros to allocate typed memory. Avoids errors like:
577 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
578 sizeof (struct foo), 0). */
579 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
580 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
581 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
583 #include "common-utils.h"
585 /* List of known OS ABIs. If you change this, make sure to update the
589 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
591 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
598 GDB_OSABI_FREEBSD_AOUT,
599 GDB_OSABI_FREEBSD_ELF,
600 GDB_OSABI_NETBSD_AOUT,
601 GDB_OSABI_NETBSD_ELF,
602 GDB_OSABI_OPENBSD_ELF,
617 GDB_OSABI_INVALID /* keep this last */
620 /* Global functions from other, non-gdb GNU thingies.
621 Libiberty thingies are no longer declared here. We include libiberty.h
624 /* From other system libraries */
634 #define min(a, b) ((a) < (b) ? (a) : (b))
637 #define max(a, b) ((a) > (b) ? (a) : (b))
642 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
645 /* Various possibilities for alloca. */
648 #define alloca __builtin_alloca
649 #else /* Not GNU C */
657 /* We need to be careful not to declare this in a way which conflicts with
658 bison. Bison never declares it as char *, but under various circumstances
659 (like __hpux) we need to use void *. */
660 extern void *alloca ();
661 #endif /* Not _AIX */
662 #endif /* Not HAVE_ALLOCA_H */
663 #endif /* Not GNU C */
664 #endif /* alloca not defined */
666 /* Dynamic target-system-dependent parameters for GDB. */
669 /* Maximum size of a register. Something small, but large enough for
670 all known ISAs. If it turns out to be too small, make it bigger. */
672 enum { MAX_REGISTER_SIZE = 64 };
674 /* Static target-system-dependent parameters for GDB. */
676 /* Number of bits in a char or unsigned char for the target machine.
677 Just like CHAR_BIT in <limits.h> but describes the target machine. */
678 #if !defined (TARGET_CHAR_BIT)
679 #define TARGET_CHAR_BIT 8
682 /* If we picked up a copy of CHAR_BIT from a configuration file
683 (which may get it by including <limits.h>) then use it to set
684 the number of bits in a host char. If not, use the same size
687 #if defined (CHAR_BIT)
688 #define HOST_CHAR_BIT CHAR_BIT
690 #define HOST_CHAR_BIT TARGET_CHAR_BIT
695 extern LONGEST extract_signed_integer (const gdb_byte *, int,
698 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
701 extern int extract_long_unsigned_integer (const gdb_byte *, int,
702 enum bfd_endian, LONGEST *);
704 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
707 extern void store_signed_integer (gdb_byte *, int,
708 enum bfd_endian, LONGEST);
710 extern void store_unsigned_integer (gdb_byte *, int,
711 enum bfd_endian, ULONGEST);
713 extern void store_typed_address (gdb_byte *buf, struct type *type,
721 /* Hooks for alternate command interfaces. */
723 /* The name of the interpreter if specified on the command line. */
724 extern char *interpreter_p;
726 /* If a given interpreter matches INTERPRETER_P then it should update
727 deprecated_command_loop_hook and deprecated_init_ui_hook with the
728 per-interpreter implementation. */
729 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
730 should be moved here. */
732 struct target_waitstatus;
733 struct cmd_list_element;
735 extern void (*deprecated_pre_add_symbol_hook) (const char *);
736 extern void (*deprecated_post_add_symbol_hook) (void);
737 extern void (*selected_frame_level_changed_hook) (int);
738 extern int (*deprecated_ui_loop_hook) (int signo);
739 extern void (*deprecated_init_ui_hook) (char *argv0);
740 extern void (*deprecated_command_loop_hook) (void);
741 extern void (*deprecated_show_load_progress) (const char *section,
742 unsigned long section_sent,
743 unsigned long section_size,
744 unsigned long total_sent,
745 unsigned long total_size);
746 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
750 extern int (*deprecated_query_hook) (const char *, va_list)
751 ATTRIBUTE_FPTR_PRINTF(1,0);
752 extern void (*deprecated_warning_hook) (const char *, va_list)
753 ATTRIBUTE_FPTR_PRINTF(1,0);
754 extern void (*deprecated_flush_hook) (struct ui_file * stream);
755 extern void (*deprecated_interactive_hook) (void);
756 extern void (*deprecated_readline_begin_hook) (char *, ...)
757 ATTRIBUTE_FPTR_PRINTF_1;
758 extern char *(*deprecated_readline_hook) (char *);
759 extern void (*deprecated_readline_end_hook) (void);
760 extern void (*deprecated_register_changed_hook) (int regno);
761 extern void (*deprecated_context_hook) (int);
762 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
763 struct target_waitstatus *status,
766 extern void (*deprecated_attach_hook) (void);
767 extern void (*deprecated_detach_hook) (void);
768 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
769 char *cmd, int from_tty);
771 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
773 extern int (*deprecated_ui_load_progress_hook) (const char *section,
776 /* Inhibit window interface if non-zero. */
778 extern int use_windows;
780 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
781 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
782 in the code actually refer to a lightweight process id, i.e,
783 something that can be considered a process id in its own right for
787 #define PIDGET(PTID) (ptid_get_pid (PTID))
788 #define TIDGET(PTID) (ptid_get_lwp (PTID))
789 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
792 /* Define well known filenos if the system does not define them. */
794 #define STDIN_FILENO 0
796 #ifndef STDOUT_FILENO
797 #define STDOUT_FILENO 1
799 #ifndef STDERR_FILENO
800 #define STDERR_FILENO 2
803 /* If this definition isn't overridden by the header files, assume
804 that isatty and fileno exist on this system. */
806 #define ISATTY(FP) (isatty (fileno (FP)))
809 /* A width that can achieve a better legibility for GDB MI mode. */
810 #define GDB_MI_MSG_WIDTH 80
812 /* From progspace.c */
814 extern void initialize_progspace (void);
815 extern void initialize_inferiors (void);
817 /* Special block numbers */
823 FIRST_LOCAL_BLOCK = 2
828 #endif /* #ifndef DEFS_H */