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