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 extern int quit_flag;
175 extern int immediate_quit;
177 extern void quit (void);
179 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
180 benefits of having a ``QUIT'' macro rather than a function are
181 marginal. If the overhead of a QUIT function call is proving
182 significant then its calling frequency should probably be reduced
183 [kingdon]. A profile analyzing the current situtation is
187 if (quit_flag) quit (); \
188 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
191 /* Languages represented in the symbol table and elsewhere.
192 This should probably be in language.h, but since enum's can't
193 be forward declared to satisfy opaque references before their
194 actual definition, needs to be here. */
198 language_unknown, /* Language not known */
199 language_auto, /* Placeholder for automatic setting */
201 language_cplus, /* C++ */
203 language_go, /* Go */
204 language_objc, /* Objective-C */
205 language_java, /* Java */
206 language_fortran, /* Fortran */
207 language_m2, /* Modula-2 */
208 language_asm, /* Assembly language */
209 language_pascal, /* Pascal */
210 language_ada, /* Ada */
211 language_opencl, /* OpenCL */
212 language_minimal, /* All other languages, minimal support only */
220 unspecified_precision
223 /* A generic, not quite boolean, enumeration. */
231 /* Potential ways that a function can return a value of a given type. */
232 enum return_value_convention
234 /* Where the return value has been squeezed into one or more
236 RETURN_VALUE_REGISTER_CONVENTION,
237 /* Commonly known as the "struct return convention". The caller
238 passes an additional hidden first parameter to the caller. That
239 parameter contains the address at which the value being returned
240 should be stored. While typically, and historically, used for
241 large structs, this is convention is applied to values of many
243 RETURN_VALUE_STRUCT_CONVENTION,
244 /* Like the "struct return convention" above, but where the ABI
245 guarantees that the called function stores the address at which
246 the value being returned is stored in a well-defined location,
247 such as a register or memory slot in the stack frame. Don't use
248 this if the ABI doesn't explicitly guarantees this. */
249 RETURN_VALUE_ABI_RETURNS_ADDRESS,
250 /* Like the "struct return convention" above, but where the ABI
251 guarantees that the address at which the value being returned is
252 stored will be available in a well-defined location, such as a
253 register or memory slot in the stack frame. Don't use this if
254 the ABI doesn't explicitly guarantees this. */
255 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
258 /* Needed for various prototypes */
268 /* This really belong in utils.c (path-utils.c?), but it references some
269 globals that are currently only available to main.c. */
270 extern char *relocate_gdb_directory (const char *initial, int flag);
273 /* Annotation stuff. */
275 extern int annotation_level; /* in stack.c */
278 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
279 "const char *" in unistd.h, so we can't declare the argument
282 extern char *re_comp (const char *);
286 extern void symbol_file_command (char *, int);
288 /* Remote targets may wish to use this as their load function. */
289 extern void generic_load (char *name, int from_tty);
291 /* Report on STREAM the performance of memory transfer operation,
293 DATA_COUNT is the number of bytes transferred.
294 WRITE_COUNT is the number of separate write operations, or 0,
295 if that information is not available.
296 START_TIME is the time at which an operation was started.
297 END_TIME is the time at which an operation ended. */
299 extern void print_transfer_performance (struct ui_file *stream,
300 unsigned long data_count,
301 unsigned long write_count,
302 const struct timeval *start_time,
303 const struct timeval *end_time);
307 typedef void initialize_file_ftype (void);
309 extern char *skip_quoted (char *);
311 extern char *gdb_readline (char *);
313 extern char *gdb_readline_wrapper (char *);
315 extern char *command_line_input (char *, int, char *);
317 extern void print_prompt (void);
319 extern int input_from_terminal_p (void);
321 extern int info_verbose;
323 /* From printcmd.c */
325 extern void set_next_address (struct gdbarch *, CORE_ADDR);
327 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
328 struct ui_file *, int, char *);
330 extern int build_address_symbolic (struct gdbarch *,
339 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
340 extern const char *pc_prefix (CORE_ADDR);
344 #define OPF_TRY_CWD_FIRST 0x01
345 #define OPF_SEARCH_IN_PATH 0x02
347 extern int openp (const char *, int, const char *, int, char **);
349 extern int source_full_path_of (const char *, char **);
351 extern void mod_path (char *, char **);
353 extern void add_path (char *, char **, int);
355 extern void directory_command (char *, int);
357 extern void directory_switch (char *, int);
359 extern char *source_path;
361 extern void init_source_path (void);
365 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
366 int read, int write, int exec,
369 /* Take over the 'find_mapped_memory' vector from exec.c. */
370 extern void exec_set_find_memory_regions
371 (int (*func) (find_memory_region_ftype func, void *data));
373 /* Possible lvalue types. Like enum language, this should be in
374 value.h, but needs to be here for the same reason. */
382 /* In a register. Registers are relative to a frame. */
384 /* In a gdb internal variable. */
386 /* Part of a gdb internal variable (structure field). */
387 lval_internalvar_component,
388 /* Value's bits are fetched and stored using functions provided by
393 /* Control types for commands */
395 enum misc_command_type
403 enum command_control_type
412 while_stepping_control,
416 /* Structure for saved commands lines
417 (for breakpoints, defined commands, etc). */
421 struct command_line *next;
423 enum command_control_type control_type;
424 /* The number of elements in body_list. */
426 /* For composite commands, the nested lists of commands. For
427 example, for "if" command this will contain the then branch and
428 the else branch, if that is available. */
429 struct command_line **body_list;
432 extern struct command_line *read_command_lines (char *, int, int,
433 void (*)(char *, void *),
435 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
436 void (*)(char *, void *),
439 extern void free_command_lines (struct command_line **);
441 /* Parameters of the "info proc" command. */
445 /* Display the default cmdline, cwd and exe outputs. */
448 /* Display `info proc mappings'. */
451 /* Display `info proc status'. */
454 /* Display `info proc stat'. */
457 /* Display `info proc cmdline'. */
460 /* Display `info proc exe'. */
463 /* Display `info proc cwd'. */
466 /* Display all of the above. */
470 /* String containing the current directory (what getwd would return). */
472 extern char *current_directory;
474 /* Default radixes for input and output. Only some values supported. */
475 extern unsigned input_radix;
476 extern unsigned output_radix;
478 /* Possibilities for prettyprint parameters to routines which print
479 things. Like enum language, this should be in value.h, but needs
480 to be here for the same reason. FIXME: If we can eliminate this
481 as an arg to LA_VAL_PRINT, then we can probably move it back to
486 Val_no_prettyprint = 0,
488 /* Use the default setting which the user has specified. */
492 /* Optional native machine support. Non-native (and possibly pure
493 multi-arch) targets do not need a "nm.h" file. This will be a
494 symlink to one of the nm-*.h files, built by the `configure'
501 /* Assume that fopen accepts the letter "b" in the mode string.
502 It is demanded by ISO C9X, and should be supported on all
503 platforms that claim to have a standard-conforming C library. On
504 true POSIX systems it will be ignored and have no effect. There
505 may still be systems without a standard-conforming C library where
506 an ISO C9X compiler (GCC) is available. Known examples are SunOS
507 4.x and 4.3BSD. This assumption means these systems are no longer
510 # include "fopen-bin.h"
513 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
514 FIXME: Assumes 2's complement arithmetic. */
516 #if !defined (UINT_MAX)
517 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
520 #if !defined (INT_MAX)
521 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
524 #if !defined (INT_MIN)
525 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
528 #if !defined (ULONG_MAX)
529 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
532 #if !defined (LONG_MAX)
533 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
536 #if !defined (ULONGEST_MAX)
537 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
540 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
541 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
544 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
545 arguments to a function, number in a value history, register number, etc.)
546 where the value must not be larger than can fit in an int. */
548 extern int longest_to_int (LONGEST);
550 /* Utility macros to allocate typed memory. Avoids errors like:
551 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
552 sizeof (struct foo), 0). */
553 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
554 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
555 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
557 #include "common-utils.h"
559 /* List of known OS ABIs. If you change this, make sure to update the
563 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
565 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
572 GDB_OSABI_FREEBSD_AOUT,
573 GDB_OSABI_FREEBSD_ELF,
574 GDB_OSABI_NETBSD_AOUT,
575 GDB_OSABI_NETBSD_ELF,
576 GDB_OSABI_OPENBSD_ELF,
591 GDB_OSABI_INVALID /* keep this last */
594 /* Global functions from other, non-gdb GNU thingies.
595 Libiberty thingies are no longer declared here. We include libiberty.h
598 /* From other system libraries */
608 #define min(a, b) ((a) < (b) ? (a) : (b))
611 #define max(a, b) ((a) > (b) ? (a) : (b))
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 /* Define well known filenos if the system does not define them. */
768 #define STDIN_FILENO 0
770 #ifndef STDOUT_FILENO
771 #define STDOUT_FILENO 1
773 #ifndef STDERR_FILENO
774 #define STDERR_FILENO 2
777 /* If this definition isn't overridden by the header files, assume
778 that isatty and fileno exist on this system. */
780 #define ISATTY(FP) (isatty (fileno (FP)))
783 /* A width that can achieve a better legibility for GDB MI mode. */
784 #define GDB_MI_MSG_WIDTH 80
786 /* From progspace.c */
788 extern void initialize_progspace (void);
789 extern void initialize_inferiors (void);
791 /* Special block numbers */
797 FIRST_LOCAL_BLOCK = 2
802 #endif /* #ifndef DEFS_H */