No longer create readonly regcache
[deliverable/binutils-gdb.git] / gdb / defs.h
1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
2 for now. */
3 /* Basic, host-specific, and target-specific definitions for GDB.
4 Copyright (C) 1986-2018 Free Software Foundation, Inc.
5
6 This file is part of GDB.
7
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.
12
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.
17
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/>. */
20
21 #ifndef DEFS_H
22 #define DEFS_H
23
24 #ifdef GDBSERVER
25 # error gdbserver should not include gdb/defs.h
26 #endif
27
28 #include "common-defs.h"
29
30 #include <sys/types.h>
31 #include <limits.h>
32
33 /* The libdecnumber library, on which GDB depends, includes a header file
34 called gstdint.h instead of relying directly on stdint.h. GDB, on the
35 other hand, includes stdint.h directly, relying on the fact that gnulib
36 generates a copy if the system doesn't provide one or if it is missing
37 some features. Unfortunately, gstdint.h and stdint.h cannot be included
38 at the same time, which may happen when we include a file from
39 libdecnumber.
40
41 The following macro definition effectively prevents the inclusion of
42 gstdint.h, as all the definitions it provides are guarded against
43 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
44 included, so it's ok to blank out gstdint.h. */
45 #define GCC_GENERATED_STDINT_H 1
46
47 #include <unistd.h>
48
49 #include <fcntl.h>
50
51 #include "gdb_wchar.h"
52
53 #include "ui-file.h"
54
55 #include "host-defs.h"
56 #include "common/enum-flags.h"
57
58 /* Scope types enumerator. List the types of scopes the compiler will
59 accept. */
60
61 enum compile_i_scope_types
62 {
63 COMPILE_I_INVALID_SCOPE,
64
65 /* A simple scope. Wrap an expression into a simple scope that
66 takes no arguments, returns no value, and uses the generic
67 function name "_gdb_expr". */
68
69 COMPILE_I_SIMPLE_SCOPE,
70
71 /* Do not wrap the expression,
72 it has to provide function "_gdb_expr" on its own. */
73 COMPILE_I_RAW_SCOPE,
74
75 /* A printable expression scope. Wrap an expression into a scope
76 suitable for the "compile print" command. It uses the generic
77 function name "_gdb_expr". COMPILE_I_PRINT_ADDRESS_SCOPE variant
78 is the usual one, taking address of the object.
79 COMPILE_I_PRINT_VALUE_SCOPE is needed for arrays where the array
80 name already specifies its address. See get_out_value_type. */
81 COMPILE_I_PRINT_ADDRESS_SCOPE,
82 COMPILE_I_PRINT_VALUE_SCOPE,
83 };
84
85
86 template<typename T>
87 using RequireLongest = gdb::Requires<gdb::Or<std::is_same<T, LONGEST>,
88 std::is_same<T, ULONGEST>>>;
89
90 /* Just in case they're not defined in stdio.h. */
91
92 #ifndef SEEK_SET
93 #define SEEK_SET 0
94 #endif
95 #ifndef SEEK_CUR
96 #define SEEK_CUR 1
97 #endif
98
99 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
100 It is used as an access modifier in calls to open(), where it acts
101 similarly to the "b" character in fopen()'s MODE argument. On Posix
102 platforms it should be a no-op, so it is defined as 0 here. This
103 ensures that the symbol may be used freely elsewhere in gdb. */
104
105 #ifndef O_BINARY
106 #define O_BINARY 0
107 #endif
108
109 #include "hashtab.h"
110
111 /* * Enable dbx commands if set. */
112 extern int dbx_commands;
113
114 /* * System root path, used to find libraries etc. */
115 extern char *gdb_sysroot;
116
117 /* * GDB datadir, used to store data files. */
118 extern char *gdb_datadir;
119
120 /* * If non-NULL, the possibly relocated path to python's "lib" directory
121 specified with --with-python. */
122 extern char *python_libdir;
123
124 /* * Search path for separate debug files. */
125 extern char *debug_file_directory;
126
127 /* GDB's SIGINT handler basically sets a flag; code that might take a
128 long time before it gets back to the event loop, and which ought to
129 be interruptible, checks this flag using the QUIT macro, which, if
130 GDB has the terminal, throws a quit exception.
131
132 In addition to setting a flag, the SIGINT handler also marks a
133 select/poll-able file descriptor as read-ready. That is used by
134 interruptible_select in order to support interrupting blocking I/O
135 in a race-free manner.
136
137 These functions use the extension_language_ops API to allow extension
138 language(s) and GDB SIGINT handling to coexist seamlessly. */
139
140 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
141 will clear the quit flag as a side effect. */
142 extern int check_quit_flag (void);
143 /* * Set the quit flag. */
144 extern void set_quit_flag (void);
145
146 /* The current quit handler (and its type). This is called from the
147 QUIT macro. See default_quit_handler below for default behavior.
148 Parts of GDB temporarily override this to e.g., completely suppress
149 Ctrl-C because it would not be safe to throw. E.g., normally, you
150 wouldn't want to quit between a RSP command and its response, as
151 that would break the communication with the target, but you may
152 still want to intercept the Ctrl-C and offer to disconnect if the
153 user presses Ctrl-C multiple times while the target is stuck
154 waiting for the wedged remote stub. */
155 typedef void (quit_handler_ftype) (void);
156 extern quit_handler_ftype *quit_handler;
157
158 /* The default quit handler. Checks whether Ctrl-C was pressed, and
159 if so:
160
161 - If GDB owns the terminal, throws a quit exception.
162
163 - If GDB does not own the terminal, forwards the Ctrl-C to the
164 target.
165 */
166 extern void default_quit_handler (void);
167
168 /* Flag that function quit should call quit_force. */
169 extern volatile int sync_quit_force_run;
170
171 extern void quit (void);
172
173 /* Helper for the QUIT macro. */
174
175 extern void maybe_quit (void);
176
177 /* Check whether a Ctrl-C was typed, and if so, call the current quit
178 handler. */
179 #define QUIT maybe_quit ()
180
181 /* Set the serial event associated with the quit flag. */
182 extern void quit_serial_event_set (void);
183
184 /* Clear the serial event associated with the quit flag. */
185 extern void quit_serial_event_clear (void);
186
187 /* * Languages represented in the symbol table and elsewhere.
188 This should probably be in language.h, but since enum's can't
189 be forward declared to satisfy opaque references before their
190 actual definition, needs to be here.
191
192 The constants here are in priority order. In particular,
193 demangling is attempted according to this order.
194
195 Note that there's ambiguity between the mangling schemes of some of
196 these languages, so some symbols could be successfully demangled by
197 several languages. For that reason, the constants here are sorted
198 in the order we'll attempt demangling them. For example: Rust uses
199 C++ mangling, so must come after C++; Ada must come last (see
200 ada_sniff_from_mangled_name). (Keep this order in sync with the
201 'languages' array in language.c.) */
202
203 enum language
204 {
205 language_unknown, /* Language not known */
206 language_auto, /* Placeholder for automatic setting */
207 language_c, /* C */
208 language_objc, /* Objective-C */
209 language_cplus, /* C++ */
210 language_d, /* D */
211 language_go, /* Go */
212 language_fortran, /* Fortran */
213 language_m2, /* Modula-2 */
214 language_asm, /* Assembly language */
215 language_pascal, /* Pascal */
216 language_opencl, /* OpenCL */
217 language_rust, /* Rust */
218 language_minimal, /* All other languages, minimal support only */
219 language_ada, /* Ada */
220 nr_languages
221 };
222
223 /* The number of bits needed to represent all languages, with enough
224 padding to allow for reasonable growth. */
225 #define LANGUAGE_BITS 5
226 gdb_static_assert (nr_languages <= (1 << LANGUAGE_BITS));
227
228 enum precision_type
229 {
230 single_precision,
231 double_precision,
232 unspecified_precision
233 };
234
235 /* * A generic, not quite boolean, enumeration. This is used for
236 set/show commands in which the options are on/off/automatic. */
237 enum auto_boolean
238 {
239 AUTO_BOOLEAN_TRUE,
240 AUTO_BOOLEAN_FALSE,
241 AUTO_BOOLEAN_AUTO
242 };
243
244 /* * Potential ways that a function can return a value of a given
245 type. */
246
247 enum return_value_convention
248 {
249 /* * Where the return value has been squeezed into one or more
250 registers. */
251 RETURN_VALUE_REGISTER_CONVENTION,
252 /* * Commonly known as the "struct return convention". The caller
253 passes an additional hidden first parameter to the caller. That
254 parameter contains the address at which the value being returned
255 should be stored. While typically, and historically, used for
256 large structs, this is convention is applied to values of many
257 different types. */
258 RETURN_VALUE_STRUCT_CONVENTION,
259 /* * Like the "struct return convention" above, but where the ABI
260 guarantees that the called function stores the address at which
261 the value being returned is stored in a well-defined location,
262 such as a register or memory slot in the stack frame. Don't use
263 this if the ABI doesn't explicitly guarantees this. */
264 RETURN_VALUE_ABI_RETURNS_ADDRESS,
265 /* * Like the "struct return convention" above, but where the ABI
266 guarantees that the address at which the value being returned is
267 stored will be available in a well-defined location, such as a
268 register or memory slot in the stack frame. Don't use this if
269 the ABI doesn't explicitly guarantees this. */
270 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
271 };
272
273 /* Needed for various prototypes */
274
275 struct symtab;
276 struct breakpoint;
277 struct frame_info;
278 struct gdbarch;
279 struct value;
280
281 /* From main.c. */
282
283 /* This really belong in utils.c (path-utils.c?), but it references some
284 globals that are currently only available to main.c. */
285 extern char *relocate_gdb_directory (const char *initial, int flag);
286
287 \f
288 /* Annotation stuff. */
289
290 extern int annotation_level; /* in stack.c */
291 \f
292
293 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
294 "const char *" in unistd.h, so we can't declare the argument
295 as "char *". */
296
297 EXTERN_C char *re_comp (const char *);
298
299 /* From symfile.c */
300
301 extern void symbol_file_command (const char *, int);
302
303 /* * Remote targets may wish to use this as their load function. */
304 extern void generic_load (const char *name, int from_tty);
305
306 /* From top.c */
307
308 typedef void initialize_file_ftype (void);
309
310 extern char *gdb_readline_wrapper (const char *);
311
312 extern char *command_line_input (const char *, int, const char *);
313
314 extern void print_prompt (void);
315
316 struct ui;
317
318 extern int input_interactive_p (struct ui *);
319
320 extern int info_verbose;
321
322 /* From printcmd.c */
323
324 extern void set_next_address (struct gdbarch *, CORE_ADDR);
325
326 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
327 struct ui_file *, int,
328 const char *);
329
330 extern int build_address_symbolic (struct gdbarch *,
331 CORE_ADDR addr,
332 int do_demangle,
333 char **name,
334 int *offset,
335 char **filename,
336 int *line,
337 int *unmapped);
338
339 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
340 extern const char *pc_prefix (CORE_ADDR);
341
342 /* From exec.c */
343
344 /* * Process memory area starting at ADDR with length SIZE. Area is
345 readable iff READ is non-zero, writable if WRITE is non-zero,
346 executable if EXEC is non-zero. Area is possibly changed against
347 its original file based copy if MODIFIED is non-zero. DATA is
348 passed without changes from a caller. */
349
350 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
351 int read, int write, int exec,
352 int modified, void *data);
353
354 /* * Possible lvalue types. Like enum language, this should be in
355 value.h, but needs to be here for the same reason. */
356
357 enum lval_type
358 {
359 /* * Not an lval. */
360 not_lval,
361 /* * In memory. */
362 lval_memory,
363 /* * In a register. Registers are relative to a frame. */
364 lval_register,
365 /* * In a gdb internal variable. */
366 lval_internalvar,
367 /* * Value encapsulates a callable defined in an extension language. */
368 lval_xcallable,
369 /* * Part of a gdb internal variable (structure field). */
370 lval_internalvar_component,
371 /* * Value's bits are fetched and stored using functions provided
372 by its creator. */
373 lval_computed
374 };
375
376 /* * Parameters of the "info proc" command. */
377
378 enum info_proc_what
379 {
380 /* * Display the default cmdline, cwd and exe outputs. */
381 IP_MINIMAL,
382
383 /* * Display `info proc mappings'. */
384 IP_MAPPINGS,
385
386 /* * Display `info proc status'. */
387 IP_STATUS,
388
389 /* * Display `info proc stat'. */
390 IP_STAT,
391
392 /* * Display `info proc cmdline'. */
393 IP_CMDLINE,
394
395 /* * Display `info proc exe'. */
396 IP_EXE,
397
398 /* * Display `info proc cwd'. */
399 IP_CWD,
400
401 /* * Display all of the above. */
402 IP_ALL
403 };
404
405 /* * String containing the current directory (what getwd would return). */
406
407 extern char *current_directory;
408
409 /* * Default radixes for input and output. Only some values supported. */
410 extern unsigned input_radix;
411 extern unsigned output_radix;
412
413 /* * Possibilities for prettyformat parameters to routines which print
414 things. Like enum language, this should be in value.h, but needs
415 to be here for the same reason. FIXME: If we can eliminate this
416 as an arg to LA_VAL_PRINT, then we can probably move it back to
417 value.h. */
418
419 enum val_prettyformat
420 {
421 Val_no_prettyformat = 0,
422 Val_prettyformat,
423 /* * Use the default setting which the user has specified. */
424 Val_prettyformat_default
425 };
426
427 /* * Optional native machine support. Non-native (and possibly pure
428 multi-arch) targets do not need a "nm.h" file. This will be a
429 symlink to one of the nm-*.h files, built by the `configure'
430 script. */
431
432 #ifdef GDB_NM_FILE
433 #include "nm.h"
434 #endif
435
436 /* Assume that fopen accepts the letter "b" in the mode string.
437 It is demanded by ISO C9X, and should be supported on all
438 platforms that claim to have a standard-conforming C library. On
439 true POSIX systems it will be ignored and have no effect. There
440 may still be systems without a standard-conforming C library where
441 an ISO C9X compiler (GCC) is available. Known examples are SunOS
442 4.x and 4.3BSD. This assumption means these systems are no longer
443 supported. */
444 #ifndef FOPEN_RB
445 # include "fopen-bin.h"
446 #endif
447
448 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
449 FIXME: Assumes 2's complement arithmetic. */
450
451 #if !defined (UINT_MAX)
452 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
453 #endif
454
455 #if !defined (INT_MAX)
456 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
457 #endif
458
459 #if !defined (INT_MIN)
460 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
461 #endif
462
463 #if !defined (ULONG_MAX)
464 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
465 #endif
466
467 #if !defined (LONG_MAX)
468 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
469 #endif
470
471 #if !defined (ULONGEST_MAX)
472 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
473 #endif
474
475 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
476 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
477 #endif
478
479 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
480 arguments to a function, number in a value history, register number, etc.)
481 where the value must not be larger than can fit in an int. */
482
483 extern int longest_to_int (LONGEST);
484
485 /* * List of known OS ABIs. If you change this, make sure to update the
486 table in osabi.c. */
487 enum gdb_osabi
488 {
489 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
490
491 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
492
493 GDB_OSABI_SVR4,
494 GDB_OSABI_HURD,
495 GDB_OSABI_SOLARIS,
496 GDB_OSABI_LINUX,
497 GDB_OSABI_FREEBSD,
498 GDB_OSABI_NETBSD,
499 GDB_OSABI_OPENBSD,
500 GDB_OSABI_WINCE,
501 GDB_OSABI_GO32,
502 GDB_OSABI_QNXNTO,
503 GDB_OSABI_CYGWIN,
504 GDB_OSABI_AIX,
505 GDB_OSABI_DICOS,
506 GDB_OSABI_DARWIN,
507 GDB_OSABI_SYMBIAN,
508 GDB_OSABI_OPENVMS,
509 GDB_OSABI_LYNXOS178,
510 GDB_OSABI_NEWLIB,
511 GDB_OSABI_SDE,
512
513 GDB_OSABI_INVALID /* keep this last */
514 };
515
516 /* Enumerate the requirements a symbol has in order to be evaluated.
517 These are listed in order of "strength" -- a later entry subsumes
518 earlier ones. This fine-grained distinction is important because
519 it allows for the evaluation of a TLS symbol during unwinding --
520 when unwinding one has access to registers, but not the frame
521 itself, because that is being constructed. */
522
523 enum symbol_needs_kind
524 {
525 /* No special requirements -- just memory. */
526 SYMBOL_NEEDS_NONE,
527
528 /* The symbol needs registers. */
529 SYMBOL_NEEDS_REGISTERS,
530
531 /* The symbol needs a frame. */
532 SYMBOL_NEEDS_FRAME
533 };
534
535 /* Dynamic target-system-dependent parameters for GDB. */
536 #include "gdbarch.h"
537
538 /* * Maximum size of a register. Something small, but large enough for
539 all known ISAs. If it turns out to be too small, make it bigger. */
540
541 enum { MAX_REGISTER_SIZE = 64 };
542
543 /* In findvar.c. */
544
545 template<typename T, typename = RequireLongest<T>>
546 T extract_integer (const gdb_byte *addr, int len, enum bfd_endian byte_order);
547
548 static inline LONGEST
549 extract_signed_integer (const gdb_byte *addr, int len,
550 enum bfd_endian byte_order)
551 {
552 return extract_integer<LONGEST> (addr, len, byte_order);
553 }
554
555 static inline ULONGEST
556 extract_unsigned_integer (const gdb_byte *addr, int len,
557 enum bfd_endian byte_order)
558 {
559 return extract_integer<ULONGEST> (addr, len, byte_order);
560 }
561
562 extern int extract_long_unsigned_integer (const gdb_byte *, int,
563 enum bfd_endian, LONGEST *);
564
565 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
566 struct type *type);
567
568 /* All 'store' functions accept a host-format integer and store a
569 target-format integer at ADDR which is LEN bytes long. */
570
571 template<typename T, typename = RequireLongest<T>>
572 extern void store_integer (gdb_byte *addr, int len, enum bfd_endian byte_order,
573 T val);
574
575 static inline void
576 store_signed_integer (gdb_byte *addr, int len,
577 enum bfd_endian byte_order, LONGEST val)
578 {
579 return store_integer (addr, len, byte_order, val);
580 }
581
582 static inline void
583 store_unsigned_integer (gdb_byte *addr, int len,
584 enum bfd_endian byte_order, ULONGEST val)
585 {
586 return store_integer (addr, len, byte_order, val);
587 }
588
589 extern void store_typed_address (gdb_byte *buf, struct type *type,
590 CORE_ADDR addr);
591
592 extern void copy_integer_to_size (gdb_byte *dest, int dest_size,
593 const gdb_byte *source, int source_size,
594 bool is_signed, enum bfd_endian byte_order);
595
596 /* From valops.c */
597
598 extern int watchdog;
599
600 /* From dwarf2read.c */
601
602 ULONGEST read_unsigned_leb128 (bfd *, const gdb_byte *, unsigned int *);
603
604 /* Hooks for alternate command interfaces. */
605
606 /* * The name of the interpreter if specified on the command line. */
607 extern char *interpreter_p;
608
609 struct target_waitstatus;
610 struct cmd_list_element;
611
612 extern void (*deprecated_pre_add_symbol_hook) (const char *);
613 extern void (*deprecated_post_add_symbol_hook) (void);
614 extern void (*selected_frame_level_changed_hook) (int);
615 extern int (*deprecated_ui_loop_hook) (int signo);
616 extern void (*deprecated_show_load_progress) (const char *section,
617 unsigned long section_sent,
618 unsigned long section_size,
619 unsigned long total_sent,
620 unsigned long total_size);
621 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
622 int line,
623 int stopline,
624 int noerror);
625 extern int (*deprecated_query_hook) (const char *, va_list)
626 ATTRIBUTE_FPTR_PRINTF(1,0);
627 extern void (*deprecated_warning_hook) (const char *, va_list)
628 ATTRIBUTE_FPTR_PRINTF(1,0);
629 extern void (*deprecated_interactive_hook) (void);
630 extern void (*deprecated_readline_begin_hook) (const char *, ...)
631 ATTRIBUTE_FPTR_PRINTF_1;
632 extern char *(*deprecated_readline_hook) (const char *);
633 extern void (*deprecated_readline_end_hook) (void);
634 extern void (*deprecated_context_hook) (int);
635 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
636 struct target_waitstatus *status,
637 int options);
638
639 extern void (*deprecated_attach_hook) (void);
640 extern void (*deprecated_detach_hook) (void);
641 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
642 const char *cmd, int from_tty);
643
644 extern int (*deprecated_ui_load_progress_hook) (const char *section,
645 unsigned long num);
646
647 /* If this definition isn't overridden by the header files, assume
648 that isatty and fileno exist on this system. */
649 #ifndef ISATTY
650 #define ISATTY(FP) (isatty (fileno (FP)))
651 #endif
652
653 /* * A width that can achieve a better legibility for GDB MI mode. */
654 #define GDB_MI_MSG_WIDTH 80
655
656 /* From progspace.c */
657
658 extern void initialize_progspace (void);
659 extern void initialize_inferiors (void);
660
661 /* * Special block numbers */
662
663 enum block_enum
664 {
665 GLOBAL_BLOCK = 0,
666 STATIC_BLOCK = 1,
667 FIRST_LOCAL_BLOCK = 2
668 };
669
670 /* User selection used in observer.h and multiple print functions. */
671
672 enum user_selected_what_flag
673 {
674 /* Inferior selected. */
675 USER_SELECTED_INFERIOR = 1 << 1,
676
677 /* Thread selected. */
678 USER_SELECTED_THREAD = 1 << 2,
679
680 /* Frame selected. */
681 USER_SELECTED_FRAME = 1 << 3
682 };
683 DEF_ENUM_FLAGS_TYPE (enum user_selected_what_flag, user_selected_what);
684
685 #include "utils.h"
686
687 #endif /* #ifndef DEFS_H */
This page took 0.048972 seconds and 4 git commands to generate.