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 #define LONGEST long long
129 #define ULONGEST unsigned long long
131 #endif /* No BFD64 */
133 #endif /* ! LONGEST */
136 #define min(a, b) ((a) < (b) ? (a) : (b))
139 #define max(a, b) ((a) > (b) ? (a) : (b))
144 /* Enable xdb commands if set. */
145 extern int xdb_commands;
147 /* Enable dbx commands if set. */
148 extern int dbx_commands;
150 /* System root path, used to find libraries etc. */
151 extern char *gdb_sysroot;
153 /* GDB datadir, used to store data files. */
154 extern char *gdb_datadir;
156 /* If non-NULL, the possibly relocated path to python's "lib" directory
157 specified with --with-python. */
158 extern char *python_libdir;
160 /* Search path for separate debug files. */
161 extern char *debug_file_directory;
163 /* GDB has two methods for handling SIGINT. When immediate_quit is
164 nonzero, a SIGINT results in an immediate longjmp out of the signal
165 handler. Otherwise, SIGINT simply sets a flag; code that might
166 take a long time, and which ought to be interruptible, checks this
167 flag using the QUIT macro.
169 If GDB is built with Python support, it uses Python's low-level
170 interface to implement the flag. This approach makes it possible
171 for Python and GDB SIGINT handling to coexist seamlessly.
173 If GDB is built without Python, it instead uses its traditional
176 /* Clear the quit flag. */
177 extern void clear_quit_flag (void);
178 /* Evaluate to non-zero if the quit flag is set, zero otherwise. This
179 will clear the quit flag as a side effect. */
180 extern int check_quit_flag (void);
181 /* Set the quit flag. */
182 extern void set_quit_flag (void);
184 extern int immediate_quit;
186 extern void quit (void);
188 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
189 benefits of having a ``QUIT'' macro rather than a function are
190 marginal. If the overhead of a QUIT function call is proving
191 significant then its calling frequency should probably be reduced
192 [kingdon]. A profile analyzing the current situtation is
196 if (check_quit_flag ()) quit (); \
197 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
200 /* Languages represented in the symbol table and elsewhere.
201 This should probably be in language.h, but since enum's can't
202 be forward declared to satisfy opaque references before their
203 actual definition, needs to be here. */
207 language_unknown, /* Language not known */
208 language_auto, /* Placeholder for automatic setting */
210 language_cplus, /* C++ */
212 language_go, /* Go */
213 language_objc, /* Objective-C */
214 language_java, /* Java */
215 language_fortran, /* Fortran */
216 language_m2, /* Modula-2 */
217 language_asm, /* Assembly language */
218 language_pascal, /* Pascal */
219 language_ada, /* Ada */
220 language_opencl, /* OpenCL */
221 language_minimal, /* All other languages, minimal support only */
229 unspecified_precision
232 /* A generic, not quite boolean, enumeration. */
240 /* Potential ways that a function can return a value of a given type. */
241 enum return_value_convention
243 /* Where the return value has been squeezed into one or more
245 RETURN_VALUE_REGISTER_CONVENTION,
246 /* Commonly known as the "struct return convention". The caller
247 passes an additional hidden first parameter to the caller. That
248 parameter contains the address at which the value being returned
249 should be stored. While typically, and historically, used for
250 large structs, this is convention is applied to values of many
252 RETURN_VALUE_STRUCT_CONVENTION,
253 /* Like the "struct return convention" above, but where the ABI
254 guarantees that the called function stores the address at which
255 the value being returned is stored in a well-defined location,
256 such as a register or memory slot in the stack frame. Don't use
257 this if the ABI doesn't explicitly guarantees this. */
258 RETURN_VALUE_ABI_RETURNS_ADDRESS,
259 /* Like the "struct return convention" above, but where the ABI
260 guarantees that the address at which the value being returned is
261 stored will be available in a well-defined location, such as a
262 register or memory slot in the stack frame. Don't use this if
263 the ABI doesn't explicitly guarantees this. */
264 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
267 /* Needed for various prototypes */
277 /* This really belong in utils.c (path-utils.c?), but it references some
278 globals that are currently only available to main.c. */
279 extern char *relocate_gdb_directory (const char *initial, int flag);
282 /* Annotation stuff. */
284 extern int annotation_level; /* in stack.c */
287 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
288 "const char *" in unistd.h, so we can't declare the argument
291 extern char *re_comp (const char *);
295 extern void symbol_file_command (char *, int);
297 /* Remote targets may wish to use this as their load function. */
298 extern void generic_load (char *name, int from_tty);
300 /* Report on STREAM the performance of memory transfer operation,
302 DATA_COUNT is the number of bytes transferred.
303 WRITE_COUNT is the number of separate write operations, or 0,
304 if that information is not available.
305 START_TIME is the time at which an operation was started.
306 END_TIME is the time at which an operation ended. */
308 extern void print_transfer_performance (struct ui_file *stream,
309 unsigned long data_count,
310 unsigned long write_count,
311 const struct timeval *start_time,
312 const struct timeval *end_time);
316 typedef void initialize_file_ftype (void);
318 extern char *skip_quoted (char *);
320 extern char *gdb_readline (char *);
322 extern char *gdb_readline_wrapper (char *);
324 extern char *command_line_input (char *, int, char *);
326 extern void print_prompt (void);
328 extern int input_from_terminal_p (void);
330 extern int info_verbose;
332 /* From printcmd.c */
334 extern void set_next_address (struct gdbarch *, CORE_ADDR);
336 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
337 struct ui_file *, int, char *);
339 extern int build_address_symbolic (struct gdbarch *,
348 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
349 extern const char *pc_prefix (CORE_ADDR);
353 #define OPF_TRY_CWD_FIRST 0x01
354 #define OPF_SEARCH_IN_PATH 0x02
356 extern int openp (const char *, int, const char *, int, char **);
358 extern int source_full_path_of (const char *, char **);
360 extern void mod_path (char *, char **);
362 extern void add_path (char *, char **, int);
364 extern void directory_command (char *, int);
366 extern void directory_switch (char *, int);
368 extern char *source_path;
370 extern void init_source_path (void);
374 /* Process memory area starting at ADDR with length SIZE. Area is readable iff
375 READ is non-zero, writable if WRITE is non-zero, executable if EXEC is
376 non-zero. Area is possibly changed against its original file based copy if
377 MODIFIED is non-zero. DATA is passed without changes from a caller. */
379 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
380 int read, int write, int exec,
381 int modified, void *data);
383 /* Take over the 'find_mapped_memory' vector from exec.c. */
384 extern void exec_set_find_memory_regions
385 (int (*func) (find_memory_region_ftype func, void *data));
387 /* Possible lvalue types. Like enum language, this should be in
388 value.h, but needs to be here for the same reason. */
396 /* In a register. Registers are relative to a frame. */
398 /* In a gdb internal variable. */
400 /* Part of a gdb internal variable (structure field). */
401 lval_internalvar_component,
402 /* Value's bits are fetched and stored using functions provided by
407 /* Control types for commands */
409 enum misc_command_type
417 enum command_control_type
426 while_stepping_control,
430 /* Structure for saved commands lines
431 (for breakpoints, defined commands, etc). */
435 struct command_line *next;
437 enum command_control_type control_type;
438 /* The number of elements in body_list. */
440 /* For composite commands, the nested lists of commands. For
441 example, for "if" command this will contain the then branch and
442 the else branch, if that is available. */
443 struct command_line **body_list;
446 extern struct command_line *read_command_lines (char *, int, int,
447 void (*)(char *, void *),
449 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
450 void (*)(char *, void *),
453 extern void free_command_lines (struct command_line **);
455 /* Parameters of the "info proc" command. */
459 /* Display the default cmdline, cwd and exe outputs. */
462 /* Display `info proc mappings'. */
465 /* Display `info proc status'. */
468 /* Display `info proc stat'. */
471 /* Display `info proc cmdline'. */
474 /* Display `info proc exe'. */
477 /* Display `info proc cwd'. */
480 /* Display all of the above. */
484 /* String containing the current directory (what getwd would return). */
486 extern char *current_directory;
488 /* Default radixes for input and output. Only some values supported. */
489 extern unsigned input_radix;
490 extern unsigned output_radix;
492 /* Possibilities for prettyprint parameters to routines which print
493 things. Like enum language, this should be in value.h, but needs
494 to be here for the same reason. FIXME: If we can eliminate this
495 as an arg to LA_VAL_PRINT, then we can probably move it back to
500 Val_no_prettyprint = 0,
502 /* Use the default setting which the user has specified. */
506 /* Optional native machine support. Non-native (and possibly pure
507 multi-arch) targets do not need a "nm.h" file. This will be a
508 symlink to one of the nm-*.h files, built by the `configure'
515 /* Assume that fopen accepts the letter "b" in the mode string.
516 It is demanded by ISO C9X, and should be supported on all
517 platforms that claim to have a standard-conforming C library. On
518 true POSIX systems it will be ignored and have no effect. There
519 may still be systems without a standard-conforming C library where
520 an ISO C9X compiler (GCC) is available. Known examples are SunOS
521 4.x and 4.3BSD. This assumption means these systems are no longer
524 # include "fopen-bin.h"
527 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
528 FIXME: Assumes 2's complement arithmetic. */
530 #if !defined (UINT_MAX)
531 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
534 #if !defined (INT_MAX)
535 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
538 #if !defined (INT_MIN)
539 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
542 #if !defined (ULONG_MAX)
543 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
546 #if !defined (LONG_MAX)
547 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
550 #if !defined (ULONGEST_MAX)
551 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
554 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
555 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
558 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
559 arguments to a function, number in a value history, register number, etc.)
560 where the value must not be larger than can fit in an int. */
562 extern int longest_to_int (LONGEST);
564 /* Utility macros to allocate typed memory. Avoids errors like:
565 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
566 sizeof (struct foo), 0). */
567 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
568 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
569 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
571 #include "common-utils.h"
573 /* List of known OS ABIs. If you change this, make sure to update the
577 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
579 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
586 GDB_OSABI_FREEBSD_AOUT,
587 GDB_OSABI_FREEBSD_ELF,
588 GDB_OSABI_NETBSD_AOUT,
589 GDB_OSABI_NETBSD_ELF,
590 GDB_OSABI_OPENBSD_ELF,
605 GDB_OSABI_INVALID /* keep this last */
608 /* Global functions from other, non-gdb GNU thingies.
609 Libiberty thingies are no longer declared here. We include libiberty.h
612 /* From other system libraries */
622 #define min(a, b) ((a) < (b) ? (a) : (b))
625 #define max(a, b) ((a) > (b) ? (a) : (b))
630 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
633 /* Various possibilities for alloca. */
636 #define alloca __builtin_alloca
637 #else /* Not GNU C */
645 /* We need to be careful not to declare this in a way which conflicts with
646 bison. Bison never declares it as char *, but under various circumstances
647 (like __hpux) we need to use void *. */
648 extern void *alloca ();
649 #endif /* Not _AIX */
650 #endif /* Not HAVE_ALLOCA_H */
651 #endif /* Not GNU C */
652 #endif /* alloca not defined */
654 /* Dynamic target-system-dependent parameters for GDB. */
657 /* Maximum size of a register. Something small, but large enough for
658 all known ISAs. If it turns out to be too small, make it bigger. */
660 enum { MAX_REGISTER_SIZE = 64 };
662 /* Static target-system-dependent parameters for GDB. */
664 /* Number of bits in a char or unsigned char for the target machine.
665 Just like CHAR_BIT in <limits.h> but describes the target machine. */
666 #if !defined (TARGET_CHAR_BIT)
667 #define TARGET_CHAR_BIT 8
670 /* If we picked up a copy of CHAR_BIT from a configuration file
671 (which may get it by including <limits.h>) then use it to set
672 the number of bits in a host char. If not, use the same size
675 #if defined (CHAR_BIT)
676 #define HOST_CHAR_BIT CHAR_BIT
678 #define HOST_CHAR_BIT TARGET_CHAR_BIT
683 extern LONGEST extract_signed_integer (const gdb_byte *, int,
686 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
689 extern int extract_long_unsigned_integer (const gdb_byte *, int,
690 enum bfd_endian, LONGEST *);
692 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
695 extern void store_signed_integer (gdb_byte *, int,
696 enum bfd_endian, LONGEST);
698 extern void store_unsigned_integer (gdb_byte *, int,
699 enum bfd_endian, ULONGEST);
701 extern void store_typed_address (gdb_byte *buf, struct type *type,
709 /* Hooks for alternate command interfaces. */
711 /* The name of the interpreter if specified on the command line. */
712 extern char *interpreter_p;
714 /* If a given interpreter matches INTERPRETER_P then it should update
715 deprecated_command_loop_hook and deprecated_init_ui_hook with the
716 per-interpreter implementation. */
717 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
718 should be moved here. */
720 struct target_waitstatus;
721 struct cmd_list_element;
723 extern void (*deprecated_pre_add_symbol_hook) (const char *);
724 extern void (*deprecated_post_add_symbol_hook) (void);
725 extern void (*selected_frame_level_changed_hook) (int);
726 extern int (*deprecated_ui_loop_hook) (int signo);
727 extern void (*deprecated_init_ui_hook) (char *argv0);
728 extern void (*deprecated_command_loop_hook) (void);
729 extern void (*deprecated_show_load_progress) (const char *section,
730 unsigned long section_sent,
731 unsigned long section_size,
732 unsigned long total_sent,
733 unsigned long total_size);
734 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
738 extern int (*deprecated_query_hook) (const char *, va_list)
739 ATTRIBUTE_FPTR_PRINTF(1,0);
740 extern void (*deprecated_warning_hook) (const char *, va_list)
741 ATTRIBUTE_FPTR_PRINTF(1,0);
742 extern void (*deprecated_flush_hook) (struct ui_file * stream);
743 extern void (*deprecated_interactive_hook) (void);
744 extern void (*deprecated_readline_begin_hook) (char *, ...)
745 ATTRIBUTE_FPTR_PRINTF_1;
746 extern char *(*deprecated_readline_hook) (char *);
747 extern void (*deprecated_readline_end_hook) (void);
748 extern void (*deprecated_register_changed_hook) (int regno);
749 extern void (*deprecated_context_hook) (int);
750 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
751 struct target_waitstatus *status,
754 extern void (*deprecated_attach_hook) (void);
755 extern void (*deprecated_detach_hook) (void);
756 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
757 char *cmd, int from_tty);
759 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
761 extern int (*deprecated_ui_load_progress_hook) (const char *section,
764 /* Inhibit window interface if non-zero. */
766 extern int use_windows;
768 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
769 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
770 in the code actually refer to a lightweight process id, i.e,
771 something that can be considered a process id in its own right for
775 #define PIDGET(PTID) (ptid_get_pid (PTID))
776 #define TIDGET(PTID) (ptid_get_lwp (PTID))
777 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
780 /* Define well known filenos if the system does not define them. */
782 #define STDIN_FILENO 0
784 #ifndef STDOUT_FILENO
785 #define STDOUT_FILENO 1
787 #ifndef STDERR_FILENO
788 #define STDERR_FILENO 2
791 /* If this definition isn't overridden by the header files, assume
792 that isatty and fileno exist on this system. */
794 #define ISATTY(FP) (isatty (fileno (FP)))
797 /* A width that can achieve a better legibility for GDB MI mode. */
798 #define GDB_MI_MSG_WIDTH 80
800 /* From progspace.c */
802 extern void initialize_progspace (void);
803 extern void initialize_inferiors (void);
805 /* Special block numbers */
811 FIRST_LOCAL_BLOCK = 2
816 #endif /* #ifndef DEFS_H */