1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
3 /* Basic, host-specific, and target-specific definitions for GDB.
4 Copyright (C) 1986-2014 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
55 /* For gnulib's PATH_MAX. */
60 /* First include ansidecl.h so we can use the various macro definitions
61 here and in all subsequent file inclusions. */
65 #include "gdb_locale.h"
67 #include "gdb_wchar.h"
69 /* For ``enum gdb_signal''. */
70 #include "gdb/signals.h"
74 #include "host-defs.h"
76 /* Just in case they're not defined in stdio.h. */
85 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
86 It is used as an access modifier in calls to open(), where it acts
87 similarly to the "b" character in fopen()'s MODE argument. On Posix
88 platforms it should be a no-op, so it is defined as 0 here. This
89 ensures that the symbol may be used freely elsewhere in gdb. */
95 #include <stdarg.h> /* For va_list. */
97 #include "libiberty.h"
100 /* Rather than duplicate all the logic in BFD for figuring out what
101 types to use (which can be pretty complicated), symply define them
102 in terms of the corresponding type from BFD. */
106 /* A byte from the program being debugged. */
107 typedef bfd_byte gdb_byte;
109 /* An address in the program being debugged. Host byte order. */
110 typedef bfd_vma CORE_ADDR;
112 /* The largest CORE_ADDR value. */
113 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
115 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
119 #define LONGEST BFD_HOST_64_BIT
120 #define ULONGEST BFD_HOST_U_64_BIT
124 #define LONGEST long long
125 #define ULONGEST unsigned long long
127 #endif /* No BFD64 */
130 #define min(a, b) ((a) < (b) ? (a) : (b))
133 #define max(a, b) ((a) > (b) ? (a) : (b))
138 /* Enable xdb commands if set. */
139 extern int xdb_commands;
141 /* Enable dbx commands if set. */
142 extern int dbx_commands;
144 /* System root path, used to find libraries etc. */
145 extern char *gdb_sysroot;
147 /* GDB datadir, used to store data files. */
148 extern char *gdb_datadir;
150 /* If non-NULL, the possibly relocated path to python's "lib" directory
151 specified with --with-python. */
152 extern char *python_libdir;
154 /* Search path for separate debug files. */
155 extern char *debug_file_directory;
157 /* GDB has two methods for handling SIGINT. When immediate_quit is
158 nonzero, a SIGINT results in an immediate longjmp out of the signal
159 handler. Otherwise, SIGINT simply sets a flag; code that might
160 take a long time, and which ought to be interruptible, checks this
161 flag using the QUIT macro.
163 These functions use the extension_language_ops API to allow extension
164 language(s) and GDB SIGINT handling to coexist seamlessly. */
166 /* Clear the quit flag. */
167 extern void clear_quit_flag (void);
168 /* Evaluate to non-zero if the quit flag is set, zero otherwise. This
169 will clear the quit flag as a side effect. */
170 extern int check_quit_flag (void);
171 /* Set the quit flag. */
172 extern void set_quit_flag (void);
174 extern int immediate_quit;
176 extern void quit (void);
178 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
179 benefits of having a ``QUIT'' macro rather than a function are
180 marginal. If the overhead of a QUIT function call is proving
181 significant then its calling frequency should probably be reduced
182 [kingdon]. A profile analyzing the current situtation is
186 if (check_quit_flag ()) quit (); \
187 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
190 /* Languages represented in the symbol table and elsewhere.
191 This should probably be in language.h, but since enum's can't
192 be forward declared to satisfy opaque references before their
193 actual definition, needs to be here. */
197 language_unknown, /* Language not known */
198 language_auto, /* Placeholder for automatic setting */
200 language_cplus, /* C++ */
202 language_go, /* Go */
203 language_objc, /* Objective-C */
204 language_java, /* Java */
205 language_fortran, /* Fortran */
206 language_m2, /* Modula-2 */
207 language_asm, /* Assembly language */
208 language_pascal, /* Pascal */
209 language_ada, /* Ada */
210 language_opencl, /* OpenCL */
211 language_minimal, /* All other languages, minimal support only */
219 unspecified_precision
222 /* A generic, not quite boolean, enumeration. */
230 /* Potential ways that a function can return a value of a given type. */
231 enum return_value_convention
233 /* Where the return value has been squeezed into one or more
235 RETURN_VALUE_REGISTER_CONVENTION,
236 /* Commonly known as the "struct return convention". The caller
237 passes an additional hidden first parameter to the caller. That
238 parameter contains the address at which the value being returned
239 should be stored. While typically, and historically, used for
240 large structs, this is convention is applied to values of many
242 RETURN_VALUE_STRUCT_CONVENTION,
243 /* Like the "struct return convention" above, but where the ABI
244 guarantees that the called function stores the address at which
245 the value being returned is stored in a well-defined location,
246 such as a register or memory slot in the stack frame. Don't use
247 this if the ABI doesn't explicitly guarantees this. */
248 RETURN_VALUE_ABI_RETURNS_ADDRESS,
249 /* Like the "struct return convention" above, but where the ABI
250 guarantees that the address at which the value being returned is
251 stored will be available in a well-defined location, such as a
252 register or memory slot in the stack frame. Don't use this if
253 the ABI doesn't explicitly guarantees this. */
254 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
257 /* Needed for various prototypes */
267 /* This really belong in utils.c (path-utils.c?), but it references some
268 globals that are currently only available to main.c. */
269 extern char *relocate_gdb_directory (const char *initial, int flag);
272 /* Annotation stuff. */
274 extern int annotation_level; /* in stack.c */
277 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
278 "const char *" in unistd.h, so we can't declare the argument
281 extern char *re_comp (const char *);
285 extern void symbol_file_command (char *, int);
287 /* Remote targets may wish to use this as their load function. */
288 extern void generic_load (char *name, int from_tty);
290 /* Report on STREAM the performance of memory transfer operation,
292 DATA_COUNT is the number of bytes transferred.
293 WRITE_COUNT is the number of separate write operations, or 0,
294 if that information is not available.
295 START_TIME is the time at which an operation was started.
296 END_TIME is the time at which an operation ended. */
298 extern void print_transfer_performance (struct ui_file *stream,
299 unsigned long data_count,
300 unsigned long write_count,
301 const struct timeval *start_time,
302 const struct timeval *end_time);
306 typedef void initialize_file_ftype (void);
308 extern char *gdb_readline (char *);
310 extern char *gdb_readline_wrapper (char *);
312 extern char *command_line_input (char *, int, char *);
314 extern void print_prompt (void);
316 extern int input_from_terminal_p (void);
318 extern int info_verbose;
320 /* From printcmd.c */
322 extern void set_next_address (struct gdbarch *, CORE_ADDR);
324 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
325 struct ui_file *, int, char *);
327 extern int build_address_symbolic (struct gdbarch *,
336 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
337 extern const char *pc_prefix (CORE_ADDR);
341 /* See openp function definition for their description. */
342 #define OPF_TRY_CWD_FIRST 0x01
343 #define OPF_SEARCH_IN_PATH 0x02
344 #define OPF_RETURN_REALPATH 0x04
346 extern int openp (const char *, int, const char *, int, char **);
348 extern int source_full_path_of (const char *, char **);
350 extern void mod_path (char *, char **);
352 extern void add_path (char *, char **, int);
354 extern void directory_switch (char *, int);
356 extern char *source_path;
358 extern void init_source_path (void);
362 /* Process memory area starting at ADDR with length SIZE. Area is readable iff
363 READ is non-zero, writable if WRITE is non-zero, executable if EXEC is
364 non-zero. Area is possibly changed against its original file based copy if
365 MODIFIED is non-zero. DATA is passed without changes from a caller. */
367 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
368 int read, int write, int exec,
369 int modified, void *data);
371 /* Possible lvalue types. Like enum language, this should be in
372 value.h, but needs to be here for the same reason. */
380 /* In a register. Registers are relative to a frame. */
382 /* In a gdb internal variable. */
384 /* Part of a gdb internal variable (structure field). */
385 lval_internalvar_component,
386 /* Value's bits are fetched and stored using functions provided by
391 /* Control types for commands */
393 enum misc_command_type
401 enum command_control_type
411 while_stepping_control,
415 /* Structure for saved commands lines
416 (for breakpoints, defined commands, etc). */
420 struct command_line *next;
422 enum command_control_type control_type;
423 /* The number of elements in body_list. */
425 /* For composite commands, the nested lists of commands. For
426 example, for "if" command this will contain the then branch and
427 the else branch, if that is available. */
428 struct command_line **body_list;
431 extern struct command_line *read_command_lines (char *, int, int,
432 void (*)(char *, void *),
434 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
435 void (*)(char *, void *),
438 extern void free_command_lines (struct command_line **);
440 /* Parameters of the "info proc" command. */
444 /* Display the default cmdline, cwd and exe outputs. */
447 /* Display `info proc mappings'. */
450 /* Display `info proc status'. */
453 /* Display `info proc stat'. */
456 /* Display `info proc cmdline'. */
459 /* Display `info proc exe'. */
462 /* Display `info proc cwd'. */
465 /* Display all of the above. */
469 /* String containing the current directory (what getwd would return). */
471 extern char *current_directory;
473 /* Default radixes for input and output. Only some values supported. */
474 extern unsigned input_radix;
475 extern unsigned output_radix;
477 /* Possibilities for prettyformat parameters to routines which print
478 things. Like enum language, this should be in value.h, but needs
479 to be here for the same reason. FIXME: If we can eliminate this
480 as an arg to LA_VAL_PRINT, then we can probably move it back to
483 enum val_prettyformat
485 Val_no_prettyformat = 0,
487 /* Use the default setting which the user has specified. */
488 Val_prettyformat_default
491 /* Optional native machine support. Non-native (and possibly pure
492 multi-arch) targets do not need a "nm.h" file. This will be a
493 symlink to one of the nm-*.h files, built by the `configure'
500 /* Assume that fopen accepts the letter "b" in the mode string.
501 It is demanded by ISO C9X, and should be supported on all
502 platforms that claim to have a standard-conforming C library. On
503 true POSIX systems it will be ignored and have no effect. There
504 may still be systems without a standard-conforming C library where
505 an ISO C9X compiler (GCC) is available. Known examples are SunOS
506 4.x and 4.3BSD. This assumption means these systems are no longer
509 # include "fopen-bin.h"
512 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
513 FIXME: Assumes 2's complement arithmetic. */
515 #if !defined (UINT_MAX)
516 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
519 #if !defined (INT_MAX)
520 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
523 #if !defined (INT_MIN)
524 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
527 #if !defined (ULONG_MAX)
528 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
531 #if !defined (LONG_MAX)
532 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
535 #if !defined (ULONGEST_MAX)
536 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
539 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
540 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
543 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
544 arguments to a function, number in a value history, register number, etc.)
545 where the value must not be larger than can fit in an int. */
547 extern int longest_to_int (LONGEST);
549 #include "common-utils.h"
551 /* List of known OS ABIs. If you change this, make sure to update the
555 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
557 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
564 GDB_OSABI_FREEBSD_AOUT,
565 GDB_OSABI_FREEBSD_ELF,
566 GDB_OSABI_NETBSD_AOUT,
567 GDB_OSABI_NETBSD_ELF,
568 GDB_OSABI_OPENBSD_ELF,
584 GDB_OSABI_INVALID /* keep this last */
587 /* Global functions from other, non-gdb GNU thingies.
588 Libiberty thingies are no longer declared here. We include libiberty.h
591 /* From other system libraries */
597 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
600 /* Various possibilities for alloca. */
603 #define alloca __builtin_alloca
604 #else /* Not GNU C */
612 /* We need to be careful not to declare this in a way which conflicts with
613 bison. Bison never declares it as char *, but under various circumstances
614 (like __hpux) we need to use void *. */
615 extern void *alloca ();
616 #endif /* Not _AIX */
617 #endif /* Not HAVE_ALLOCA_H */
618 #endif /* Not GNU C */
619 #endif /* alloca not defined */
621 /* Dynamic target-system-dependent parameters for GDB. */
624 /* Maximum size of a register. Something small, but large enough for
625 all known ISAs. If it turns out to be too small, make it bigger. */
627 enum { MAX_REGISTER_SIZE = 64 };
629 /* Static target-system-dependent parameters for GDB. */
631 /* Number of bits in a char or unsigned char for the target machine.
632 Just like CHAR_BIT in <limits.h> but describes the target machine. */
633 #if !defined (TARGET_CHAR_BIT)
634 #define TARGET_CHAR_BIT 8
637 /* If we picked up a copy of CHAR_BIT from a configuration file
638 (which may get it by including <limits.h>) then use it to set
639 the number of bits in a host char. If not, use the same size
642 #if defined (CHAR_BIT)
643 #define HOST_CHAR_BIT CHAR_BIT
645 #define HOST_CHAR_BIT TARGET_CHAR_BIT
650 extern LONGEST extract_signed_integer (const gdb_byte *, int,
653 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
656 extern int extract_long_unsigned_integer (const gdb_byte *, int,
657 enum bfd_endian, LONGEST *);
659 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
662 extern void store_signed_integer (gdb_byte *, int,
663 enum bfd_endian, LONGEST);
665 extern void store_unsigned_integer (gdb_byte *, int,
666 enum bfd_endian, ULONGEST);
668 extern void store_typed_address (gdb_byte *buf, struct type *type,
676 /* Hooks for alternate command interfaces. */
678 /* The name of the interpreter if specified on the command line. */
679 extern char *interpreter_p;
681 /* If a given interpreter matches INTERPRETER_P then it should update
682 deprecated_init_ui_hook with the per-interpreter implementation. */
683 /* FIXME: deprecated_init_ui_hook should be moved here. */
685 struct target_waitstatus;
686 struct cmd_list_element;
688 extern void (*deprecated_pre_add_symbol_hook) (const char *);
689 extern void (*deprecated_post_add_symbol_hook) (void);
690 extern void (*selected_frame_level_changed_hook) (int);
691 extern int (*deprecated_ui_loop_hook) (int signo);
692 extern void (*deprecated_init_ui_hook) (char *argv0);
693 extern void (*deprecated_show_load_progress) (const char *section,
694 unsigned long section_sent,
695 unsigned long section_size,
696 unsigned long total_sent,
697 unsigned long total_size);
698 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
702 extern int (*deprecated_query_hook) (const char *, va_list)
703 ATTRIBUTE_FPTR_PRINTF(1,0);
704 extern void (*deprecated_warning_hook) (const char *, va_list)
705 ATTRIBUTE_FPTR_PRINTF(1,0);
706 extern void (*deprecated_interactive_hook) (void);
707 extern void (*deprecated_readline_begin_hook) (char *, ...)
708 ATTRIBUTE_FPTR_PRINTF_1;
709 extern char *(*deprecated_readline_hook) (char *);
710 extern void (*deprecated_readline_end_hook) (void);
711 extern void (*deprecated_register_changed_hook) (int regno);
712 extern void (*deprecated_context_hook) (int);
713 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
714 struct target_waitstatus *status,
717 extern void (*deprecated_attach_hook) (void);
718 extern void (*deprecated_detach_hook) (void);
719 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
720 char *cmd, int from_tty);
722 extern int (*deprecated_ui_load_progress_hook) (const char *section,
725 /* If this definition isn't overridden by the header files, assume
726 that isatty and fileno exist on this system. */
728 #define ISATTY(FP) (isatty (fileno (FP)))
731 /* A width that can achieve a better legibility for GDB MI mode. */
732 #define GDB_MI_MSG_WIDTH 80
734 /* From progspace.c */
736 extern void initialize_progspace (void);
737 extern void initialize_inferiors (void);
739 /* Special block numbers */
745 FIRST_LOCAL_BLOCK = 2
750 #endif /* #ifndef DEFS_H */