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