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