1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
3 /* Basic, host-specific, and target-specific definitions for GDB.
4 Copyright (C) 1986-2013 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 "config.h" /* Generated by configure. */
29 #include "libgnu/config.h"
31 #include <sys/types.h>
33 #include <errno.h> /* System call error return status. */
37 /* The libdecnumber library, on which GDB depends, includes a header file
38 called gstdint.h instead of relying directly on stdint.h. GDB, on the
39 other hand, includes stdint.h directly, relying on the fact that gnulib
40 generates a copy if the system doesn't provide one or if it is missing
41 some features. Unfortunately, gstdint.h and stdint.h cannot be included
42 at the same time, which may happen when we include a file from
45 The following macro definition effectively prevents the inclusion of
46 gstdint.h, as all the definitions it provides are guarded against
47 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
48 included, so it's ok to blank out gstdint.h. */
49 #define GCC_GENERATED_STDINT_H 1
61 /* First include ansidecl.h so we can use the various macro definitions
62 here and in all subsequent file inclusions. */
66 #include "gdb_locale.h"
68 #include "gdb_wchar.h"
70 /* For ``enum gdb_signal''. */
71 #include "gdb/signals.h"
75 #include "host-defs.h"
77 /* Just in case they're not defined in stdio.h. */
86 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
87 It is used as an access modifier in calls to open(), where it acts
88 similarly to the "b" character in fopen()'s MODE argument. On Posix
89 platforms it should be a no-op, so it is defined as 0 here. This
90 ensures that the symbol may be used freely elsewhere in gdb. */
96 #include <stdarg.h> /* For va_list. */
98 #include "libiberty.h"
101 /* Rather than duplicate all the logic in BFD for figuring out what
102 types to use (which can be pretty complicated), symply define them
103 in terms of the corresponding type from BFD. */
107 /* A byte from the program being debugged. */
108 typedef bfd_byte gdb_byte
;
110 /* An address in the program being debugged. Host byte order. */
111 typedef bfd_vma CORE_ADDR
;
113 /* The largest CORE_ADDR value. */
114 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
116 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
120 #define LONGEST BFD_HOST_64_BIT
121 #define ULONGEST BFD_HOST_U_64_BIT
125 #define LONGEST long long
126 #define ULONGEST unsigned long long
128 #endif /* No BFD64 */
131 #define min(a, b) ((a) < (b) ? (a) : (b))
134 #define max(a, b) ((a) > (b) ? (a) : (b))
139 /* Enable xdb commands if set. */
140 extern int xdb_commands
;
142 /* Enable dbx commands if set. */
143 extern int dbx_commands
;
145 /* System root path, used to find libraries etc. */
146 extern char *gdb_sysroot
;
148 /* GDB datadir, used to store data files. */
149 extern char *gdb_datadir
;
151 /* If non-NULL, the possibly relocated path to python's "lib" directory
152 specified with --with-python. */
153 extern char *python_libdir
;
155 /* Search path for separate debug files. */
156 extern char *debug_file_directory
;
158 /* GDB has two methods for handling SIGINT. When immediate_quit is
159 nonzero, a SIGINT results in an immediate longjmp out of the signal
160 handler. Otherwise, SIGINT simply sets a flag; code that might
161 take a long time, and which ought to be interruptible, checks this
162 flag using the QUIT macro.
164 If GDB is built with Python support, it uses Python's low-level
165 interface to implement the flag. This approach makes it possible
166 for Python and GDB SIGINT handling to coexist seamlessly.
168 If GDB is built without Python, it instead uses its traditional
171 /* Clear the quit flag. */
172 extern void clear_quit_flag (void);
173 /* Evaluate to non-zero if the quit flag is set, zero otherwise. This
174 will clear the quit flag as a side effect. */
175 extern int check_quit_flag (void);
176 /* Set the quit flag. */
177 extern void set_quit_flag (void);
179 extern int immediate_quit
;
181 extern void quit (void);
183 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
184 benefits of having a ``QUIT'' macro rather than a function are
185 marginal. If the overhead of a QUIT function call is proving
186 significant then its calling frequency should probably be reduced
187 [kingdon]. A profile analyzing the current situtation is
191 if (check_quit_flag ()) quit (); \
192 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
195 /* Languages represented in the symbol table and elsewhere.
196 This should probably be in language.h, but since enum's can't
197 be forward declared to satisfy opaque references before their
198 actual definition, needs to be here. */
202 language_unknown
, /* Language not known */
203 language_auto
, /* Placeholder for automatic setting */
205 language_cplus
, /* C++ */
207 language_go
, /* Go */
208 language_objc
, /* Objective-C */
209 language_java
, /* Java */
210 language_fortran
, /* Fortran */
211 language_m2
, /* Modula-2 */
212 language_asm
, /* Assembly language */
213 language_pascal
, /* Pascal */
214 language_ada
, /* Ada */
215 language_opencl
, /* OpenCL */
216 language_minimal
, /* All other languages, minimal support only */
224 unspecified_precision
227 /* A generic, not quite boolean, enumeration. */
235 /* Potential ways that a function can return a value of a given type. */
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 (char *name
, int from_tty
);
295 /* Report on STREAM the performance of memory transfer operation,
297 DATA_COUNT is the number of bytes transferred.
298 WRITE_COUNT is the number of separate write operations, or 0,
299 if that information is not available.
300 START_TIME is the time at which an operation was started.
301 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 *skip_quoted (char *);
315 extern char *gdb_readline (char *);
317 extern char *gdb_readline_wrapper (char *);
319 extern char *command_line_input (char *, int, char *);
321 extern void print_prompt (void);
323 extern int input_from_terminal_p (void);
325 extern int info_verbose
;
327 /* From printcmd.c */
329 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
331 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
332 struct ui_file
*, int, char *);
334 extern int build_address_symbolic (struct gdbarch
*,
343 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
344 extern const char *pc_prefix (CORE_ADDR
);
348 /* See openp function definition for their description. */
349 #define OPF_TRY_CWD_FIRST 0x01
350 #define OPF_SEARCH_IN_PATH 0x02
351 #define OPF_DISABLE_REALPATH 0x04
353 extern int openp (const char *, int, const char *, int, char **);
355 extern int source_full_path_of (const char *, char **);
357 extern void mod_path (char *, char **);
359 extern void add_path (char *, char **, int);
361 extern void directory_switch (char *, int);
363 extern char *source_path
;
365 extern void init_source_path (void);
369 /* Process memory area starting at ADDR with length SIZE. Area is readable iff
370 READ is non-zero, writable if WRITE is non-zero, executable if EXEC is
371 non-zero. Area is possibly changed against its original file based copy if
372 MODIFIED is non-zero. DATA is passed without changes from a caller. */
374 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
375 int read
, int write
, int exec
,
376 int modified
, void *data
);
378 /* Take over the 'find_mapped_memory' vector from exec.c. */
379 extern void exec_set_find_memory_regions
380 (int (*func
) (find_memory_region_ftype func
, void *data
));
382 /* Possible lvalue types. Like enum language, this should be in
383 value.h, but needs to be here for the same reason. */
391 /* In a register. Registers are relative to a frame. */
393 /* In a gdb internal variable. */
395 /* Part of a gdb internal variable (structure field). */
396 lval_internalvar_component
,
397 /* Value's bits are fetched and stored using functions provided by
402 /* Control types for commands */
404 enum misc_command_type
412 enum command_control_type
421 while_stepping_control
,
425 /* Structure for saved commands lines
426 (for breakpoints, defined commands, etc). */
430 struct command_line
*next
;
432 enum command_control_type control_type
;
433 /* The number of elements in body_list. */
435 /* For composite commands, the nested lists of commands. For
436 example, for "if" command this will contain the then branch and
437 the else branch, if that is available. */
438 struct command_line
**body_list
;
441 extern struct command_line
*read_command_lines (char *, int, int,
442 void (*)(char *, void *),
444 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
445 void (*)(char *, void *),
448 extern void free_command_lines (struct command_line
**);
450 /* Parameters of the "info proc" command. */
454 /* Display the default cmdline, cwd and exe outputs. */
457 /* Display `info proc mappings'. */
460 /* Display `info proc status'. */
463 /* Display `info proc stat'. */
466 /* Display `info proc cmdline'. */
469 /* Display `info proc exe'. */
472 /* Display `info proc cwd'. */
475 /* Display all of the above. */
479 /* String containing the current directory (what getwd would return). */
481 extern char *current_directory
;
483 /* Default radixes for input and output. Only some values supported. */
484 extern unsigned input_radix
;
485 extern unsigned output_radix
;
487 /* Possibilities for prettyprint parameters to routines which print
488 things. Like enum language, this should be in value.h, but needs
489 to be here for the same reason. FIXME: If we can eliminate this
490 as an arg to LA_VAL_PRINT, then we can probably move it back to
495 Val_no_prettyprint
= 0,
497 /* Use the default setting which the user has specified. */
501 /* Optional native machine support. Non-native (and possibly pure
502 multi-arch) targets do not need a "nm.h" file. This will be a
503 symlink to one of the nm-*.h files, built by the `configure'
510 /* Assume that fopen accepts the letter "b" in the mode string.
511 It is demanded by ISO C9X, and should be supported on all
512 platforms that claim to have a standard-conforming C library. On
513 true POSIX systems it will be ignored and have no effect. There
514 may still be systems without a standard-conforming C library where
515 an ISO C9X compiler (GCC) is available. Known examples are SunOS
516 4.x and 4.3BSD. This assumption means these systems are no longer
519 # include "fopen-bin.h"
522 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
523 FIXME: Assumes 2's complement arithmetic. */
525 #if !defined (UINT_MAX)
526 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
529 #if !defined (INT_MAX)
530 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
533 #if !defined (INT_MIN)
534 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
537 #if !defined (ULONG_MAX)
538 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
541 #if !defined (LONG_MAX)
542 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
545 #if !defined (ULONGEST_MAX)
546 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
549 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
550 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
553 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
554 arguments to a function, number in a value history, register number, etc.)
555 where the value must not be larger than can fit in an int. */
557 extern int longest_to_int (LONGEST
);
559 /* Utility macros to allocate typed memory. Avoids errors like:
560 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
561 sizeof (struct foo), 0). */
562 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
563 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
564 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
566 #include "common-utils.h"
568 /* List of known OS ABIs. If you change this, make sure to update the
572 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
574 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
581 GDB_OSABI_FREEBSD_AOUT
,
582 GDB_OSABI_FREEBSD_ELF
,
583 GDB_OSABI_NETBSD_AOUT
,
584 GDB_OSABI_NETBSD_ELF
,
585 GDB_OSABI_OPENBSD_ELF
,
603 GDB_OSABI_INVALID
/* keep this last */
606 /* Global functions from other, non-gdb GNU thingies.
607 Libiberty thingies are no longer declared here. We include libiberty.h
610 /* From other system libraries */
622 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
625 /* Various possibilities for alloca. */
628 #define alloca __builtin_alloca
629 #else /* Not GNU C */
637 /* We need to be careful not to declare this in a way which conflicts with
638 bison. Bison never declares it as char *, but under various circumstances
639 (like __hpux) we need to use void *. */
640 extern void *alloca ();
641 #endif /* Not _AIX */
642 #endif /* Not HAVE_ALLOCA_H */
643 #endif /* Not GNU C */
644 #endif /* alloca not defined */
646 /* Dynamic target-system-dependent parameters for GDB. */
649 /* Maximum size of a register. Something small, but large enough for
650 all known ISAs. If it turns out to be too small, make it bigger. */
652 enum { MAX_REGISTER_SIZE
= 64 };
654 /* Static target-system-dependent parameters for GDB. */
656 /* Number of bits in a char or unsigned char for the target machine.
657 Just like CHAR_BIT in <limits.h> but describes the target machine. */
658 #if !defined (TARGET_CHAR_BIT)
659 #define TARGET_CHAR_BIT 8
662 /* If we picked up a copy of CHAR_BIT from a configuration file
663 (which may get it by including <limits.h>) then use it to set
664 the number of bits in a host char. If not, use the same size
667 #if defined (CHAR_BIT)
668 #define HOST_CHAR_BIT CHAR_BIT
670 #define HOST_CHAR_BIT TARGET_CHAR_BIT
675 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
678 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
681 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
682 enum bfd_endian
, LONGEST
*);
684 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
687 extern void store_signed_integer (gdb_byte
*, int,
688 enum bfd_endian
, LONGEST
);
690 extern void store_unsigned_integer (gdb_byte
*, int,
691 enum bfd_endian
, ULONGEST
);
693 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
701 /* Hooks for alternate command interfaces. */
703 /* The name of the interpreter if specified on the command line. */
704 extern char *interpreter_p
;
706 /* If a given interpreter matches INTERPRETER_P then it should update
707 deprecated_command_loop_hook and deprecated_init_ui_hook with the
708 per-interpreter implementation. */
709 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
710 should be moved here. */
712 struct target_waitstatus
;
713 struct cmd_list_element
;
715 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
716 extern void (*deprecated_post_add_symbol_hook
) (void);
717 extern void (*selected_frame_level_changed_hook
) (int);
718 extern int (*deprecated_ui_loop_hook
) (int signo
);
719 extern void (*deprecated_init_ui_hook
) (char *argv0
);
720 extern void (*deprecated_command_loop_hook
) (void);
721 extern void (*deprecated_show_load_progress
) (const char *section
,
722 unsigned long section_sent
,
723 unsigned long section_size
,
724 unsigned long total_sent
,
725 unsigned long total_size
);
726 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
730 extern int (*deprecated_query_hook
) (const char *, va_list)
731 ATTRIBUTE_FPTR_PRINTF(1,0);
732 extern void (*deprecated_warning_hook
) (const char *, va_list)
733 ATTRIBUTE_FPTR_PRINTF(1,0);
734 extern void (*deprecated_flush_hook
) (struct ui_file
* stream
);
735 extern void (*deprecated_interactive_hook
) (void);
736 extern void (*deprecated_readline_begin_hook
) (char *, ...)
737 ATTRIBUTE_FPTR_PRINTF_1
;
738 extern char *(*deprecated_readline_hook
) (char *);
739 extern void (*deprecated_readline_end_hook
) (void);
740 extern void (*deprecated_register_changed_hook
) (int regno
);
741 extern void (*deprecated_context_hook
) (int);
742 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
743 struct target_waitstatus
*status
,
746 extern void (*deprecated_attach_hook
) (void);
747 extern void (*deprecated_detach_hook
) (void);
748 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
749 char *cmd
, int from_tty
);
751 extern void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
753 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
756 /* Inhibit window interface if non-zero. */
758 extern int use_windows
;
760 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
761 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
762 in the code actually refer to a lightweight process id, i.e,
763 something that can be considered a process id in its own right for
767 #define PIDGET(PTID) (ptid_get_pid (PTID))
768 #define TIDGET(PTID) (ptid_get_lwp (PTID))
769 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
772 /* Define well known filenos if the system does not define them. */
774 #define STDIN_FILENO 0
776 #ifndef STDOUT_FILENO
777 #define STDOUT_FILENO 1
779 #ifndef STDERR_FILENO
780 #define STDERR_FILENO 2
783 /* If this definition isn't overridden by the header files, assume
784 that isatty and fileno exist on this system. */
786 #define ISATTY(FP) (isatty (fileno (FP)))
789 /* A width that can achieve a better legibility for GDB MI mode. */
790 #define GDB_MI_MSG_WIDTH 80
792 /* From progspace.c */
794 extern void initialize_progspace (void);
795 extern void initialize_inferiors (void);
797 /* For DragonFly kgdb */
798 extern int kernel_debugger
;
800 /* Special block numbers */
806 FIRST_LOCAL_BLOCK
= 2
811 #endif /* #ifndef DEFS_H */