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