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