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 "build-gnulib/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
58 /* First include ansidecl.h so we can use the various macro definitions
59 here and in all subsequent file inclusions. */
63 #include "gdb_locale.h"
65 #include "gdb_wchar.h"
67 /* For ``enum gdb_signal''. */
68 #include "gdb/signals.h"
72 #include "host-defs.h"
74 /* Just in case they're not defined in stdio.h. */
83 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
84 It is used as an access modifier in calls to open(), where it acts
85 similarly to the "b" character in fopen()'s MODE argument. On Posix
86 platforms it should be a no-op, so it is defined as 0 here. This
87 ensures that the symbol may be used freely elsewhere in gdb. */
93 #include <stdarg.h> /* For va_list. */
95 #include "libiberty.h"
98 /* Rather than duplicate all the logic in BFD for figuring out what
99 types to use (which can be pretty complicated), symply define them
100 in terms of the corresponding type from BFD. */
104 /* A byte from the program being debugged. */
105 typedef bfd_byte gdb_byte
;
107 /* An address in the program being debugged. Host byte order. */
108 typedef bfd_vma CORE_ADDR
;
110 /* The largest CORE_ADDR value. */
111 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
113 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
117 #define LONGEST BFD_HOST_64_BIT
118 #define ULONGEST BFD_HOST_U_64_BIT
122 #define LONGEST long long
123 #define ULONGEST unsigned long long
125 #endif /* No BFD64 */
128 #define min(a, b) ((a) < (b) ? (a) : (b))
131 #define max(a, b) ((a) > (b) ? (a) : (b))
136 /* Enable xdb commands if set. */
137 extern int xdb_commands
;
139 /* Enable dbx commands if set. */
140 extern int dbx_commands
;
142 /* System root path, used to find libraries etc. */
143 extern char *gdb_sysroot
;
145 /* GDB datadir, used to store data files. */
146 extern char *gdb_datadir
;
148 /* If non-NULL, the possibly relocated path to python's "lib" directory
149 specified with --with-python. */
150 extern char *python_libdir
;
152 /* Search path for separate debug files. */
153 extern char *debug_file_directory
;
155 /* GDB has two methods for handling SIGINT. When immediate_quit is
156 nonzero, a SIGINT results in an immediate longjmp out of the signal
157 handler. Otherwise, SIGINT simply sets a flag; code that might
158 take a long time, and which ought to be interruptible, checks this
159 flag using the QUIT macro.
161 If GDB is built with Python support, it uses Python's low-level
162 interface to implement the flag. This approach makes it possible
163 for Python and GDB SIGINT handling to coexist seamlessly.
165 If GDB is built without Python, it instead uses its traditional
168 /* Clear the quit flag. */
169 extern void clear_quit_flag (void);
170 /* Evaluate to non-zero if the quit flag is set, zero otherwise. This
171 will clear the quit flag as a side effect. */
172 extern int check_quit_flag (void);
173 /* Set the quit flag. */
174 extern void set_quit_flag (void);
176 extern int immediate_quit
;
178 extern void quit (void);
180 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
181 benefits of having a ``QUIT'' macro rather than a function are
182 marginal. If the overhead of a QUIT function call is proving
183 significant then its calling frequency should probably be reduced
184 [kingdon]. A profile analyzing the current situtation is
188 if (check_quit_flag ()) quit (); \
189 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
192 /* Languages represented in the symbol table and elsewhere.
193 This should probably be in language.h, but since enum's can't
194 be forward declared to satisfy opaque references before their
195 actual definition, needs to be here. */
199 language_unknown
, /* Language not known */
200 language_auto
, /* Placeholder for automatic setting */
202 language_cplus
, /* C++ */
204 language_go
, /* Go */
205 language_objc
, /* Objective-C */
206 language_java
, /* Java */
207 language_fortran
, /* Fortran */
208 language_m2
, /* Modula-2 */
209 language_asm
, /* Assembly language */
210 language_pascal
, /* Pascal */
211 language_ada
, /* Ada */
212 language_opencl
, /* OpenCL */
213 language_minimal
, /* All other languages, minimal support only */
221 unspecified_precision
224 /* A generic, not quite boolean, enumeration. */
232 /* Potential ways that a function can return a value of a given type. */
233 enum return_value_convention
235 /* Where the return value has been squeezed into one or more
237 RETURN_VALUE_REGISTER_CONVENTION
,
238 /* Commonly known as the "struct return convention". The caller
239 passes an additional hidden first parameter to the caller. That
240 parameter contains the address at which the value being returned
241 should be stored. While typically, and historically, used for
242 large structs, this is convention is applied to values of many
244 RETURN_VALUE_STRUCT_CONVENTION
,
245 /* Like the "struct return convention" above, but where the ABI
246 guarantees that the called function stores the address at which
247 the value being returned is stored in a well-defined location,
248 such as a register or memory slot in the stack frame. Don't use
249 this if the ABI doesn't explicitly guarantees this. */
250 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
251 /* Like the "struct return convention" above, but where the ABI
252 guarantees that the address at which the value being returned is
253 stored will be available in a well-defined location, such as a
254 register or memory slot in the stack frame. Don't use this if
255 the ABI doesn't explicitly guarantees this. */
256 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
259 /* Needed for various prototypes */
269 /* This really belong in utils.c (path-utils.c?), but it references some
270 globals that are currently only available to main.c. */
271 extern char *relocate_gdb_directory (const char *initial
, int flag
);
274 /* Annotation stuff. */
276 extern int annotation_level
; /* in stack.c */
279 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
280 "const char *" in unistd.h, so we can't declare the argument
283 extern char *re_comp (const char *);
287 extern void symbol_file_command (char *, int);
289 /* Remote targets may wish to use this as their load function. */
290 extern void generic_load (char *name
, int from_tty
);
292 /* Report on STREAM the performance of memory transfer operation,
294 DATA_COUNT is the number of bytes transferred.
295 WRITE_COUNT is the number of separate write operations, or 0,
296 if that information is not available.
297 START_TIME is the time at which an operation was started.
298 END_TIME is the time at which an operation ended. */
300 extern void print_transfer_performance (struct ui_file
*stream
,
301 unsigned long data_count
,
302 unsigned long write_count
,
303 const struct timeval
*start_time
,
304 const struct timeval
*end_time
);
308 typedef void initialize_file_ftype (void);
310 extern char *skip_quoted (char *);
312 extern char *gdb_readline (char *);
314 extern char *gdb_readline_wrapper (char *);
316 extern char *command_line_input (char *, int, char *);
318 extern void print_prompt (void);
320 extern int input_from_terminal_p (void);
322 extern int info_verbose
;
324 /* From printcmd.c */
326 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
328 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
329 struct ui_file
*, int, char *);
331 extern int build_address_symbolic (struct gdbarch
*,
340 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
341 extern const char *pc_prefix (CORE_ADDR
);
345 #define OPF_TRY_CWD_FIRST 0x01
346 #define OPF_SEARCH_IN_PATH 0x02
348 extern int openp (const char *, int, const char *, int, char **);
350 extern int source_full_path_of (const char *, char **);
352 extern void mod_path (char *, char **);
354 extern void add_path (char *, char **, int);
356 extern void directory_switch (char *, int);
358 extern char *source_path
;
360 extern void init_source_path (void);
364 /* Process memory area starting at ADDR with length SIZE. Area is readable iff
365 READ is non-zero, writable if WRITE is non-zero, executable if EXEC is
366 non-zero. Area is possibly changed against its original file based copy if
367 MODIFIED is non-zero. DATA is passed without changes from a caller. */
369 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
370 int read
, int write
, int exec
,
371 int modified
, void *data
);
373 /* Take over the 'find_mapped_memory' vector from exec.c. */
374 extern void exec_set_find_memory_regions
375 (int (*func
) (find_memory_region_ftype func
, void *data
));
377 /* Possible lvalue types. Like enum language, this should be in
378 value.h, but needs to be here for the same reason. */
386 /* In a register. Registers are relative to a frame. */
388 /* In a gdb internal variable. */
390 /* Part of a gdb internal variable (structure field). */
391 lval_internalvar_component
,
392 /* Value's bits are fetched and stored using functions provided by
397 /* Control types for commands */
399 enum misc_command_type
407 enum command_control_type
416 while_stepping_control
,
420 /* Structure for saved commands lines
421 (for breakpoints, defined commands, etc). */
425 struct command_line
*next
;
427 enum command_control_type control_type
;
428 /* The number of elements in body_list. */
430 /* For composite commands, the nested lists of commands. For
431 example, for "if" command this will contain the then branch and
432 the else branch, if that is available. */
433 struct command_line
**body_list
;
436 extern struct command_line
*read_command_lines (char *, int, int,
437 void (*)(char *, void *),
439 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
440 void (*)(char *, void *),
443 extern void free_command_lines (struct command_line
**);
445 /* Parameters of the "info proc" command. */
449 /* Display the default cmdline, cwd and exe outputs. */
452 /* Display `info proc mappings'. */
455 /* Display `info proc status'. */
458 /* Display `info proc stat'. */
461 /* Display `info proc cmdline'. */
464 /* Display `info proc exe'. */
467 /* Display `info proc cwd'. */
470 /* Display all of the above. */
474 /* String containing the current directory (what getwd would return). */
476 extern char *current_directory
;
478 /* Default radixes for input and output. Only some values supported. */
479 extern unsigned input_radix
;
480 extern unsigned output_radix
;
482 /* Possibilities for prettyprint parameters to routines which print
483 things. Like enum language, this should be in value.h, but needs
484 to be here for the same reason. FIXME: If we can eliminate this
485 as an arg to LA_VAL_PRINT, then we can probably move it back to
490 Val_no_prettyprint
= 0,
492 /* Use the default setting which the user has specified. */
496 /* Optional native machine support. Non-native (and possibly pure
497 multi-arch) targets do not need a "nm.h" file. This will be a
498 symlink to one of the nm-*.h files, built by the `configure'
505 /* Assume that fopen accepts the letter "b" in the mode string.
506 It is demanded by ISO C9X, and should be supported on all
507 platforms that claim to have a standard-conforming C library. On
508 true POSIX systems it will be ignored and have no effect. There
509 may still be systems without a standard-conforming C library where
510 an ISO C9X compiler (GCC) is available. Known examples are SunOS
511 4.x and 4.3BSD. This assumption means these systems are no longer
514 # include "fopen-bin.h"
517 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
518 FIXME: Assumes 2's complement arithmetic. */
520 #if !defined (UINT_MAX)
521 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
524 #if !defined (INT_MAX)
525 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
528 #if !defined (INT_MIN)
529 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
532 #if !defined (ULONG_MAX)
533 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
536 #if !defined (LONG_MAX)
537 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
540 #if !defined (ULONGEST_MAX)
541 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
544 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
545 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
548 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
549 arguments to a function, number in a value history, register number, etc.)
550 where the value must not be larger than can fit in an int. */
552 extern int longest_to_int (LONGEST
);
554 /* Utility macros to allocate typed memory. Avoids errors like:
555 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
556 sizeof (struct foo), 0). */
557 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
558 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
559 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
561 #include "common-utils.h"
563 /* List of known OS ABIs. If you change this, make sure to update the
567 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
569 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
576 GDB_OSABI_FREEBSD_AOUT
,
577 GDB_OSABI_FREEBSD_ELF
,
578 GDB_OSABI_NETBSD_AOUT
,
579 GDB_OSABI_NETBSD_ELF
,
580 GDB_OSABI_OPENBSD_ELF
,
597 GDB_OSABI_INVALID
/* keep this last */
600 /* Global functions from other, non-gdb GNU thingies.
601 Libiberty thingies are no longer declared here. We include libiberty.h
604 /* From other system libraries */
616 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
619 /* Various possibilities for alloca. */
622 #define alloca __builtin_alloca
623 #else /* Not GNU C */
631 /* We need to be careful not to declare this in a way which conflicts with
632 bison. Bison never declares it as char *, but under various circumstances
633 (like __hpux) we need to use void *. */
634 extern void *alloca ();
635 #endif /* Not _AIX */
636 #endif /* Not HAVE_ALLOCA_H */
637 #endif /* Not GNU C */
638 #endif /* alloca not defined */
640 /* Dynamic target-system-dependent parameters for GDB. */
643 /* Maximum size of a register. Something small, but large enough for
644 all known ISAs. If it turns out to be too small, make it bigger. */
646 enum { MAX_REGISTER_SIZE
= 64 };
648 /* Static target-system-dependent parameters for GDB. */
650 /* Number of bits in a char or unsigned char for the target machine.
651 Just like CHAR_BIT in <limits.h> but describes the target machine. */
652 #if !defined (TARGET_CHAR_BIT)
653 #define TARGET_CHAR_BIT 8
656 /* If we picked up a copy of CHAR_BIT from a configuration file
657 (which may get it by including <limits.h>) then use it to set
658 the number of bits in a host char. If not, use the same size
661 #if defined (CHAR_BIT)
662 #define HOST_CHAR_BIT CHAR_BIT
664 #define HOST_CHAR_BIT TARGET_CHAR_BIT
669 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
672 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
675 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
676 enum bfd_endian
, LONGEST
*);
678 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
681 extern void store_signed_integer (gdb_byte
*, int,
682 enum bfd_endian
, LONGEST
);
684 extern void store_unsigned_integer (gdb_byte
*, int,
685 enum bfd_endian
, ULONGEST
);
687 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
695 /* Hooks for alternate command interfaces. */
697 /* The name of the interpreter if specified on the command line. */
698 extern char *interpreter_p
;
700 /* If a given interpreter matches INTERPRETER_P then it should update
701 deprecated_command_loop_hook and deprecated_init_ui_hook with the
702 per-interpreter implementation. */
703 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
704 should be moved here. */
706 struct target_waitstatus
;
707 struct cmd_list_element
;
709 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
710 extern void (*deprecated_post_add_symbol_hook
) (void);
711 extern void (*selected_frame_level_changed_hook
) (int);
712 extern int (*deprecated_ui_loop_hook
) (int signo
);
713 extern void (*deprecated_init_ui_hook
) (char *argv0
);
714 extern void (*deprecated_command_loop_hook
) (void);
715 extern void (*deprecated_show_load_progress
) (const char *section
,
716 unsigned long section_sent
,
717 unsigned long section_size
,
718 unsigned long total_sent
,
719 unsigned long total_size
);
720 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
724 extern int (*deprecated_query_hook
) (const char *, va_list)
725 ATTRIBUTE_FPTR_PRINTF(1,0);
726 extern void (*deprecated_warning_hook
) (const char *, va_list)
727 ATTRIBUTE_FPTR_PRINTF(1,0);
728 extern void (*deprecated_flush_hook
) (struct ui_file
* stream
);
729 extern void (*deprecated_interactive_hook
) (void);
730 extern void (*deprecated_readline_begin_hook
) (char *, ...)
731 ATTRIBUTE_FPTR_PRINTF_1
;
732 extern char *(*deprecated_readline_hook
) (char *);
733 extern void (*deprecated_readline_end_hook
) (void);
734 extern void (*deprecated_register_changed_hook
) (int regno
);
735 extern void (*deprecated_context_hook
) (int);
736 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
737 struct target_waitstatus
*status
,
740 extern void (*deprecated_attach_hook
) (void);
741 extern void (*deprecated_detach_hook
) (void);
742 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
743 char *cmd
, int from_tty
);
745 extern void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
747 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
750 /* Inhibit window interface if non-zero. */
752 extern int use_windows
;
754 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
755 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
756 in the code actually refer to a lightweight process id, i.e,
757 something that can be considered a process id in its own right for
761 #define PIDGET(PTID) (ptid_get_pid (PTID))
762 #define TIDGET(PTID) (ptid_get_lwp (PTID))
763 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
766 /* If this definition isn't overridden by the header files, assume
767 that isatty and fileno exist on this system. */
769 #define ISATTY(FP) (isatty (fileno (FP)))
772 /* A width that can achieve a better legibility for GDB MI mode. */
773 #define GDB_MI_MSG_WIDTH 80
775 /* From progspace.c */
777 extern void initialize_progspace (void);
778 extern void initialize_inferiors (void);
780 /* Special block numbers */
786 FIRST_LOCAL_BLOCK
= 2
791 #endif /* #ifndef DEFS_H */