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. */
30 #include "build-gnulib/config.h"
32 #include <sys/types.h>
34 #include <errno.h> /* System call error return status. */
38 /* The libdecnumber library, on which GDB depends, includes a header file
39 called gstdint.h instead of relying directly on stdint.h. GDB, on the
40 other hand, includes stdint.h directly, relying on the fact that gnulib
41 generates a copy if the system doesn't provide one or if it is missing
42 some features. Unfortunately, gstdint.h and stdint.h cannot be included
43 at the same time, which may happen when we include a file from
46 The following macro definition effectively prevents the inclusion of
47 gstdint.h, as all the definitions it provides are guarded against
48 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
49 included, so it's ok to blank out gstdint.h. */
50 #define GCC_GENERATED_STDINT_H 1
62 /* First include ansidecl.h so we can use the various macro definitions
63 here and in all subsequent file inclusions. */
67 #include "gdb_locale.h"
69 #include "gdb_wchar.h"
71 /* For ``enum gdb_signal''. */
72 #include "gdb/signals.h"
76 #include "host-defs.h"
78 /* Just in case they're not defined in stdio.h. */
87 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
88 It is used as an access modifier in calls to open(), where it acts
89 similarly to the "b" character in fopen()'s MODE argument. On Posix
90 platforms it should be a no-op, so it is defined as 0 here. This
91 ensures that the symbol may be used freely elsewhere in gdb. */
97 #include <stdarg.h> /* For va_list. */
99 #include "libiberty.h"
102 /* Rather than duplicate all the logic in BFD for figuring out what
103 types to use (which can be pretty complicated), symply define them
104 in terms of the corresponding type from BFD. */
108 /* A byte from the program being debugged. */
109 typedef bfd_byte gdb_byte
;
111 /* An address in the program being debugged. Host byte order. */
112 typedef bfd_vma CORE_ADDR
;
114 /* The largest CORE_ADDR value. */
115 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
117 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
121 #define LONGEST BFD_HOST_64_BIT
122 #define ULONGEST BFD_HOST_U_64_BIT
126 #define LONGEST long long
127 #define ULONGEST unsigned long long
129 #endif /* No BFD64 */
132 #define min(a, b) ((a) < (b) ? (a) : (b))
135 #define max(a, b) ((a) > (b) ? (a) : (b))
140 /* Enable xdb commands if set. */
141 extern int xdb_commands
;
143 /* Enable dbx commands if set. */
144 extern int dbx_commands
;
146 /* System root path, used to find libraries etc. */
147 extern char *gdb_sysroot
;
149 /* GDB datadir, used to store data files. */
150 extern char *gdb_datadir
;
152 /* If non-NULL, the possibly relocated path to python's "lib" directory
153 specified with --with-python. */
154 extern char *python_libdir
;
156 /* Search path for separate debug files. */
157 extern char *debug_file_directory
;
159 /* GDB has two methods for handling SIGINT. When immediate_quit is
160 nonzero, a SIGINT results in an immediate longjmp out of the signal
161 handler. Otherwise, SIGINT simply sets a flag; code that might
162 take a long time, and which ought to be interruptible, checks this
163 flag using the QUIT macro.
165 If GDB is built with Python support, it uses Python's low-level
166 interface to implement the flag. This approach makes it possible
167 for Python and GDB SIGINT handling to coexist seamlessly.
169 If GDB is built without Python, it instead uses its traditional
172 /* Clear the quit flag. */
173 extern void clear_quit_flag (void);
174 /* Evaluate to non-zero if the quit flag is set, zero otherwise. This
175 will clear the quit flag as a side effect. */
176 extern int check_quit_flag (void);
177 /* Set the quit flag. */
178 extern void set_quit_flag (void);
180 extern int immediate_quit
;
182 extern void quit (void);
184 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
185 benefits of having a ``QUIT'' macro rather than a function are
186 marginal. If the overhead of a QUIT function call is proving
187 significant then its calling frequency should probably be reduced
188 [kingdon]. A profile analyzing the current situtation is
192 if (check_quit_flag ()) quit (); \
193 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
196 /* Languages represented in the symbol table and elsewhere.
197 This should probably be in language.h, but since enum's can't
198 be forward declared to satisfy opaque references before their
199 actual definition, needs to be here. */
203 language_unknown
, /* Language not known */
204 language_auto
, /* Placeholder for automatic setting */
206 language_cplus
, /* C++ */
208 language_go
, /* Go */
209 language_objc
, /* Objective-C */
210 language_java
, /* Java */
211 language_fortran
, /* Fortran */
212 language_m2
, /* Modula-2 */
213 language_asm
, /* Assembly language */
214 language_pascal
, /* Pascal */
215 language_ada
, /* Ada */
216 language_opencl
, /* OpenCL */
217 language_minimal
, /* All other languages, minimal support only */
225 unspecified_precision
228 /* A generic, not quite boolean, enumeration. */
236 /* Potential ways that a function can return a value of a given type. */
237 enum return_value_convention
239 /* Where the return value has been squeezed into one or more
241 RETURN_VALUE_REGISTER_CONVENTION
,
242 /* Commonly known as the "struct return convention". The caller
243 passes an additional hidden first parameter to the caller. That
244 parameter contains the address at which the value being returned
245 should be stored. While typically, and historically, used for
246 large structs, this is convention is applied to values of many
248 RETURN_VALUE_STRUCT_CONVENTION
,
249 /* Like the "struct return convention" above, but where the ABI
250 guarantees that the called function stores the address at which
251 the value being returned is stored in a well-defined location,
252 such as a register or memory slot in the stack frame. Don't use
253 this if the ABI doesn't explicitly guarantees this. */
254 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
255 /* Like the "struct return convention" above, but where the ABI
256 guarantees that the address at which the value being returned is
257 stored will be available in a well-defined location, such as a
258 register or memory slot in the stack frame. Don't use this if
259 the ABI doesn't explicitly guarantees this. */
260 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
263 /* Needed for various prototypes */
273 /* This really belong in utils.c (path-utils.c?), but it references some
274 globals that are currently only available to main.c. */
275 extern char *relocate_gdb_directory (const char *initial
, int flag
);
278 /* Annotation stuff. */
280 extern int annotation_level
; /* in stack.c */
283 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
284 "const char *" in unistd.h, so we can't declare the argument
287 extern char *re_comp (const char *);
291 extern void symbol_file_command (char *, int);
293 /* Remote targets may wish to use this as their load function. */
294 extern void generic_load (char *name
, int from_tty
);
296 /* Report on STREAM the performance of memory transfer operation,
298 DATA_COUNT is the number of bytes transferred.
299 WRITE_COUNT is the number of separate write operations, or 0,
300 if that information is not available.
301 START_TIME is the time at which an operation was started.
302 END_TIME is the time at which an operation ended. */
304 extern void print_transfer_performance (struct ui_file
*stream
,
305 unsigned long data_count
,
306 unsigned long write_count
,
307 const struct timeval
*start_time
,
308 const struct timeval
*end_time
);
312 typedef void initialize_file_ftype (void);
314 extern char *skip_quoted (char *);
316 extern char *gdb_readline (char *);
318 extern char *gdb_readline_wrapper (char *);
320 extern char *command_line_input (char *, int, char *);
322 extern void print_prompt (void);
324 extern int input_from_terminal_p (void);
326 extern int info_verbose
;
328 /* From printcmd.c */
330 extern void set_next_address (struct gdbarch
*, CORE_ADDR
);
332 extern int print_address_symbolic (struct gdbarch
*, CORE_ADDR
,
333 struct ui_file
*, int, char *);
335 extern int build_address_symbolic (struct gdbarch
*,
344 extern void print_address (struct gdbarch
*, CORE_ADDR
, struct ui_file
*);
345 extern const char *pc_prefix (CORE_ADDR
);
349 #define OPF_TRY_CWD_FIRST 0x01
350 #define OPF_SEARCH_IN_PATH 0x02
352 extern int openp (const char *, int, const char *, int, char **);
354 extern int source_full_path_of (const char *, char **);
356 extern void mod_path (char *, char **);
358 extern void add_path (char *, char **, int);
360 extern void directory_command (char *, int);
362 extern void directory_switch (char *, int);
364 extern char *source_path
;
366 extern void init_source_path (void);
370 /* Process memory area starting at ADDR with length SIZE. Area is readable iff
371 READ is non-zero, writable if WRITE is non-zero, executable if EXEC is
372 non-zero. Area is possibly changed against its original file based copy if
373 MODIFIED is non-zero. DATA is passed without changes from a caller. */
375 typedef int (*find_memory_region_ftype
) (CORE_ADDR addr
, unsigned long size
,
376 int read
, int write
, int exec
,
377 int modified
, void *data
);
379 /* Take over the 'find_mapped_memory' vector from exec.c. */
380 extern void exec_set_find_memory_regions
381 (int (*func
) (find_memory_region_ftype func
, void *data
));
383 /* Possible lvalue types. Like enum language, this should be in
384 value.h, but needs to be here for the same reason. */
392 /* In a register. Registers are relative to a frame. */
394 /* In a gdb internal variable. */
396 /* Part of a gdb internal variable (structure field). */
397 lval_internalvar_component
,
398 /* Value's bits are fetched and stored using functions provided by
403 /* Control types for commands */
405 enum misc_command_type
413 enum command_control_type
422 while_stepping_control
,
426 /* Structure for saved commands lines
427 (for breakpoints, defined commands, etc). */
431 struct command_line
*next
;
433 enum command_control_type control_type
;
434 /* The number of elements in body_list. */
436 /* For composite commands, the nested lists of commands. For
437 example, for "if" command this will contain the then branch and
438 the else branch, if that is available. */
439 struct command_line
**body_list
;
442 extern struct command_line
*read_command_lines (char *, int, int,
443 void (*)(char *, void *),
445 extern struct command_line
*read_command_lines_1 (char * (*) (void), int,
446 void (*)(char *, void *),
449 extern void free_command_lines (struct command_line
**);
451 /* Parameters of the "info proc" command. */
455 /* Display the default cmdline, cwd and exe outputs. */
458 /* Display `info proc mappings'. */
461 /* Display `info proc status'. */
464 /* Display `info proc stat'. */
467 /* Display `info proc cmdline'. */
470 /* Display `info proc exe'. */
473 /* Display `info proc cwd'. */
476 /* Display all of the above. */
480 /* String containing the current directory (what getwd would return). */
482 extern char *current_directory
;
484 /* Default radixes for input and output. Only some values supported. */
485 extern unsigned input_radix
;
486 extern unsigned output_radix
;
488 /* Possibilities for prettyprint parameters to routines which print
489 things. Like enum language, this should be in value.h, but needs
490 to be here for the same reason. FIXME: If we can eliminate this
491 as an arg to LA_VAL_PRINT, then we can probably move it back to
496 Val_no_prettyprint
= 0,
498 /* Use the default setting which the user has specified. */
502 /* Optional native machine support. Non-native (and possibly pure
503 multi-arch) targets do not need a "nm.h" file. This will be a
504 symlink to one of the nm-*.h files, built by the `configure'
511 /* Assume that fopen accepts the letter "b" in the mode string.
512 It is demanded by ISO C9X, and should be supported on all
513 platforms that claim to have a standard-conforming C library. On
514 true POSIX systems it will be ignored and have no effect. There
515 may still be systems without a standard-conforming C library where
516 an ISO C9X compiler (GCC) is available. Known examples are SunOS
517 4.x and 4.3BSD. This assumption means these systems are no longer
520 # include "fopen-bin.h"
523 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
524 FIXME: Assumes 2's complement arithmetic. */
526 #if !defined (UINT_MAX)
527 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
530 #if !defined (INT_MAX)
531 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
534 #if !defined (INT_MIN)
535 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
538 #if !defined (ULONG_MAX)
539 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
542 #if !defined (LONG_MAX)
543 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
546 #if !defined (ULONGEST_MAX)
547 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
550 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
551 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
554 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
555 arguments to a function, number in a value history, register number, etc.)
556 where the value must not be larger than can fit in an int. */
558 extern int longest_to_int (LONGEST
);
560 /* Utility macros to allocate typed memory. Avoids errors like:
561 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
562 sizeof (struct foo), 0). */
563 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
564 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
565 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
567 #include "common-utils.h"
569 /* List of known OS ABIs. If you change this, make sure to update the
573 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
575 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
582 GDB_OSABI_FREEBSD_AOUT
,
583 GDB_OSABI_FREEBSD_ELF
,
584 GDB_OSABI_NETBSD_AOUT
,
585 GDB_OSABI_NETBSD_ELF
,
586 GDB_OSABI_OPENBSD_ELF
,
601 GDB_OSABI_INVALID
/* keep this last */
604 /* Global functions from other, non-gdb GNU thingies.
605 Libiberty thingies are no longer declared here. We include libiberty.h
608 /* From other system libraries */
620 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
623 /* Various possibilities for alloca. */
626 #define alloca __builtin_alloca
627 #else /* Not GNU C */
635 /* We need to be careful not to declare this in a way which conflicts with
636 bison. Bison never declares it as char *, but under various circumstances
637 (like __hpux) we need to use void *. */
638 extern void *alloca ();
639 #endif /* Not _AIX */
640 #endif /* Not HAVE_ALLOCA_H */
641 #endif /* Not GNU C */
642 #endif /* alloca not defined */
644 /* Dynamic target-system-dependent parameters for GDB. */
647 /* Maximum size of a register. Something small, but large enough for
648 all known ISAs. If it turns out to be too small, make it bigger. */
650 enum { MAX_REGISTER_SIZE
= 64 };
652 /* Static target-system-dependent parameters for GDB. */
654 /* Number of bits in a char or unsigned char for the target machine.
655 Just like CHAR_BIT in <limits.h> but describes the target machine. */
656 #if !defined (TARGET_CHAR_BIT)
657 #define TARGET_CHAR_BIT 8
660 /* If we picked up a copy of CHAR_BIT from a configuration file
661 (which may get it by including <limits.h>) then use it to set
662 the number of bits in a host char. If not, use the same size
665 #if defined (CHAR_BIT)
666 #define HOST_CHAR_BIT CHAR_BIT
668 #define HOST_CHAR_BIT TARGET_CHAR_BIT
673 extern LONGEST
extract_signed_integer (const gdb_byte
*, int,
676 extern ULONGEST
extract_unsigned_integer (const gdb_byte
*, int,
679 extern int extract_long_unsigned_integer (const gdb_byte
*, int,
680 enum bfd_endian
, LONGEST
*);
682 extern CORE_ADDR
extract_typed_address (const gdb_byte
*buf
,
685 extern void store_signed_integer (gdb_byte
*, int,
686 enum bfd_endian
, LONGEST
);
688 extern void store_unsigned_integer (gdb_byte
*, int,
689 enum bfd_endian
, ULONGEST
);
691 extern void store_typed_address (gdb_byte
*buf
, struct type
*type
,
699 /* Hooks for alternate command interfaces. */
701 /* The name of the interpreter if specified on the command line. */
702 extern char *interpreter_p
;
704 /* If a given interpreter matches INTERPRETER_P then it should update
705 deprecated_command_loop_hook and deprecated_init_ui_hook with the
706 per-interpreter implementation. */
707 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
708 should be moved here. */
710 struct target_waitstatus
;
711 struct cmd_list_element
;
713 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
714 extern void (*deprecated_post_add_symbol_hook
) (void);
715 extern void (*selected_frame_level_changed_hook
) (int);
716 extern int (*deprecated_ui_loop_hook
) (int signo
);
717 extern void (*deprecated_init_ui_hook
) (char *argv0
);
718 extern void (*deprecated_command_loop_hook
) (void);
719 extern void (*deprecated_show_load_progress
) (const char *section
,
720 unsigned long section_sent
,
721 unsigned long section_size
,
722 unsigned long total_sent
,
723 unsigned long total_size
);
724 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
728 extern int (*deprecated_query_hook
) (const char *, va_list)
729 ATTRIBUTE_FPTR_PRINTF(1,0);
730 extern void (*deprecated_warning_hook
) (const char *, va_list)
731 ATTRIBUTE_FPTR_PRINTF(1,0);
732 extern void (*deprecated_flush_hook
) (struct ui_file
* stream
);
733 extern void (*deprecated_interactive_hook
) (void);
734 extern void (*deprecated_readline_begin_hook
) (char *, ...)
735 ATTRIBUTE_FPTR_PRINTF_1
;
736 extern char *(*deprecated_readline_hook
) (char *);
737 extern void (*deprecated_readline_end_hook
) (void);
738 extern void (*deprecated_register_changed_hook
) (int regno
);
739 extern void (*deprecated_context_hook
) (int);
740 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
741 struct target_waitstatus
*status
,
744 extern void (*deprecated_attach_hook
) (void);
745 extern void (*deprecated_detach_hook
) (void);
746 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
747 char *cmd
, int from_tty
);
749 extern void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
751 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
754 /* Inhibit window interface if non-zero. */
756 extern int use_windows
;
758 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
759 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
760 in the code actually refer to a lightweight process id, i.e,
761 something that can be considered a process id in its own right for
765 #define PIDGET(PTID) (ptid_get_pid (PTID))
766 #define TIDGET(PTID) (ptid_get_lwp (PTID))
767 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
770 /* Define well known filenos if the system does not define them. */
772 #define STDIN_FILENO 0
774 #ifndef STDOUT_FILENO
775 #define STDOUT_FILENO 1
777 #ifndef STDERR_FILENO
778 #define STDERR_FILENO 2
781 /* If this definition isn't overridden by the header files, assume
782 that isatty and fileno exist on this system. */
784 #define ISATTY(FP) (isatty (fileno (FP)))
787 /* A width that can achieve a better legibility for GDB MI mode. */
788 #define GDB_MI_MSG_WIDTH 80
790 /* From progspace.c */
792 extern void initialize_progspace (void);
793 extern void initialize_inferiors (void);
795 /* Special block numbers */
801 FIRST_LOCAL_BLOCK
= 2
806 #endif /* #ifndef DEFS_H */