Eliminate clear_quit_flag
[external/binutils.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-2016 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    In addition to setting a flag, the SIGINT handler also marks a
135    select/poll-able file descriptor as read-ready.  That is used by
136    interruptible_select in order to support interrupting blocking I/O
137    in a race-free manner.
138
139    These functions use the extension_language_ops API to allow extension
140    language(s) and GDB SIGINT handling to coexist seamlessly.  */
141
142 /* * Evaluate to non-zero if the quit flag is set, zero otherwise.  This
143    will clear the quit flag as a side effect.  */
144 extern int check_quit_flag (void);
145 /* * Set the quit flag.  */
146 extern void set_quit_flag (void);
147
148 /* Flag that function quit should call quit_force.  */
149 extern volatile int sync_quit_force_run;
150
151 extern int immediate_quit;
152
153 extern void quit (void);
154
155 /* Helper for the QUIT macro.  */
156
157 extern void maybe_quit (void);
158
159 /* Check whether a Ctrl-C was typed, and if so, call quit.  The target
160    is given a chance to process the Ctrl-C.  E.g., it may detect that
161    repeated Ctrl-C requests were issued, and choose to close the
162    connection.  */
163 #define QUIT maybe_quit ()
164
165 /* Set the serial event associated with the quit flag.  */
166 extern void quit_serial_event_set (void);
167
168 /* Clear the serial event associated with the quit flag.  */
169 extern void quit_serial_event_clear (void);
170
171 /* * Languages represented in the symbol table and elsewhere.
172    This should probably be in language.h, but since enum's can't
173    be forward declared to satisfy opaque references before their
174    actual definition, needs to be here.  */
175
176 enum language
177   {
178     language_unknown,           /* Language not known */
179     language_auto,              /* Placeholder for automatic setting */
180     language_c,                 /* C */
181     language_cplus,             /* C++ */
182     language_d,                 /* D */
183     language_go,                /* Go */
184     language_objc,              /* Objective-C */
185     language_java,              /* Java */
186     language_fortran,           /* Fortran */
187     language_m2,                /* Modula-2 */
188     language_asm,               /* Assembly language */
189     language_pascal,            /* Pascal */
190     language_ada,               /* Ada */
191     language_opencl,            /* OpenCL */
192     language_minimal,           /* All other languages, minimal support only */
193     nr_languages
194   };
195
196 /* The number of bits needed to represent all languages, with enough
197    padding to allow for reasonable growth.  */
198 #define LANGUAGE_BITS 5
199 gdb_static_assert (nr_languages <= (1 << LANGUAGE_BITS));
200
201 enum precision_type
202   {
203     single_precision,
204     double_precision,
205     unspecified_precision
206   };
207
208 /* * A generic, not quite boolean, enumeration.  This is used for
209    set/show commands in which the options are on/off/automatic.  */
210 enum auto_boolean
211 {
212   AUTO_BOOLEAN_TRUE,
213   AUTO_BOOLEAN_FALSE,
214   AUTO_BOOLEAN_AUTO
215 };
216
217 /* * Potential ways that a function can return a value of a given
218    type.  */
219
220 enum return_value_convention
221 {
222   /* * Where the return value has been squeezed into one or more
223      registers.  */
224   RETURN_VALUE_REGISTER_CONVENTION,
225   /* * Commonly known as the "struct return convention".  The caller
226      passes an additional hidden first parameter to the caller.  That
227      parameter contains the address at which the value being returned
228      should be stored.  While typically, and historically, used for
229      large structs, this is convention is applied to values of many
230      different types.  */
231   RETURN_VALUE_STRUCT_CONVENTION,
232   /* * Like the "struct return convention" above, but where the ABI
233      guarantees that the called function stores the address at which
234      the value being returned is stored in a well-defined location,
235      such as a register or memory slot in the stack frame.  Don't use
236      this if the ABI doesn't explicitly guarantees this.  */
237   RETURN_VALUE_ABI_RETURNS_ADDRESS,
238   /* * Like the "struct return convention" above, but where the ABI
239      guarantees that the address at which the value being returned is
240      stored will be available in a well-defined location, such as a
241      register or memory slot in the stack frame.  Don't use this if
242      the ABI doesn't explicitly guarantees this.  */
243   RETURN_VALUE_ABI_PRESERVES_ADDRESS,
244 };
245
246 /* Needed for various prototypes */
247
248 struct symtab;
249 struct breakpoint;
250 struct frame_info;
251 struct gdbarch;
252 struct value;
253
254 /* From main.c.  */
255
256 /* This really belong in utils.c (path-utils.c?), but it references some
257    globals that are currently only available to main.c.  */
258 extern char *relocate_gdb_directory (const char *initial, int flag);
259
260 \f
261 /* Annotation stuff.  */
262
263 extern int annotation_level;    /* in stack.c */
264 \f
265
266 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
267    "const char *" in unistd.h, so we can't declare the argument
268    as "char *".  */
269
270 EXTERN_C char *re_comp (const char *);
271
272 /* From symfile.c */
273
274 extern void symbol_file_command (char *, int);
275
276 /* * Remote targets may wish to use this as their load function.  */
277 extern void generic_load (const char *name, int from_tty);
278
279 /* * Report on STREAM the performance of memory transfer operation,
280    such as 'load'.
281    @param DATA_COUNT is the number of bytes transferred.
282    @param WRITE_COUNT is the number of separate write operations, or 0,
283    if that information is not available.
284    @param START_TIME is the time at which an operation was started.
285    @param END_TIME is the time at which an operation ended.  */
286 struct timeval;
287 extern void print_transfer_performance (struct ui_file *stream,
288                                         unsigned long data_count,
289                                         unsigned long write_count,
290                                         const struct timeval *start_time,
291                                         const struct timeval *end_time);
292
293 /* From top.c */
294
295 typedef void initialize_file_ftype (void);
296
297 extern char *gdb_readline_wrapper (const char *);
298
299 extern char *command_line_input (const char *, int, char *);
300
301 extern void print_prompt (void);
302
303 extern int input_from_terminal_p (void);
304
305 extern int info_verbose;
306
307 /* From printcmd.c */
308
309 extern void set_next_address (struct gdbarch *, CORE_ADDR);
310
311 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
312                                    struct ui_file *, int, char *);
313
314 extern int build_address_symbolic (struct gdbarch *,
315                                    CORE_ADDR addr,
316                                    int do_demangle, 
317                                    char **name, 
318                                    int *offset, 
319                                    char **filename, 
320                                    int *line,   
321                                    int *unmapped);
322
323 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
324 extern const char *pc_prefix (CORE_ADDR);
325
326 /* From source.c */
327
328 /* See openp function definition for their description.  */
329 #define OPF_TRY_CWD_FIRST     0x01
330 #define OPF_SEARCH_IN_PATH    0x02
331 #define OPF_RETURN_REALPATH   0x04
332
333 extern int openp (const char *, int, const char *, int, char **);
334
335 extern int source_full_path_of (const char *, char **);
336
337 extern void mod_path (char *, char **);
338
339 extern void add_path (char *, char **, int);
340
341 extern void directory_switch (char *, int);
342
343 extern char *source_path;
344
345 extern void init_source_path (void);
346
347 /* From exec.c */
348
349 /* * Process memory area starting at ADDR with length SIZE.  Area is
350    readable iff READ is non-zero, writable if WRITE is non-zero,
351    executable if EXEC is non-zero.  Area is possibly changed against
352    its original file based copy if MODIFIED is non-zero.  DATA is
353    passed without changes from a caller.  */
354
355 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
356                                          int read, int write, int exec,
357                                          int modified, void *data);
358
359 /* * Possible lvalue types.  Like enum language, this should be in
360    value.h, but needs to be here for the same reason.  */
361
362 enum lval_type
363   {
364     /* * Not an lval.  */
365     not_lval,
366     /* * In memory.  */
367     lval_memory,
368     /* * In a register.  Registers are relative to a frame.  */
369     lval_register,
370     /* * In a gdb internal variable.  */
371     lval_internalvar,
372     /* * Value encapsulates a callable defined in an extension language.  */
373     lval_xcallable,
374     /* * Part of a gdb internal variable (structure field).  */
375     lval_internalvar_component,
376     /* * Value's bits are fetched and stored using functions provided
377        by its creator.  */
378     lval_computed
379   };
380
381 /* * Control types for commands.  */
382
383 enum misc_command_type
384   {
385     ok_command,
386     end_command,
387     else_command,
388     nop_command
389   };
390
391 enum command_control_type
392   {
393     simple_control,
394     break_control,
395     continue_control,
396     while_control,
397     if_control,
398     commands_control,
399     python_control,
400     compile_control,
401     guile_control,
402     while_stepping_control,
403     invalid_control
404   };
405
406 /* * Structure for saved commands lines (for breakpoints, defined
407    commands, etc).  */
408
409 struct command_line
410   {
411     struct command_line *next;
412     char *line;
413     enum command_control_type control_type;
414     union
415       {
416         struct
417           {
418             enum compile_i_scope_types scope;
419             void *scope_data;
420           }
421         compile;
422       }
423     control_u;
424     /* * The number of elements in body_list.  */
425     int body_count;
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;
430   };
431
432 extern struct command_line *read_command_lines (char *, int, int,
433                                                 void (*)(char *, void *),
434                                                 void *);
435 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
436                                                   void (*)(char *, void *),
437                                                   void *);
438
439 extern void free_command_lines (struct command_line **);
440
441 /* * Parameters of the "info proc" command.  */
442
443 enum info_proc_what
444   {
445     /* * Display the default cmdline, cwd and exe outputs.  */
446     IP_MINIMAL,
447
448     /* * Display `info proc mappings'.  */
449     IP_MAPPINGS,
450
451     /* * Display `info proc status'.  */
452     IP_STATUS,
453
454     /* * Display `info proc stat'.  */
455     IP_STAT,
456
457     /* * Display `info proc cmdline'.  */
458     IP_CMDLINE,
459
460     /* * Display `info proc exe'.  */
461     IP_EXE,
462
463     /* * Display `info proc cwd'.  */
464     IP_CWD,
465
466     /* * Display all of the above.  */
467     IP_ALL
468   };
469
470 /* * String containing the current directory (what getwd would return).  */
471
472 extern char *current_directory;
473
474 /* * Default radixes for input and output.  Only some values supported.  */
475 extern unsigned input_radix;
476 extern unsigned output_radix;
477
478 /* * Possibilities for prettyformat 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
482    value.h.  */
483
484 enum val_prettyformat
485   {
486     Val_no_prettyformat = 0,
487     Val_prettyformat,
488     /* * Use the default setting which the user has specified.  */
489     Val_prettyformat_default
490   };
491
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'
495    script.  */
496
497 #ifdef GDB_NM_FILE
498 #include "nm.h"
499 #endif
500
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
508    supported.  */
509 #ifndef FOPEN_RB
510 # include "fopen-bin.h"
511 #endif
512
513 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
514    FIXME: Assumes 2's complement arithmetic.  */
515
516 #if !defined (UINT_MAX)
517 #define UINT_MAX ((unsigned int)(~0))       /* 0xFFFFFFFF for 32-bits */
518 #endif
519
520 #if !defined (INT_MAX)
521 #define INT_MAX ((int)(UINT_MAX >> 1))      /* 0x7FFFFFFF for 32-bits */
522 #endif
523
524 #if !defined (INT_MIN)
525 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
526 #endif
527
528 #if !defined (ULONG_MAX)
529 #define ULONG_MAX ((unsigned long)(~0L))    /* 0xFFFFFFFF for 32-bits */
530 #endif
531
532 #if !defined (LONG_MAX)
533 #define LONG_MAX ((long)(ULONG_MAX >> 1))   /* 0x7FFFFFFF for 32-bits */
534 #endif
535
536 #if !defined (ULONGEST_MAX)
537 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
538 #endif
539
540 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
541 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
542 #endif
543
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.  */
547
548 extern int longest_to_int (LONGEST);
549
550 /* * List of known OS ABIs.  If you change this, make sure to update the
551    table in osabi.c.  */
552 enum gdb_osabi
553 {
554   GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info.  */
555
556   GDB_OSABI_UNKNOWN = 0,        /* keep this zero */
557
558   GDB_OSABI_SVR4,
559   GDB_OSABI_HURD,
560   GDB_OSABI_SOLARIS,
561   GDB_OSABI_LINUX,
562   GDB_OSABI_FREEBSD_AOUT,
563   GDB_OSABI_FREEBSD_ELF,
564   GDB_OSABI_NETBSD_AOUT,
565   GDB_OSABI_NETBSD_ELF,
566   GDB_OSABI_OPENBSD_ELF,
567   GDB_OSABI_WINCE,
568   GDB_OSABI_GO32,
569   GDB_OSABI_IRIX,
570   GDB_OSABI_HPUX_ELF,
571   GDB_OSABI_HPUX_SOM,
572   GDB_OSABI_QNXNTO,
573   GDB_OSABI_CYGWIN,
574   GDB_OSABI_AIX,
575   GDB_OSABI_DICOS,
576   GDB_OSABI_DARWIN,
577   GDB_OSABI_SYMBIAN,
578   GDB_OSABI_OPENVMS,
579   GDB_OSABI_LYNXOS178,
580   GDB_OSABI_NEWLIB,
581   GDB_OSABI_SDE,
582
583   GDB_OSABI_INVALID             /* keep this last */
584 };
585
586 /* Global functions from other, non-gdb GNU thingies.
587    Libiberty thingies are no longer declared here.  We include libiberty.h
588    above, instead.  */
589
590 /* From other system libraries */
591
592 #ifndef atof
593 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
594 #endif
595
596 /* Dynamic target-system-dependent parameters for GDB.  */
597 #include "gdbarch.h"
598
599 /* * Maximum size of a register.  Something small, but large enough for
600    all known ISAs.  If it turns out to be too small, make it bigger.  */
601
602 enum { MAX_REGISTER_SIZE = 64 };
603
604 /* In findvar.c.  */
605
606 extern LONGEST extract_signed_integer (const gdb_byte *, int,
607                                        enum bfd_endian);
608
609 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
610                                           enum bfd_endian);
611
612 extern int extract_long_unsigned_integer (const gdb_byte *, int,
613                                           enum bfd_endian, LONGEST *);
614
615 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
616                                         struct type *type);
617
618 extern void store_signed_integer (gdb_byte *, int,
619                                   enum bfd_endian, LONGEST);
620
621 extern void store_unsigned_integer (gdb_byte *, int,
622                                     enum bfd_endian, ULONGEST);
623
624 extern void store_typed_address (gdb_byte *buf, struct type *type,
625                                  CORE_ADDR addr);
626
627 \f
628 /* From valops.c */
629
630 extern int watchdog;
631
632 /* Hooks for alternate command interfaces.  */
633
634 /* * The name of the interpreter if specified on the command line.  */
635 extern char *interpreter_p;
636
637 struct target_waitstatus;
638 struct cmd_list_element;
639
640 extern void (*deprecated_pre_add_symbol_hook) (const char *);
641 extern void (*deprecated_post_add_symbol_hook) (void);
642 extern void (*selected_frame_level_changed_hook) (int);
643 extern int (*deprecated_ui_loop_hook) (int signo);
644 extern void (*deprecated_show_load_progress) (const char *section,
645                                               unsigned long section_sent, 
646                                               unsigned long section_size, 
647                                               unsigned long total_sent, 
648                                               unsigned long total_size);
649 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
650                                                          int line,
651                                                          int stopline,
652                                                          int noerror);
653 extern int (*deprecated_query_hook) (const char *, va_list)
654      ATTRIBUTE_FPTR_PRINTF(1,0);
655 extern void (*deprecated_warning_hook) (const char *, va_list)
656      ATTRIBUTE_FPTR_PRINTF(1,0);
657 extern void (*deprecated_interactive_hook) (void);
658 extern void (*deprecated_readline_begin_hook) (char *, ...)
659      ATTRIBUTE_FPTR_PRINTF_1;
660 extern char *(*deprecated_readline_hook) (const char *);
661 extern void (*deprecated_readline_end_hook) (void);
662 extern void (*deprecated_context_hook) (int);
663 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
664                                               struct target_waitstatus *status,
665                                               int options);
666
667 extern void (*deprecated_attach_hook) (void);
668 extern void (*deprecated_detach_hook) (void);
669 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
670                                              char *cmd, int from_tty);
671
672 extern int (*deprecated_ui_load_progress_hook) (const char *section,
673                                                 unsigned long num);
674
675 /* If this definition isn't overridden by the header files, assume
676    that isatty and fileno exist on this system.  */
677 #ifndef ISATTY
678 #define ISATTY(FP)      (isatty (fileno (FP)))
679 #endif
680
681 /* * A width that can achieve a better legibility for GDB MI mode.  */
682 #define GDB_MI_MSG_WIDTH  80
683
684 /* From progspace.c */
685
686 extern void initialize_progspace (void);
687 extern void initialize_inferiors (void);
688
689 /* * Special block numbers */
690
691 enum block_enum
692 {
693   GLOBAL_BLOCK = 0,
694   STATIC_BLOCK = 1,
695   FIRST_LOCAL_BLOCK = 2
696 };
697
698 #include "utils.h"
699
700 #endif /* #ifndef DEFS_H */