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. */
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. */
122 #define LONGEST BFD_HOST_64_BIT
123 #define ULONGEST BFD_HOST_U_64_BIT
127 #ifdef CC_HAS_LONG_LONG
128 #define LONGEST long long
129 #define ULONGEST unsigned long long
131 #ifdef BFD_HOST_64_BIT
132 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
133 (e.g. i386-windows) so try it. */
134 #define LONGEST BFD_HOST_64_BIT
135 #define ULONGEST BFD_HOST_U_64_BIT
138 #define ULONGEST unsigned long
142 #endif /* No BFD64 */
144 #endif /* ! LONGEST */
147 #define min(a, b) ((a) < (b) ? (a) : (b))
150 #define max(a, b) ((a) > (b) ? (a) : (b))
155 /* Enable xdb commands if set. */
156 extern int xdb_commands
;
158 /* Enable dbx commands if set. */
159 extern int dbx_commands
;
161 /* System root path, used to find libraries etc. */
162 extern char *gdb_sysroot
;
164 /* GDB datadir, used to store data files. */
165 extern char *gdb_datadir
;
167 /* If non-NULL, the possibly relocated path to python's "lib" directory
168 specified with --with-python. */
169 extern char *python_libdir
;
171 /* Search path for separate debug files. */
172 extern char *debug_file_directory
;
174 /* GDB has two methods for handling SIGINT. When immediate_quit is
175 nonzero, a SIGINT results in an immediate longjmp out of the signal
176 handler. Otherwise, SIGINT simply sets a flag; code that might
177 take a long time, and which ought to be interruptible, checks this
178 flag using the QUIT macro.
180 If GDB is built with Python support, it uses Python's low-level
181 interface to implement the flag. This approach makes it possible
182 for Python and GDB SIGINT handling to coexist seamlessly.
184 If GDB is built without Python, it instead uses its traditional
187 /* Clear the quit flag. */
188 extern void clear_quit_flag (void);
189 /* Evaluate to non-zero if the quit flag is set, zero otherwise. This
190 will clear the quit flag as a side effect. */
191 extern int check_quit_flag (void);
192 /* Set the quit flag. */
193 extern void set_quit_flag (void);
195 extern int immediate_quit
;
197 extern void quit (void);
199 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
200 benefits of having a ``QUIT'' macro rather than a function are
201 marginal. If the overhead of a QUIT function call is proving
202 significant then its calling frequency should probably be reduced
203 [kingdon]. A profile analyzing the current situtation is
207 if (check_quit_flag ()) quit (); \
208 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
211 /* Languages represented in the symbol table and elsewhere.
212 This should probably be in language.h, but since enum's can't
213 be forward declared to satisfy opaque references before their
214 actual definition, needs to be here. */
218 language_unknown
, /* Language not known */
219 language_auto
, /* Placeholder for automatic setting */
221 language_cplus
, /* C++ */
223 language_go
, /* Go */
224 language_objc
, /* Objective-C */
225 language_java
, /* Java */
226 language_fortran
, /* Fortran */
227 language_m2
, /* Modula-2 */
228 language_asm
, /* Assembly language */
229 language_pascal
, /* Pascal */
230 language_ada
, /* Ada */
231 language_opencl
, /* OpenCL */
232 language_minimal
, /* All other languages, minimal support only */
240 unspecified_precision
243 /* A generic, not quite boolean, enumeration. */
251 /* Potential ways that a function can return a value of a given type. */
252 enum return_value_convention
254 /* Where the return value has been squeezed into one or more
256 RETURN_VALUE_REGISTER_CONVENTION
,
257 /* Commonly known as the "struct return convention". The caller
258 passes an additional hidden first parameter to the caller. That
259 parameter contains the address at which the value being returned
260 should be stored. While typically, and historically, used for
261 large structs, this is convention is applied to values of many
263 RETURN_VALUE_STRUCT_CONVENTION
,
264 /* Like the "struct return convention" above, but where the ABI
265 guarantees that the called function stores the address at which
266 the value being returned is stored in a well-defined location,
267 such as a register or memory slot in the stack frame. Don't use
268 this if the ABI doesn't explicitly guarantees this. */
269 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
270 /* Like the "struct return convention" above, but where the ABI
271 guarantees that the address at which the value being returned is
272 stored will be available in a well-defined location, such as a
273 register or memory slot in the stack frame. Don't use this if
274 the ABI doesn't explicitly guarantees this. */
275 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
278 /* Needed for various prototypes */
288 /* This really belong in utils.c (path-utils.c?), but it references some
289 globals that are currently only available to main.c. */
290 extern char *relocate_gdb_directory (const char *initial
, int flag
);
293 /* Annotation stuff. */
295 extern int annotation_level
; /* in stack.c */
298 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
299 "const char *" in unistd.h, so we can't declare the argument
302 extern char *re_comp (const char *);
306 extern void symbol_file_command (char *, int);
308 /* Remote targets may wish to use this as their load function. */
309 extern void generic_load (char *name
, int from_tty
);
311 /* Report on STREAM the performance of memory transfer operation,
313 DATA_COUNT is the number of bytes transferred.
314 WRITE_COUNT is the number of separate write operations, or 0,
315 if that information is not available.
316 START_TIME is the time at which an operation was started.
317 END_TIME is the time at which an operation ended. */
319 extern void print_transfer_performance (struct ui_file
*stream
,
320 unsigned long data_count
,
321 unsigned long write_count
,
322 const struct timeval
*start_time
,
323 const struct timeval
*end_time
);
327 typedef void initialize_file_ftype (void);
329 extern char *skip_quoted (char *);
331 extern char *gdb_readline (char *);
333 extern char *gdb_readline_wrapper (char *);
335 extern char *command_line_input (char *, int, char *);
337 extern void print_prompt (void);
339 extern int input_from_terminal_p (void);
341 extern int info_verbose
;
343 /* From printcmd.c */
345 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
347 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
348 struct ui_file
*, int, char *);
350 extern int build_address_symbolic (struct gdbarch
*,
359 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
360 extern const char *pc_prefix (CORE_ADDR
);
364 #define OPF_TRY_CWD_FIRST 0x01
365 #define OPF_SEARCH_IN_PATH 0x02
367 extern int openp (const char *, int, const char *, int, char **);
369 extern int source_full_path_of (const char *, char **);
371 extern void mod_path (char *, char **);
373 extern void add_path (char *, char **, int);
375 extern void directory_command (char *, int);
377 extern void directory_switch (char *, int);
379 extern char *source_path
;
381 extern void init_source_path (void);
385 /* Process memory area starting at ADDR with length SIZE. Area is readable iff
386 READ is non-zero, writable if WRITE is non-zero, executable if EXEC is
387 non-zero. Area is possibly changed against its original file based copy if
388 MODIFIED is non-zero. DATA is passed without changes from a caller. */
390 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
391 int read
, int write
, int exec
,
392 int modified
, void *data
);
394 /* Take over the 'find_mapped_memory' vector from exec.c. */
395 extern void exec_set_find_memory_regions
396 (int (*func
) (find_memory_region_ftype func
, void *data
));
398 /* Possible lvalue types. Like enum language, this should be in
399 value.h, but needs to be here for the same reason. */
407 /* In a register. Registers are relative to a frame. */
409 /* In a gdb internal variable. */
411 /* Part of a gdb internal variable (structure field). */
412 lval_internalvar_component
,
413 /* Value's bits are fetched and stored using functions provided by
418 /* Control types for commands */
420 enum misc_command_type
428 enum command_control_type
437 while_stepping_control
,
441 /* Structure for saved commands lines
442 (for breakpoints, defined commands, etc). */
446 struct command_line
*next
;
448 enum command_control_type control_type
;
449 /* The number of elements in body_list. */
451 /* For composite commands, the nested lists of commands. For
452 example, for "if" command this will contain the then branch and
453 the else branch, if that is available. */
454 struct command_line
**body_list
;
457 extern struct command_line
*read_command_lines (char *, int, int,
458 void (*)(char *, void *),
460 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
461 void (*)(char *, void *),
464 extern void free_command_lines (struct command_line
**);
466 /* Parameters of the "info proc" command. */
470 /* Display the default cmdline, cwd and exe outputs. */
473 /* Display `info proc mappings'. */
476 /* Display `info proc status'. */
479 /* Display `info proc stat'. */
482 /* Display `info proc cmdline'. */
485 /* Display `info proc exe'. */
488 /* Display `info proc cwd'. */
491 /* Display all of the above. */
495 /* String containing the current directory (what getwd would return). */
497 extern char *current_directory
;
499 /* Default radixes for input and output. Only some values supported. */
500 extern unsigned input_radix
;
501 extern unsigned output_radix
;
503 /* Possibilities for prettyprint parameters to routines which print
504 things. Like enum language, this should be in value.h, but needs
505 to be here for the same reason. FIXME: If we can eliminate this
506 as an arg to LA_VAL_PRINT, then we can probably move it back to
511 Val_no_prettyprint
= 0,
513 /* Use the default setting which the user has specified. */
517 /* Optional native machine support. Non-native (and possibly pure
518 multi-arch) targets do not need a "nm.h" file. This will be a
519 symlink to one of the nm-*.h files, built by the `configure'
526 /* Assume that fopen accepts the letter "b" in the mode string.
527 It is demanded by ISO C9X, and should be supported on all
528 platforms that claim to have a standard-conforming C library. On
529 true POSIX systems it will be ignored and have no effect. There
530 may still be systems without a standard-conforming C library where
531 an ISO C9X compiler (GCC) is available. Known examples are SunOS
532 4.x and 4.3BSD. This assumption means these systems are no longer
535 # include "fopen-bin.h"
538 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
539 FIXME: Assumes 2's complement arithmetic. */
541 #if !defined (UINT_MAX)
542 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
545 #if !defined (INT_MAX)
546 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
549 #if !defined (INT_MIN)
550 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
553 #if !defined (ULONG_MAX)
554 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
557 #if !defined (LONG_MAX)
558 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
561 #if !defined (ULONGEST_MAX)
562 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
565 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
566 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
569 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
570 arguments to a function, number in a value history, register number, etc.)
571 where the value must not be larger than can fit in an int. */
573 extern int longest_to_int (LONGEST
);
575 /* Utility macros to allocate typed memory. Avoids errors like:
576 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
577 sizeof (struct foo), 0). */
578 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
579 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
580 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
582 #include "common-utils.h"
584 /* List of known OS ABIs. If you change this, make sure to update the
588 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
590 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
597 GDB_OSABI_FREEBSD_AOUT
,
598 GDB_OSABI_FREEBSD_ELF
,
599 GDB_OSABI_NETBSD_AOUT
,
600 GDB_OSABI_NETBSD_ELF
,
601 GDB_OSABI_OPENBSD_ELF
,
616 GDB_OSABI_INVALID
/* keep this last */
619 /* Global functions from other, non-gdb GNU thingies.
620 Libiberty thingies are no longer declared here. We include libiberty.h
623 /* From other system libraries */
633 #define min(a, b) ((a) < (b) ? (a) : (b))
636 #define max(a, b) ((a) > (b) ? (a) : (b))
641 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
644 /* Various possibilities for alloca. */
647 #define alloca __builtin_alloca
648 #else /* Not GNU C */
656 /* We need to be careful not to declare this in a way which conflicts with
657 bison. Bison never declares it as char *, but under various circumstances
658 (like __hpux) we need to use void *. */
659 extern void *alloca ();
660 #endif /* Not _AIX */
661 #endif /* Not HAVE_ALLOCA_H */
662 #endif /* Not GNU C */
663 #endif /* alloca not defined */
665 /* Dynamic target-system-dependent parameters for GDB. */
668 /* Maximum size of a register. Something small, but large enough for
669 all known ISAs. If it turns out to be too small, make it bigger. */
671 enum { MAX_REGISTER_SIZE
= 64 };
673 /* Static target-system-dependent parameters for GDB. */
675 /* Number of bits in a char or unsigned char for the target machine.
676 Just like CHAR_BIT in <limits.h> but describes the target machine. */
677 #if !defined (TARGET_CHAR_BIT)
678 #define TARGET_CHAR_BIT 8
681 /* If we picked up a copy of CHAR_BIT from a configuration file
682 (which may get it by including <limits.h>) then use it to set
683 the number of bits in a host char. If not, use the same size
686 #if defined (CHAR_BIT)
687 #define HOST_CHAR_BIT CHAR_BIT
689 #define HOST_CHAR_BIT TARGET_CHAR_BIT
694 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
697 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
700 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
701 enum bfd_endian
, LONGEST
*);
703 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
706 extern void store_signed_integer (gdb_byte
*, int,
707 enum bfd_endian
, LONGEST
);
709 extern void store_unsigned_integer (gdb_byte
*, int,
710 enum bfd_endian
, ULONGEST
);
712 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
720 /* Hooks for alternate command interfaces. */
722 /* The name of the interpreter if specified on the command line. */
723 extern char *interpreter_p
;
725 /* If a given interpreter matches INTERPRETER_P then it should update
726 deprecated_command_loop_hook and deprecated_init_ui_hook with the
727 per-interpreter implementation. */
728 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
729 should be moved here. */
731 struct target_waitstatus
;
732 struct cmd_list_element
;
734 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
735 extern void (*deprecated_post_add_symbol_hook
) (void);
736 extern void (*selected_frame_level_changed_hook
) (int);
737 extern int (*deprecated_ui_loop_hook
) (int signo
);
738 extern void (*deprecated_init_ui_hook
) (char *argv0
);
739 extern void (*deprecated_command_loop_hook
) (void);
740 extern void (*deprecated_show_load_progress
) (const char *section
,
741 unsigned long section_sent
,
742 unsigned long section_size
,
743 unsigned long total_sent
,
744 unsigned long total_size
);
745 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
749 extern int (*deprecated_query_hook
) (const char *, va_list)
750 ATTRIBUTE_FPTR_PRINTF(1,0);
751 extern void (*deprecated_warning_hook
) (const char *, va_list)
752 ATTRIBUTE_FPTR_PRINTF(1,0);
753 extern void (*deprecated_flush_hook
) (struct ui_file
* stream
);
754 extern void (*deprecated_interactive_hook
) (void);
755 extern void (*deprecated_readline_begin_hook
) (char *, ...)
756 ATTRIBUTE_FPTR_PRINTF_1
;
757 extern char *(*deprecated_readline_hook
) (char *);
758 extern void (*deprecated_readline_end_hook
) (void);
759 extern void (*deprecated_register_changed_hook
) (int regno
);
760 extern void (*deprecated_context_hook
) (int);
761 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
762 struct target_waitstatus
*status
,
765 extern void (*deprecated_attach_hook
) (void);
766 extern void (*deprecated_detach_hook
) (void);
767 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
768 char *cmd
, int from_tty
);
770 extern void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
772 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
775 /* Inhibit window interface if non-zero. */
777 extern int use_windows
;
779 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
780 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
781 in the code actually refer to a lightweight process id, i.e,
782 something that can be considered a process id in its own right for
786 #define PIDGET(PTID) (ptid_get_pid (PTID))
787 #define TIDGET(PTID) (ptid_get_lwp (PTID))
788 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
791 /* Define well known filenos if the system does not define them. */
793 #define STDIN_FILENO 0
795 #ifndef STDOUT_FILENO
796 #define STDOUT_FILENO 1
798 #ifndef STDERR_FILENO
799 #define STDERR_FILENO 2
802 /* If this definition isn't overridden by the header files, assume
803 that isatty and fileno exist on this system. */
805 #define ISATTY(FP) (isatty (fileno (FP)))
808 /* A width that can achieve a better legibility for GDB MI mode. */
809 #define GDB_MI_MSG_WIDTH 80
811 /* From progspace.c */
813 extern void initialize_progspace (void);
814 extern void initialize_inferiors (void);
816 /* Special block numbers */
822 FIRST_LOCAL_BLOCK
= 2
827 #endif /* #ifndef DEFS_H */