94674dc3418954b1e2f3b1070ebcfc904ed92706
[deliverable/binutils-gdb.git] / gdb / defs.h
1 /* *INDENT-OFF* */ /* ATTR_FORMAT confuses indent, avoid running it for now */
2 /* Basic, host-specific, and target-specific definitions for GDB.
3 Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009
5 Free Software Foundation, Inc.
6
7 This file is part of GDB.
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21
22 #ifndef DEFS_H
23 #define DEFS_H
24
25 #include "config.h" /* Generated by configure. */
26
27 #include <sys/types.h>
28 #include <stdio.h>
29 #include <errno.h> /* System call error return status. */
30 #include <limits.h>
31 #include <stdint.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 #ifdef HAVE_STDDEF_H
48 #include <stddef.h>
49 #endif
50
51 #ifdef HAVE_UNISTD_H
52 #include <unistd.h>
53 #endif
54
55 #include <fcntl.h>
56
57 /* First include ansidecl.h so we can use the various macro definitions
58 here and in all subsequent file inclusions. */
59
60 #include "ansidecl.h"
61
62 #include "gdb_locale.h"
63
64 #include "gdb_wchar.h"
65
66 /* For ``enum target_signal''. */
67 #include "gdb/signals.h"
68
69 /* Just in case they're not defined in stdio.h. */
70
71 #ifndef SEEK_SET
72 #define SEEK_SET 0
73 #endif
74 #ifndef SEEK_CUR
75 #define SEEK_CUR 1
76 #endif
77
78 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
79 It is used as an access modifier in calls to open(), where it acts
80 similarly to the "b" character in fopen()'s MODE argument. On Posix
81 platforms it should be a no-op, so it is defined as 0 here. This
82 ensures that the symbol may be used freely elsewhere in gdb. */
83
84 #ifndef O_BINARY
85 #define O_BINARY 0
86 #endif
87
88 #include <stdarg.h> /* For va_list. */
89
90 #include "libiberty.h"
91
92 /* Rather than duplicate all the logic in BFD for figuring out what
93 types to use (which can be pretty complicated), symply define them
94 in terms of the corresponding type from BFD. */
95
96 #include "bfd.h"
97
98 /* A byte from the program being debugged. */
99 typedef bfd_byte gdb_byte;
100
101 /* An address in the program being debugged. Host byte order. */
102 typedef bfd_vma CORE_ADDR;
103
104 /* The largest CORE_ADDR value. */
105 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
106
107 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
108
109 #ifndef LONGEST
110
111 #ifdef BFD64
112
113 #define LONGEST BFD_HOST_64_BIT
114 #define ULONGEST BFD_HOST_U_64_BIT
115
116 #else /* No BFD64 */
117
118 #ifdef CC_HAS_LONG_LONG
119 #define LONGEST long long
120 #define ULONGEST unsigned long long
121 #else
122 #ifdef BFD_HOST_64_BIT
123 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
124 (e.g. i386-windows) so try it. */
125 #define LONGEST BFD_HOST_64_BIT
126 #define ULONGEST BFD_HOST_U_64_BIT
127 #else
128 #define LONGEST long
129 #define ULONGEST unsigned long
130 #endif
131 #endif
132
133 #endif /* No BFD64 */
134
135 #endif /* ! LONGEST */
136
137 #ifndef min
138 #define min(a, b) ((a) < (b) ? (a) : (b))
139 #endif
140 #ifndef max
141 #define max(a, b) ((a) > (b) ? (a) : (b))
142 #endif
143
144 /* Check if a character is one of the commonly used C++ marker characters. */
145 extern int is_cplus_marker (int);
146
147 /* enable xdb commands if set */
148 extern int xdb_commands;
149
150 /* enable dbx commands if set */
151 extern int dbx_commands;
152
153 /* System root path, used to find libraries etc. */
154 extern char *gdb_sysroot;
155
156 /* GDB datadir, used to store data files. */
157 extern char *gdb_datadir;
158
159 /* Search path for separate debug files. */
160 extern char *debug_file_directory;
161
162 extern int quit_flag;
163 extern int immediate_quit;
164 extern int sevenbit_strings;
165
166 extern void quit (void);
167
168 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
169 benefits of having a ``QUIT'' macro rather than a function are
170 marginal. If the overhead of a QUIT function call is proving
171 significant then its calling frequency should probably be reduced
172 [kingdon]. A profile analyzing the current situtation is
173 needed. */
174
175 #define QUIT { \
176 if (quit_flag) quit (); \
177 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
178 }
179
180 /* Languages represented in the symbol table and elsewhere.
181 This should probably be in language.h, but since enum's can't
182 be forward declared to satisfy opaque references before their
183 actual definition, needs to be here. */
184
185 enum language
186 {
187 language_unknown, /* Language not known */
188 language_auto, /* Placeholder for automatic setting */
189 language_c, /* C */
190 language_cplus, /* C++ */
191 language_objc, /* Objective-C */
192 language_java, /* Java */
193 language_fortran, /* Fortran */
194 language_m2, /* Modula-2 */
195 language_asm, /* Assembly language */
196 language_pascal, /* Pascal */
197 language_ada, /* Ada */
198 language_scm, /* Guile Scheme */
199 language_minimal, /* All other languages, minimal support only */
200 nr_languages
201 };
202
203 enum precision_type
204 {
205 single_precision,
206 double_precision,
207 unspecified_precision
208 };
209
210 /* A generic, not quite boolean, enumeration. */
211 enum auto_boolean
212 {
213 AUTO_BOOLEAN_TRUE,
214 AUTO_BOOLEAN_FALSE,
215 AUTO_BOOLEAN_AUTO
216 };
217
218 /* Potential ways that a function can return a value of a given type. */
219 enum return_value_convention
220 {
221 /* Where the return value has been squeezed into one or more
222 registers. */
223 RETURN_VALUE_REGISTER_CONVENTION,
224 /* Commonly known as the "struct return convention". The caller
225 passes an additional hidden first parameter to the caller. That
226 parameter contains the address at which the value being returned
227 should be stored. While typically, and historically, used for
228 large structs, this is convention is applied to values of many
229 different types. */
230 RETURN_VALUE_STRUCT_CONVENTION,
231 /* Like the "struct return convention" above, but where the ABI
232 guarantees that the called function stores the address at which
233 the value being returned is stored in a well-defined location,
234 such as a register or memory slot in the stack frame. Don't use
235 this if the ABI doesn't explicitly guarantees this. */
236 RETURN_VALUE_ABI_RETURNS_ADDRESS,
237 /* Like the "struct return convention" above, but where the ABI
238 guarantees that the address at which the value being returned is
239 stored will be available in a well-defined location, such as a
240 register or memory slot in the stack frame. Don't use this if
241 the ABI doesn't explicitly guarantees this. */
242 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
243 };
244
245 /* the cleanup list records things that have to be undone
246 if an error happens (descriptors to be closed, memory to be freed, etc.)
247 Each link in the chain records a function to call and an
248 argument to give it.
249
250 Use make_cleanup to add an element to the cleanup chain.
251 Use do_cleanups to do all cleanup actions back to a given
252 point in the chain. Use discard_cleanups to remove cleanups
253 from the chain back to a given point, not doing them.
254
255 If the argument is pointer to allocated memory, then you need to
256 to additionally set the 'free_arg' member to a function that will
257 free that memory. This function will be called both when the cleanup
258 is executed and when it's discarded. */
259
260 struct cleanup
261 {
262 struct cleanup *next;
263 void (*function) (void *);
264 void (*free_arg) (void *);
265 void *arg;
266 };
267
268
269 /* The ability to declare that a function never returns is useful, but
270 not really required to compile GDB successfully, so the NORETURN and
271 ATTR_NORETURN macros normally expand into nothing. */
272
273 /* If compiling with older versions of GCC, a function may be declared
274 "volatile" to indicate that it does not return. */
275
276 #ifndef NORETURN
277 #if defined(__GNUC__) \
278 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
279 #define NORETURN volatile
280 #else
281 #define NORETURN /* nothing */
282 #endif
283 #endif
284
285 /* GCC 2.5 and later versions define a function attribute "noreturn",
286 which is the preferred way to declare that a function never returns.
287 However GCC 2.7 appears to be the first version in which this fully
288 works everywhere we use it. */
289
290 #ifndef ATTR_NORETURN
291 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
292 #define ATTR_NORETURN __attribute__ ((noreturn))
293 #else
294 #define ATTR_NORETURN /* nothing */
295 #endif
296 #endif
297
298 #ifndef ATTR_FORMAT
299 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
300 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
301 #else
302 #define ATTR_FORMAT(type, x, y) /* nothing */
303 #endif
304 #endif
305
306 /* Be conservative and use enum bitfields only with GCC.
307 This is copied from gcc 3.3.1, system.h. */
308
309 #if defined(__GNUC__) && (__GNUC__ >= 2)
310 #define ENUM_BITFIELD(TYPE) enum TYPE
311 #else
312 #define ENUM_BITFIELD(TYPE) unsigned int
313 #endif
314
315 /* Needed for various prototypes */
316
317 struct symtab;
318 struct breakpoint;
319 struct frame_info;
320 struct gdbarch;
321
322 /* From utils.c */
323
324 extern void initialize_utils (void);
325
326 extern void notice_quit (void);
327
328 extern int strcmp_iw (const char *, const char *);
329
330 extern int strcmp_iw_ordered (const char *, const char *);
331
332 extern int streq (const char *, const char *);
333
334 extern int subset_compare (char *, char *);
335
336 extern char *safe_strerror (int);
337
338 #define ALL_CLEANUPS ((struct cleanup *)0)
339
340 extern void do_cleanups (struct cleanup *);
341 extern void do_final_cleanups (struct cleanup *);
342
343 extern void discard_cleanups (struct cleanup *);
344 extern void discard_final_cleanups (struct cleanup *);
345 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
346
347 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
348 make_cleanup function declarations below. Do not use this typedef
349 as a cast when passing functions into the make_cleanup() code.
350 Instead either use a bounce function or add a wrapper function.
351 Calling a f(char*) function with f(void*) is non-portable. */
352 typedef void (make_cleanup_ftype) (void *);
353
354 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
355
356 extern struct cleanup *make_cleanup_dtor (make_cleanup_ftype *, void *,
357 void (*dtor) (void *));
358
359 extern struct cleanup *make_cleanup_freeargv (char **);
360
361 struct ui_file;
362 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
363
364 struct section_addr_info;
365 extern struct cleanup *(make_cleanup_free_section_addr_info
366 (struct section_addr_info *));
367
368 extern struct cleanup *make_cleanup_close (int fd);
369
370 extern struct cleanup *make_cleanup_fclose (FILE *file);
371
372 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
373
374 struct obstack;
375 extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
376
377 extern struct cleanup *make_cleanup_restore_integer (int *variable);
378
379 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
380
381 extern struct cleanup *make_my_cleanup (struct cleanup **,
382 make_cleanup_ftype *, void *);
383
384 extern struct cleanup *make_my_cleanup2 (struct cleanup **,
385 make_cleanup_ftype *, void *,
386 void (*free_arg) (void *));
387
388 extern struct cleanup *save_cleanups (void);
389 extern struct cleanup *save_final_cleanups (void);
390 extern struct cleanup *save_my_cleanups (struct cleanup **);
391
392 extern void restore_cleanups (struct cleanup *);
393 extern void restore_final_cleanups (struct cleanup *);
394 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
395
396 extern void free_current_contents (void *);
397
398 extern void null_cleanup (void *);
399
400 extern int myread (int, char *, int);
401
402 extern int query (const char *, ...) ATTR_FORMAT (printf, 1, 2);
403 extern int nquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
404 extern int yquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
405
406 extern void init_page_info (void);
407
408 extern char *gdb_realpath (const char *);
409 extern char *xfullpath (const char *);
410
411 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
412 unsigned char *buf, size_t len);
413
414 ULONGEST strtoulst (const char *num, const char **trailer, int base);
415
416 char *ldirname (const char *filename);
417
418 char **gdb_buildargv (const char *);
419
420 /* From demangle.c */
421
422 extern void set_demangling_style (char *);
423
424 \f
425 /* Annotation stuff. */
426
427 extern int annotation_level; /* in stack.c */
428 \f
429 extern void begin_line (void);
430
431 extern void wrap_here (char *);
432
433 extern void reinitialize_more_filter (void);
434
435 /* Normal results */
436 extern struct ui_file *gdb_stdout;
437 /* Input stream */
438 extern struct ui_file *gdb_stdin;
439 /* Serious error notifications */
440 extern struct ui_file *gdb_stderr;
441 /* Log/debug/trace messages that should bypass normal stdout/stderr
442 filtering. For moment, always call this stream using
443 *_unfiltered. In the very near future that restriction shall be
444 removed - either call shall be unfiltered. (cagney 1999-06-13). */
445 extern struct ui_file *gdb_stdlog;
446 /* Target output that should bypass normal stdout/stderr filtering.
447 For moment, always call this stream using *_unfiltered. In the
448 very near future that restriction shall be removed - either call
449 shall be unfiltered. (cagney 1999-07-02). */
450 extern struct ui_file *gdb_stdtarg;
451 extern struct ui_file *gdb_stdtargerr;
452 extern struct ui_file *gdb_stdtargin;
453
454 #include "ui-file.h"
455
456 /* More generic printf like operations. Filtered versions may return
457 non-locally on error. */
458
459 extern void fputs_filtered (const char *, struct ui_file *);
460
461 extern void fputs_unfiltered (const char *, struct ui_file *);
462
463 extern int fputc_filtered (int c, struct ui_file *);
464
465 extern int fputc_unfiltered (int c, struct ui_file *);
466
467 extern int putchar_filtered (int c);
468
469 extern int putchar_unfiltered (int c);
470
471 extern void puts_filtered (const char *);
472
473 extern void puts_unfiltered (const char *);
474
475 extern void puts_filtered_tabular (char *string, int width, int right);
476
477 extern void puts_debug (char *prefix, char *string, char *suffix);
478
479 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
480
481 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
482
483 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
484
485 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
486
487 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
488
489 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
490
491 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
492
493 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
494
495 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
496
497 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
498
499 extern void print_spaces (int, struct ui_file *);
500
501 extern void print_spaces_filtered (int, struct ui_file *);
502
503 extern char *n_spaces (int);
504
505 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
506
507 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
508
509 extern void fputstrn_filtered (const char *str, int n, int quotr, struct ui_file * stream);
510
511 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
512
513 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
514 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
515
516 extern const char *host_address_to_string (const void *addr);
517
518 /* Convert CORE_ADDR to string in platform-specific manner.
519 This is usually formatted similar to 0x%lx. */
520 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
521
522 /* %d for LONGEST */
523 extern char *plongest (LONGEST l);
524 /* %u for ULONGEST */
525 extern char *pulongest (ULONGEST l);
526
527 extern char *phex (ULONGEST l, int sizeof_l);
528 extern char *phex_nz (ULONGEST l, int sizeof_l);
529 extern char *int_string (LONGEST, int, int, int, int);
530
531 /* Convert a CORE_ADDR into a HEX string with leading zeros.
532 The output from core_addr_to_string() can be passed direct to
533 string_to_core_addr(). */
534 extern const char *core_addr_to_string (const CORE_ADDR addr);
535 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
536 extern CORE_ADDR string_to_core_addr (const char *my_string);
537
538 /* Return a string that contains a number formatted as a hex
539 string. */
540 extern char *hex_string (LONGEST);
541 extern char *hex_string_custom (LONGEST, int);
542
543 extern void fprintf_symbol_filtered (struct ui_file *, char *,
544 enum language, int);
545
546 extern NORETURN void perror_with_name (const char *) ATTR_NORETURN;
547
548 extern void print_sys_errmsg (const char *, int);
549
550 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
551 "const char *" in unistd.h, so we can't declare the argument
552 as "char *". */
553
554 extern char *re_comp (const char *);
555
556 /* From symfile.c */
557
558 extern void symbol_file_command (char *, int);
559
560 /* Remote targets may wish to use this as their load function. */
561 extern void generic_load (char *name, int from_tty);
562
563 /* Report on STREAM the performance of memory transfer operation,
564 such as 'load'.
565 DATA_COUNT is the number of bytes transferred.
566 WRITE_COUNT is the number of separate write operations, or 0,
567 if that information is not available.
568 START_TIME is the time at which an operation was started.
569 END_TIME is the time at which an operation ended. */
570 struct timeval;
571 extern void print_transfer_performance (struct ui_file *stream,
572 unsigned long data_count,
573 unsigned long write_count,
574 const struct timeval *start_time,
575 const struct timeval *end_time);
576
577 /* From top.c */
578
579 typedef void initialize_file_ftype (void);
580
581 extern char *skip_quoted (char *);
582
583 extern char *gdb_readline (char *);
584
585 extern char *gdb_readline_wrapper (char *);
586
587 extern char *command_line_input (char *, int, char *);
588
589 extern void print_prompt (void);
590
591 extern int input_from_terminal_p (void);
592
593 extern int info_verbose;
594
595 /* From printcmd.c */
596
597 extern void set_next_address (struct gdbarch *, CORE_ADDR);
598
599 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
600 char *);
601
602 extern int build_address_symbolic (CORE_ADDR addr,
603 int do_demangle,
604 char **name,
605 int *offset,
606 char **filename,
607 int *line,
608 int *unmapped);
609
610 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
611
612 /* From source.c */
613
614 #define OPF_TRY_CWD_FIRST 0x01
615 #define OPF_SEARCH_IN_PATH 0x02
616
617 extern int openp (const char *, int, const char *, int, char **);
618
619 extern int source_full_path_of (const char *, char **);
620
621 extern void mod_path (char *, char **);
622
623 extern void add_path (char *, char **, int);
624
625 extern void directory_command (char *, int);
626
627 extern void directory_switch (char *, int);
628
629 extern char *source_path;
630
631 extern void init_source_path (void);
632
633 /* From exec.c */
634
635 /* Take over the 'find_mapped_memory' vector from exec.c. */
636 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,
637 unsigned long,
638 int, int, int,
639 void *),
640 void *));
641
642 /* Possible lvalue types. Like enum language, this should be in
643 value.h, but needs to be here for the same reason. */
644
645 enum lval_type
646 {
647 /* Not an lval. */
648 not_lval,
649 /* In memory. */
650 lval_memory,
651 /* In a register. Registers are relative to a frame. */
652 lval_register,
653 /* In a gdb internal variable. */
654 lval_internalvar,
655 /* Part of a gdb internal variable (structure field). */
656 lval_internalvar_component,
657 /* Value's bits are fetched and stored using functions provided by
658 its creator. */
659 lval_computed
660 };
661
662 /* Control types for commands */
663
664 enum misc_command_type
665 {
666 ok_command,
667 end_command,
668 else_command,
669 nop_command
670 };
671
672 enum command_control_type
673 {
674 simple_control,
675 break_control,
676 continue_control,
677 while_control,
678 if_control,
679 commands_control,
680 python_control,
681 invalid_control
682 };
683
684 /* Structure for saved commands lines
685 (for breakpoints, defined commands, etc). */
686
687 struct command_line
688 {
689 struct command_line *next;
690 char *line;
691 enum command_control_type control_type;
692 int body_count;
693 struct command_line **body_list;
694 };
695
696 extern struct command_line *read_command_lines (char *, int, int);
697 extern struct command_line *read_command_lines_1 (char * (*) (), int);
698
699 extern void free_command_lines (struct command_line **);
700
701 /* To continue the execution commands when running gdb asynchronously.
702 A continuation structure contains a pointer to a function to be called
703 to finish the command, once the target has stopped. Such mechanism is
704 used by the finish and until commands, and in the remote protocol
705 when opening an extended-remote connection. */
706
707 struct continuation;
708 struct thread_info;
709 struct inferior;
710
711 /* From utils.c */
712
713 /* Thread specific continuations. */
714
715 extern void add_continuation (struct thread_info *,
716 void (*)(void *), void *,
717 void (*)(void *));
718 extern void do_all_continuations (void);
719 extern void do_all_continuations_thread (struct thread_info *);
720 extern void discard_all_continuations (void);
721 extern void discard_all_continuations_thread (struct thread_info *);
722
723 extern void add_intermediate_continuation (struct thread_info *,
724 void (*)(void *), void *,
725 void (*)(void *));
726 extern void do_all_intermediate_continuations (void);
727 extern void do_all_intermediate_continuations_thread (struct thread_info *);
728 extern void discard_all_intermediate_continuations (void);
729 extern void discard_all_intermediate_continuations_thread (struct thread_info *);
730
731 /* Inferior specific (any thread) continuations. */
732
733 extern void add_inferior_continuation (void (*) (void *),
734 void *,
735 void (*) (void *));
736 extern void do_all_inferior_continuations (void);
737 extern void discard_all_inferior_continuations (struct inferior *inf);
738
739 /* String containing the current directory (what getwd would return). */
740
741 extern char *current_directory;
742
743 /* Default radixes for input and output. Only some values supported. */
744 extern unsigned input_radix;
745 extern unsigned output_radix;
746
747 /* Possibilities for prettyprint parameters to routines which print
748 things. Like enum language, this should be in value.h, but needs
749 to be here for the same reason. FIXME: If we can eliminate this
750 as an arg to LA_VAL_PRINT, then we can probably move it back to
751 value.h. */
752
753 enum val_prettyprint
754 {
755 Val_no_prettyprint = 0,
756 Val_prettyprint,
757 /* Use the default setting which the user has specified. */
758 Val_pretty_default
759 };
760
761 /* The ptid struct is a collection of the various "ids" necessary
762 for identifying the inferior. This consists of the process id
763 (pid), thread id (tid), and other fields necessary for uniquely
764 identifying the inferior process/thread being debugged. When
765 manipulating ptids, the constructors, accessors, and predicate
766 declared in inferior.h should be used. These are as follows:
767
768 ptid_build - Make a new ptid from a pid, lwp, and tid.
769 pid_to_ptid - Make a new ptid from just a pid.
770 ptid_get_pid - Fetch the pid component of a ptid.
771 ptid_get_lwp - Fetch the lwp component of a ptid.
772 ptid_get_tid - Fetch the tid component of a ptid.
773 ptid_equal - Test to see if two ptids are equal.
774 ptid_is_pid - Test to see if this ptid represents a process id.
775
776 Please do NOT access the struct ptid members directly (except, of
777 course, in the implementation of the above ptid manipulation
778 functions). */
779
780 struct ptid
781 {
782 /* Process id */
783 int pid;
784
785 /* Lightweight process id */
786 long lwp;
787
788 /* Thread id */
789 long tid;
790 };
791
792 typedef struct ptid ptid_t;
793
794 \f
795
796 /* Optional native machine support. Non-native (and possibly pure
797 multi-arch) targets do not need a "nm.h" file. This will be a
798 symlink to one of the nm-*.h files, built by the `configure'
799 script. */
800
801 #ifdef GDB_NM_FILE
802 #include "nm.h"
803 #endif
804
805 /* Assume that fopen accepts the letter "b" in the mode string.
806 It is demanded by ISO C9X, and should be supported on all
807 platforms that claim to have a standard-conforming C library. On
808 true POSIX systems it will be ignored and have no effect. There
809 may still be systems without a standard-conforming C library where
810 an ISO C9X compiler (GCC) is available. Known examples are SunOS
811 4.x and 4.3BSD. This assumption means these systems are no longer
812 supported. */
813 #ifndef FOPEN_RB
814 # include "fopen-bin.h"
815 #endif
816
817 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
818 FIXME: Assumes 2's complement arithmetic */
819
820 #if !defined (UINT_MAX)
821 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
822 #endif
823
824 #if !defined (INT_MAX)
825 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
826 #endif
827
828 #if !defined (INT_MIN)
829 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
830 #endif
831
832 #if !defined (ULONG_MAX)
833 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
834 #endif
835
836 #if !defined (LONG_MAX)
837 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
838 #endif
839
840 #if !defined (ULONGEST_MAX)
841 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
842 #endif
843
844 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
845 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
846 #endif
847
848 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
849 arguments to a function, number in a value history, register number, etc.)
850 where the value must not be larger than can fit in an int. */
851
852 extern int longest_to_int (LONGEST);
853
854 /* Assorted functions we can declare, now that const and volatile are
855 defined. */
856
857 extern char *savestring (const char *, size_t);
858
859 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
860 "libiberty.h". */
861 extern void xfree (void *);
862
863 /* Like xmalloc, but zero the memory. */
864 extern void *xzalloc (size_t);
865
866 /* Utility macros to allocate typed memory. Avoids errors like:
867 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
868 sizeof (struct foo), 0). */
869 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
870 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
871 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
872
873 /* Like asprintf/vasprintf but get an internal_error if the call
874 fails. */
875 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
876 extern void xvasprintf (char **ret, const char *format, va_list ap)
877 ATTR_FORMAT (printf, 2, 0);
878
879 /* Like asprintf and vasprintf, but return the string, throw an error
880 if no memory. */
881 extern char *xstrprintf (const char *format, ...) ATTR_FORMAT (printf, 1, 2);
882 extern char *xstrvprintf (const char *format, va_list ap)
883 ATTR_FORMAT (printf, 1, 0);
884
885 /* Like snprintf, but throw an error if the output buffer is too small. */
886 extern int xsnprintf (char *str, size_t size, const char *format, ...)
887 ATTR_FORMAT (printf, 3, 4);
888
889 extern int parse_escape (char **);
890
891 /* Message to be printed before the error message, when an error occurs. */
892
893 extern char *error_pre_print;
894
895 /* Message to be printed before the error message, when an error occurs. */
896
897 extern char *quit_pre_print;
898
899 /* Message to be printed before the warning message, when a warning occurs. */
900
901 extern char *warning_pre_print;
902
903 extern NORETURN void verror (const char *fmt, va_list ap)
904 ATTR_NORETURN ATTR_FORMAT (printf, 1, 0);
905
906 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
907
908 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
909
910 extern NORETURN void vfatal (const char *fmt, va_list ap)
911 ATTR_NORETURN ATTR_FORMAT (printf, 1, 0);
912
913 extern NORETURN void fatal (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
914
915 extern NORETURN void internal_verror (const char *file, int line,
916 const char *, va_list ap)
917 ATTR_NORETURN ATTR_FORMAT (printf, 3, 0);
918
919 extern NORETURN void internal_error (const char *file, int line,
920 const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
921
922 extern void internal_vwarning (const char *file, int line,
923 const char *, va_list ap)
924 ATTR_FORMAT (printf, 3, 0);
925
926 extern void internal_warning (const char *file, int line,
927 const char *, ...) ATTR_FORMAT (printf, 3, 4);
928
929 extern NORETURN void nomem (long) ATTR_NORETURN;
930
931 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
932
933 extern void vwarning (const char *, va_list args) ATTR_FORMAT (printf, 1, 0);
934
935 /* List of known OS ABIs. If you change this, make sure to update the
936 table in osabi.c. */
937 enum gdb_osabi
938 {
939 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
940
941 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
942
943 GDB_OSABI_SVR4,
944 GDB_OSABI_HURD,
945 GDB_OSABI_SOLARIS,
946 GDB_OSABI_OSF1,
947 GDB_OSABI_LINUX,
948 GDB_OSABI_FREEBSD_AOUT,
949 GDB_OSABI_FREEBSD_ELF,
950 GDB_OSABI_NETBSD_AOUT,
951 GDB_OSABI_NETBSD_ELF,
952 GDB_OSABI_OPENBSD_ELF,
953 GDB_OSABI_WINCE,
954 GDB_OSABI_GO32,
955 GDB_OSABI_IRIX,
956 GDB_OSABI_INTERIX,
957 GDB_OSABI_HPUX_ELF,
958 GDB_OSABI_HPUX_SOM,
959
960 GDB_OSABI_QNXNTO,
961
962 GDB_OSABI_CYGWIN,
963 GDB_OSABI_AIX,
964 GDB_OSABI_DICOS,
965 GDB_OSABI_DARWIN,
966
967 GDB_OSABI_INVALID /* keep this last */
968 };
969
970 /* Global functions from other, non-gdb GNU thingies.
971 Libiberty thingies are no longer declared here. We include libiberty.h
972 above, instead. */
973
974 /* From other system libraries */
975
976 #ifdef HAVE_STDDEF_H
977 #include <stddef.h>
978 #endif
979
980 #ifdef HAVE_STDLIB_H
981 #include <stdlib.h>
982 #endif
983 #ifndef min
984 #define min(a, b) ((a) < (b) ? (a) : (b))
985 #endif
986 #ifndef max
987 #define max(a, b) ((a) > (b) ? (a) : (b))
988 #endif
989
990
991 #ifndef atof
992 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
993 #endif
994
995 /* Various possibilities for alloca. */
996 #ifndef alloca
997 #ifdef __GNUC__
998 #define alloca __builtin_alloca
999 #else /* Not GNU C */
1000 #ifdef HAVE_ALLOCA_H
1001 #include <alloca.h>
1002 #else
1003 #ifdef _AIX
1004 #pragma alloca
1005 #else
1006
1007 /* We need to be careful not to declare this in a way which conflicts with
1008 bison. Bison never declares it as char *, but under various circumstances
1009 (like __hpux) we need to use void *. */
1010 extern void *alloca ();
1011 #endif /* Not _AIX */
1012 #endif /* Not HAVE_ALLOCA_H */
1013 #endif /* Not GNU C */
1014 #endif /* alloca not defined */
1015
1016 /* Dynamic target-system-dependent parameters for GDB. */
1017 #include "gdbarch.h"
1018
1019 /* Maximum size of a register. Something small, but large enough for
1020 all known ISAs. If it turns out to be too small, make it bigger. */
1021
1022 enum { MAX_REGISTER_SIZE = 16 };
1023
1024 /* Static target-system-dependent parameters for GDB. */
1025
1026 /* Number of bits in a char or unsigned char for the target machine.
1027 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1028 #if !defined (TARGET_CHAR_BIT)
1029 #define TARGET_CHAR_BIT 8
1030 #endif
1031
1032 /* If we picked up a copy of CHAR_BIT from a configuration file
1033 (which may get it by including <limits.h>) then use it to set
1034 the number of bits in a host char. If not, use the same size
1035 as the target. */
1036
1037 #if defined (CHAR_BIT)
1038 #define HOST_CHAR_BIT CHAR_BIT
1039 #else
1040 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1041 #endif
1042
1043 /* In findvar.c. */
1044
1045 extern LONGEST extract_signed_integer (const gdb_byte *, int,
1046 enum bfd_endian);
1047
1048 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
1049 enum bfd_endian);
1050
1051 extern int extract_long_unsigned_integer (const gdb_byte *, int,
1052 enum bfd_endian, LONGEST *);
1053
1054 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
1055 struct type *type);
1056
1057 extern void store_signed_integer (gdb_byte *, int,
1058 enum bfd_endian, LONGEST);
1059
1060 extern void store_unsigned_integer (gdb_byte *, int,
1061 enum bfd_endian, ULONGEST);
1062
1063 extern void store_typed_address (gdb_byte *buf, struct type *type,
1064 CORE_ADDR addr);
1065
1066 \f
1067 /* From valops.c */
1068
1069 extern int watchdog;
1070
1071 /* Hooks for alternate command interfaces. */
1072
1073 /* The name of the interpreter if specified on the command line. */
1074 extern char *interpreter_p;
1075
1076 /* If a given interpreter matches INTERPRETER_P then it should update
1077 deprecated_command_loop_hook and deprecated_init_ui_hook with the
1078 per-interpreter implementation. */
1079 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1080 should be moved here. */
1081
1082 struct target_waitstatus;
1083 struct cmd_list_element;
1084
1085 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1086 extern void (*deprecated_post_add_symbol_hook) (void);
1087 extern void (*selected_frame_level_changed_hook) (int);
1088 extern int (*deprecated_ui_loop_hook) (int signo);
1089 extern void (*deprecated_init_ui_hook) (char *argv0);
1090 extern void (*deprecated_command_loop_hook) (void);
1091 extern void (*deprecated_show_load_progress) (const char *section,
1092 unsigned long section_sent,
1093 unsigned long section_size,
1094 unsigned long total_sent,
1095 unsigned long total_size);
1096 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1097 int line, int stopline,
1098 int noerror);
1099 extern int (*deprecated_query_hook) (const char *, va_list)
1100 ATTRIBUTE_FPTR_PRINTF(1,0);
1101 extern void (*deprecated_warning_hook) (const char *, va_list)
1102 ATTRIBUTE_FPTR_PRINTF(1,0);
1103 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1104 extern void (*deprecated_interactive_hook) (void);
1105 extern void (*deprecated_readline_begin_hook) (char *, ...)
1106 ATTRIBUTE_FPTR_PRINTF_1;
1107 extern char *(*deprecated_readline_hook) (char *);
1108 extern void (*deprecated_readline_end_hook) (void);
1109 extern void (*deprecated_register_changed_hook) (int regno);
1110 extern void (*deprecated_memory_changed_hook) (CORE_ADDR addr, int len);
1111 extern void (*deprecated_context_hook) (int);
1112 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1113 struct target_waitstatus *status,
1114 int options);
1115
1116 extern void (*deprecated_attach_hook) (void);
1117 extern void (*deprecated_detach_hook) (void);
1118 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1119 char *cmd, int from_tty);
1120
1121 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1122
1123 extern void (*deprecated_error_begin_hook) (void);
1124
1125 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1126 unsigned long num);
1127
1128
1129 /* Inhibit window interface if non-zero. */
1130
1131 extern int use_windows;
1132
1133 /* Symbolic definitions of filename-related things. */
1134 /* FIXME, this doesn't work very well if host and executable
1135 filesystems conventions are different. */
1136
1137 #ifdef __MSDOS__
1138 # define CANT_FORK
1139 # define GLOBAL_CURDIR
1140 # define DIRNAME_SEPARATOR ';'
1141 #endif
1142
1143 #if !defined (__CYGWIN__) && defined (_WIN32)
1144 # define DIRNAME_SEPARATOR ';'
1145 #endif
1146
1147 #ifndef DIRNAME_SEPARATOR
1148 #define DIRNAME_SEPARATOR ':'
1149 #endif
1150
1151 #ifndef SLASH_STRING
1152 #define SLASH_STRING "/"
1153 #endif
1154
1155 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1156 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1157 in the code actually refer to a lightweight process id, i.e,
1158 something that can be considered a process id in its own right for
1159 certain purposes. */
1160
1161 #ifndef PIDGET
1162 #define PIDGET(PTID) (ptid_get_pid (PTID))
1163 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1164 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1165 #endif
1166
1167 /* Define well known filenos if the system does not define them. */
1168 #ifndef STDIN_FILENO
1169 #define STDIN_FILENO 0
1170 #endif
1171 #ifndef STDOUT_FILENO
1172 #define STDOUT_FILENO 1
1173 #endif
1174 #ifndef STDERR_FILENO
1175 #define STDERR_FILENO 2
1176 #endif
1177
1178 /* If this definition isn't overridden by the header files, assume
1179 that isatty and fileno exist on this system. */
1180 #ifndef ISATTY
1181 #define ISATTY(FP) (isatty (fileno (FP)))
1182 #endif
1183
1184 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1185 power of 2). Round up/down when necessary. Examples of correct
1186 use include:
1187
1188 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1189 write_memory (addr, value, len);
1190 addr += len;
1191
1192 and:
1193
1194 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1195 write_memory (sp, value, len);
1196
1197 Note that uses such as:
1198
1199 write_memory (addr, value, len);
1200 addr += align_up (len, 8);
1201
1202 and:
1203
1204 sp -= align_up (len, 8);
1205 write_memory (sp, value, len);
1206
1207 are typically not correct as they don't ensure that the address (SP
1208 or ADDR) is correctly aligned (relying on previous alignment to
1209 keep things right). This is also why the methods are called
1210 "align_..." instead of "round_..." as the latter reads better with
1211 this incorrect coding style. */
1212
1213 extern ULONGEST align_up (ULONGEST v, int n);
1214 extern ULONGEST align_down (ULONGEST v, int n);
1215
1216 /* Allocation and deallocation functions for the libiberty hash table
1217 which use obstacks. */
1218 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
1219 void dummy_obstack_deallocate (void *object, void *data);
1220
1221 #endif /* #ifndef DEFS_H */
This page took 0.057587 seconds and 3 git commands to generate.