PR record/18691: Fix fails in solib-precsave.exp
[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-2015 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
57 /* Scope types enumerator. List the types of scopes the compiler will
58 accept. */
59
60 enum compile_i_scope_types
61 {
62 COMPILE_I_INVALID_SCOPE,
63
64 /* A simple scope. Wrap an expression into a simple scope that
65 takes no arguments, returns no value, and uses the generic
66 function name "_gdb_expr". */
67
68 COMPILE_I_SIMPLE_SCOPE,
69
70 /* Do not wrap the expression,
71 it has to provide function "_gdb_expr" on its own. */
72 COMPILE_I_RAW_SCOPE,
73
74 /* A printable expression scope. Wrap an expression into a scope
75 suitable for the "compile print" command. It uses the generic
76 function name "_gdb_expr". COMPILE_I_PRINT_ADDRESS_SCOPE variant
77 is the usual one, taking address of the object.
78 COMPILE_I_PRINT_VALUE_SCOPE is needed for arrays where the array
79 name already specifies its address. See get_out_value_type. */
80 COMPILE_I_PRINT_ADDRESS_SCOPE,
81 COMPILE_I_PRINT_VALUE_SCOPE,
82 };
83
84 /* Just in case they're not defined in stdio.h. */
85
86 #ifndef SEEK_SET
87 #define SEEK_SET 0
88 #endif
89 #ifndef SEEK_CUR
90 #define SEEK_CUR 1
91 #endif
92
93 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
94 It is used as an access modifier in calls to open(), where it acts
95 similarly to the "b" character in fopen()'s MODE argument. On Posix
96 platforms it should be a no-op, so it is defined as 0 here. This
97 ensures that the symbol may be used freely elsewhere in gdb. */
98
99 #ifndef O_BINARY
100 #define O_BINARY 0
101 #endif
102
103 #include "hashtab.h"
104
105 #ifndef min
106 #define min(a, b) ((a) < (b) ? (a) : (b))
107 #endif
108 #ifndef max
109 #define max(a, b) ((a) > (b) ? (a) : (b))
110 #endif
111
112 /* * Enable dbx commands if set. */
113 extern int dbx_commands;
114
115 /* * System root path, used to find libraries etc. */
116 extern char *gdb_sysroot;
117
118 /* * GDB datadir, used to store data files. */
119 extern char *gdb_datadir;
120
121 /* * If non-NULL, the possibly relocated path to python's "lib" directory
122 specified with --with-python. */
123 extern char *python_libdir;
124
125 /* * Search path for separate debug files. */
126 extern char *debug_file_directory;
127
128 /* GDB has two methods for handling SIGINT. When immediate_quit is
129 nonzero, a SIGINT results in an immediate longjmp out of the signal
130 handler. Otherwise, SIGINT simply sets a flag; code that might
131 take a long time, and which ought to be interruptible, checks this
132 flag using the QUIT macro.
133
134 These functions use the extension_language_ops API to allow extension
135 language(s) and GDB SIGINT handling to coexist seamlessly. */
136
137 /* * Clear the quit flag. */
138 extern void clear_quit_flag (void);
139 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
140 will clear the quit flag as a side effect. */
141 extern int check_quit_flag (void);
142 /* * Set the quit flag. */
143 extern void set_quit_flag (void);
144
145 /* Flag that function quit should call quit_force. */
146 extern volatile int sync_quit_force_run;
147
148 extern int immediate_quit;
149
150 extern void quit (void);
151
152 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
153 benefits of having a ``QUIT'' macro rather than a function are
154 marginal. If the overhead of a QUIT function call is proving
155 significant then its calling frequency should probably be reduced
156 [kingdon]. A profile analyzing the current situtation is
157 needed. */
158
159 #define QUIT { \
160 if (check_quit_flag () || sync_quit_force_run) quit (); \
161 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
162 }
163
164 /* * Languages represented in the symbol table and elsewhere.
165 This should probably be in language.h, but since enum's can't
166 be forward declared to satisfy opaque references before their
167 actual definition, needs to be here. */
168
169 enum language
170 {
171 language_unknown, /* Language not known */
172 language_auto, /* Placeholder for automatic setting */
173 language_c, /* C */
174 language_cplus, /* C++ */
175 language_d, /* D */
176 language_go, /* Go */
177 language_objc, /* Objective-C */
178 language_java, /* Java */
179 language_fortran, /* Fortran */
180 language_m2, /* Modula-2 */
181 language_asm, /* Assembly language */
182 language_pascal, /* Pascal */
183 language_ada, /* Ada */
184 language_opencl, /* OpenCL */
185 language_minimal, /* All other languages, minimal support only */
186 nr_languages
187 };
188
189 enum precision_type
190 {
191 single_precision,
192 double_precision,
193 unspecified_precision
194 };
195
196 /* * A generic, not quite boolean, enumeration. This is used for
197 set/show commands in which the options are on/off/automatic. */
198 enum auto_boolean
199 {
200 AUTO_BOOLEAN_TRUE,
201 AUTO_BOOLEAN_FALSE,
202 AUTO_BOOLEAN_AUTO
203 };
204
205 /* * Potential ways that a function can return a value of a given
206 type. */
207
208 enum return_value_convention
209 {
210 /* * Where the return value has been squeezed into one or more
211 registers. */
212 RETURN_VALUE_REGISTER_CONVENTION,
213 /* * Commonly known as the "struct return convention". The caller
214 passes an additional hidden first parameter to the caller. That
215 parameter contains the address at which the value being returned
216 should be stored. While typically, and historically, used for
217 large structs, this is convention is applied to values of many
218 different types. */
219 RETURN_VALUE_STRUCT_CONVENTION,
220 /* * Like the "struct return convention" above, but where the ABI
221 guarantees that the called function stores the address at which
222 the value being returned is stored in a well-defined location,
223 such as a register or memory slot in the stack frame. Don't use
224 this if the ABI doesn't explicitly guarantees this. */
225 RETURN_VALUE_ABI_RETURNS_ADDRESS,
226 /* * Like the "struct return convention" above, but where the ABI
227 guarantees that the address at which the value being returned is
228 stored will be available in a well-defined location, such as a
229 register or memory slot in the stack frame. Don't use this if
230 the ABI doesn't explicitly guarantees this. */
231 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
232 };
233
234 /* Needed for various prototypes */
235
236 struct symtab;
237 struct breakpoint;
238 struct frame_info;
239 struct gdbarch;
240 struct value;
241
242 /* From main.c. */
243
244 /* This really belong in utils.c (path-utils.c?), but it references some
245 globals that are currently only available to main.c. */
246 extern char *relocate_gdb_directory (const char *initial, int flag);
247
248 \f
249 /* Annotation stuff. */
250
251 extern int annotation_level; /* in stack.c */
252 \f
253
254 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
255 "const char *" in unistd.h, so we can't declare the argument
256 as "char *". */
257
258 EXTERN_C char *re_comp (const char *);
259
260 /* From symfile.c */
261
262 extern void symbol_file_command (char *, int);
263
264 /* * Remote targets may wish to use this as their load function. */
265 extern void generic_load (const char *name, int from_tty);
266
267 /* * Report on STREAM the performance of memory transfer operation,
268 such as 'load'.
269 @param DATA_COUNT is the number of bytes transferred.
270 @param WRITE_COUNT is the number of separate write operations, or 0,
271 if that information is not available.
272 @param START_TIME is the time at which an operation was started.
273 @param END_TIME is the time at which an operation ended. */
274 struct timeval;
275 extern void print_transfer_performance (struct ui_file *stream,
276 unsigned long data_count,
277 unsigned long write_count,
278 const struct timeval *start_time,
279 const struct timeval *end_time);
280
281 /* From top.c */
282
283 typedef void initialize_file_ftype (void);
284
285 extern char *gdb_readline (const char *);
286
287 extern char *gdb_readline_wrapper (const char *);
288
289 extern char *command_line_input (const char *, int, char *);
290
291 extern void print_prompt (void);
292
293 extern int input_from_terminal_p (void);
294
295 extern int info_verbose;
296
297 /* From printcmd.c */
298
299 extern void set_next_address (struct gdbarch *, CORE_ADDR);
300
301 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
302 struct ui_file *, int, char *);
303
304 extern int build_address_symbolic (struct gdbarch *,
305 CORE_ADDR addr,
306 int do_demangle,
307 char **name,
308 int *offset,
309 char **filename,
310 int *line,
311 int *unmapped);
312
313 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
314 extern const char *pc_prefix (CORE_ADDR);
315
316 /* From source.c */
317
318 /* See openp function definition for their description. */
319 #define OPF_TRY_CWD_FIRST 0x01
320 #define OPF_SEARCH_IN_PATH 0x02
321 #define OPF_RETURN_REALPATH 0x04
322
323 extern int openp (const char *, int, const char *, int, char **);
324
325 extern int source_full_path_of (const char *, char **);
326
327 extern void mod_path (char *, char **);
328
329 extern void add_path (char *, char **, int);
330
331 extern void directory_switch (char *, int);
332
333 extern char *source_path;
334
335 extern void init_source_path (void);
336
337 /* From exec.c */
338
339 /* * Process memory area starting at ADDR with length SIZE. Area is
340 readable iff READ is non-zero, writable if WRITE is non-zero,
341 executable if EXEC is non-zero. Area is possibly changed against
342 its original file based copy if MODIFIED is non-zero. DATA is
343 passed without changes from a caller. */
344
345 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
346 int read, int write, int exec,
347 int modified, void *data);
348
349 /* * Possible lvalue types. Like enum language, this should be in
350 value.h, but needs to be here for the same reason. */
351
352 enum lval_type
353 {
354 /* * Not an lval. */
355 not_lval,
356 /* * In memory. */
357 lval_memory,
358 /* * In a register. Registers are relative to a frame. */
359 lval_register,
360 /* * In a gdb internal variable. */
361 lval_internalvar,
362 /* * Value encapsulates a callable defined in an extension language. */
363 lval_xcallable,
364 /* * Part of a gdb internal variable (structure field). */
365 lval_internalvar_component,
366 /* * Value's bits are fetched and stored using functions provided
367 by its creator. */
368 lval_computed
369 };
370
371 /* * Control types for commands. */
372
373 enum misc_command_type
374 {
375 ok_command,
376 end_command,
377 else_command,
378 nop_command
379 };
380
381 enum command_control_type
382 {
383 simple_control,
384 break_control,
385 continue_control,
386 while_control,
387 if_control,
388 commands_control,
389 python_control,
390 compile_control,
391 guile_control,
392 while_stepping_control,
393 invalid_control
394 };
395
396 /* * Structure for saved commands lines (for breakpoints, defined
397 commands, etc). */
398
399 struct command_line
400 {
401 struct command_line *next;
402 char *line;
403 enum command_control_type control_type;
404 union
405 {
406 struct
407 {
408 enum compile_i_scope_types scope;
409 void *scope_data;
410 }
411 compile;
412 }
413 control_u;
414 /* * The number of elements in body_list. */
415 int body_count;
416 /* * For composite commands, the nested lists of commands. For
417 example, for "if" command this will contain the then branch and
418 the else branch, if that is available. */
419 struct command_line **body_list;
420 };
421
422 extern struct command_line *read_command_lines (char *, int, int,
423 void (*)(char *, void *),
424 void *);
425 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
426 void (*)(char *, void *),
427 void *);
428
429 extern void free_command_lines (struct command_line **);
430
431 /* * Parameters of the "info proc" command. */
432
433 enum info_proc_what
434 {
435 /* * Display the default cmdline, cwd and exe outputs. */
436 IP_MINIMAL,
437
438 /* * Display `info proc mappings'. */
439 IP_MAPPINGS,
440
441 /* * Display `info proc status'. */
442 IP_STATUS,
443
444 /* * Display `info proc stat'. */
445 IP_STAT,
446
447 /* * Display `info proc cmdline'. */
448 IP_CMDLINE,
449
450 /* * Display `info proc exe'. */
451 IP_EXE,
452
453 /* * Display `info proc cwd'. */
454 IP_CWD,
455
456 /* * Display all of the above. */
457 IP_ALL
458 };
459
460 /* * String containing the current directory (what getwd would return). */
461
462 extern char *current_directory;
463
464 /* * Default radixes for input and output. Only some values supported. */
465 extern unsigned input_radix;
466 extern unsigned output_radix;
467
468 /* * Possibilities for prettyformat parameters to routines which print
469 things. Like enum language, this should be in value.h, but needs
470 to be here for the same reason. FIXME: If we can eliminate this
471 as an arg to LA_VAL_PRINT, then we can probably move it back to
472 value.h. */
473
474 enum val_prettyformat
475 {
476 Val_no_prettyformat = 0,
477 Val_prettyformat,
478 /* * Use the default setting which the user has specified. */
479 Val_prettyformat_default
480 };
481
482 /* * Optional native machine support. Non-native (and possibly pure
483 multi-arch) targets do not need a "nm.h" file. This will be a
484 symlink to one of the nm-*.h files, built by the `configure'
485 script. */
486
487 #ifdef GDB_NM_FILE
488 #include "nm.h"
489 #endif
490
491 /* Assume that fopen accepts the letter "b" in the mode string.
492 It is demanded by ISO C9X, and should be supported on all
493 platforms that claim to have a standard-conforming C library. On
494 true POSIX systems it will be ignored and have no effect. There
495 may still be systems without a standard-conforming C library where
496 an ISO C9X compiler (GCC) is available. Known examples are SunOS
497 4.x and 4.3BSD. This assumption means these systems are no longer
498 supported. */
499 #ifndef FOPEN_RB
500 # include "fopen-bin.h"
501 #endif
502
503 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
504 FIXME: Assumes 2's complement arithmetic. */
505
506 #if !defined (UINT_MAX)
507 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
508 #endif
509
510 #if !defined (INT_MAX)
511 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
512 #endif
513
514 #if !defined (INT_MIN)
515 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
516 #endif
517
518 #if !defined (ULONG_MAX)
519 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
520 #endif
521
522 #if !defined (LONG_MAX)
523 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
524 #endif
525
526 #if !defined (ULONGEST_MAX)
527 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
528 #endif
529
530 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
531 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
532 #endif
533
534 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
535 arguments to a function, number in a value history, register number, etc.)
536 where the value must not be larger than can fit in an int. */
537
538 extern int longest_to_int (LONGEST);
539
540 /* * List of known OS ABIs. If you change this, make sure to update the
541 table in osabi.c. */
542 enum gdb_osabi
543 {
544 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
545
546 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
547
548 GDB_OSABI_SVR4,
549 GDB_OSABI_HURD,
550 GDB_OSABI_SOLARIS,
551 GDB_OSABI_LINUX,
552 GDB_OSABI_FREEBSD_AOUT,
553 GDB_OSABI_FREEBSD_ELF,
554 GDB_OSABI_NETBSD_AOUT,
555 GDB_OSABI_NETBSD_ELF,
556 GDB_OSABI_OPENBSD_ELF,
557 GDB_OSABI_WINCE,
558 GDB_OSABI_GO32,
559 GDB_OSABI_IRIX,
560 GDB_OSABI_HPUX_ELF,
561 GDB_OSABI_HPUX_SOM,
562 GDB_OSABI_QNXNTO,
563 GDB_OSABI_CYGWIN,
564 GDB_OSABI_AIX,
565 GDB_OSABI_DICOS,
566 GDB_OSABI_DARWIN,
567 GDB_OSABI_SYMBIAN,
568 GDB_OSABI_OPENVMS,
569 GDB_OSABI_LYNXOS178,
570 GDB_OSABI_NEWLIB,
571 GDB_OSABI_SDE,
572
573 GDB_OSABI_INVALID /* keep this last */
574 };
575
576 /* Global functions from other, non-gdb GNU thingies.
577 Libiberty thingies are no longer declared here. We include libiberty.h
578 above, instead. */
579
580 /* From other system libraries */
581
582 #ifndef atof
583 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
584 #endif
585
586 /* Dynamic target-system-dependent parameters for GDB. */
587 #include "gdbarch.h"
588
589 /* * Maximum size of a register. Something small, but large enough for
590 all known ISAs. If it turns out to be too small, make it bigger. */
591
592 enum { MAX_REGISTER_SIZE = 64 };
593
594 /* In findvar.c. */
595
596 extern LONGEST extract_signed_integer (const gdb_byte *, int,
597 enum bfd_endian);
598
599 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
600 enum bfd_endian);
601
602 extern int extract_long_unsigned_integer (const gdb_byte *, int,
603 enum bfd_endian, LONGEST *);
604
605 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
606 struct type *type);
607
608 extern void store_signed_integer (gdb_byte *, int,
609 enum bfd_endian, LONGEST);
610
611 extern void store_unsigned_integer (gdb_byte *, int,
612 enum bfd_endian, ULONGEST);
613
614 extern void store_typed_address (gdb_byte *buf, struct type *type,
615 CORE_ADDR addr);
616
617 \f
618 /* From valops.c */
619
620 extern int watchdog;
621
622 /* Hooks for alternate command interfaces. */
623
624 /* * The name of the interpreter if specified on the command line. */
625 extern char *interpreter_p;
626
627 struct target_waitstatus;
628 struct cmd_list_element;
629
630 extern void (*deprecated_pre_add_symbol_hook) (const char *);
631 extern void (*deprecated_post_add_symbol_hook) (void);
632 extern void (*selected_frame_level_changed_hook) (int);
633 extern int (*deprecated_ui_loop_hook) (int signo);
634 extern void (*deprecated_show_load_progress) (const char *section,
635 unsigned long section_sent,
636 unsigned long section_size,
637 unsigned long total_sent,
638 unsigned long total_size);
639 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
640 int line,
641 int stopline,
642 int noerror);
643 extern int (*deprecated_query_hook) (const char *, va_list)
644 ATTRIBUTE_FPTR_PRINTF(1,0);
645 extern void (*deprecated_warning_hook) (const char *, va_list)
646 ATTRIBUTE_FPTR_PRINTF(1,0);
647 extern void (*deprecated_interactive_hook) (void);
648 extern void (*deprecated_readline_begin_hook) (char *, ...)
649 ATTRIBUTE_FPTR_PRINTF_1;
650 extern char *(*deprecated_readline_hook) (const char *);
651 extern void (*deprecated_readline_end_hook) (void);
652 extern void (*deprecated_context_hook) (int);
653 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
654 struct target_waitstatus *status,
655 int options);
656
657 extern void (*deprecated_attach_hook) (void);
658 extern void (*deprecated_detach_hook) (void);
659 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
660 char *cmd, int from_tty);
661
662 extern int (*deprecated_ui_load_progress_hook) (const char *section,
663 unsigned long num);
664
665 /* If this definition isn't overridden by the header files, assume
666 that isatty and fileno exist on this system. */
667 #ifndef ISATTY
668 #define ISATTY(FP) (isatty (fileno (FP)))
669 #endif
670
671 /* * A width that can achieve a better legibility for GDB MI mode. */
672 #define GDB_MI_MSG_WIDTH 80
673
674 /* From progspace.c */
675
676 extern void initialize_progspace (void);
677 extern void initialize_inferiors (void);
678
679 /* * Special block numbers */
680
681 enum block_enum
682 {
683 GLOBAL_BLOCK = 0,
684 STATIC_BLOCK = 1,
685 FIRST_LOCAL_BLOCK = 2
686 };
687
688 #include "utils.h"
689
690 #endif /* #ifndef DEFS_H */
This page took 0.0439889999999999 seconds and 4 git commands to generate.