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