Purge last remaining make_cleanup_func.
[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, 1989, 1991-1996, 1998-2000
4 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 2 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, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
22
23 #ifndef DEFS_H
24 #define DEFS_H
25
26 #include "config.h" /* Generated by configure */
27 #include <stdio.h>
28 #include <errno.h> /* System call error return status */
29 #include <limits.h>
30
31 #ifdef HAVE_STDDEF_H
32 #include <stddef.h>
33 #else
34 #include <sys/types.h> /* for size_t */
35 #endif
36
37 #ifdef HAVE_UNISTD_H
38 #include <unistd.h>
39 #endif
40
41 /* Just in case they're not defined in stdio.h. */
42
43 #ifndef SEEK_SET
44 #define SEEK_SET 0
45 #endif
46 #ifndef SEEK_CUR
47 #define SEEK_CUR 1
48 #endif
49
50 /* First include ansidecl.h so we can use the various macro definitions
51 here and in all subsequent file inclusions. */
52
53 #include "ansidecl.h"
54
55 #include <stdarg.h> /* for va_list */
56
57 #include "libiberty.h"
58
59 #include "progress.h"
60
61 #ifdef USE_MMALLOC
62 #include "mmalloc.h"
63 #endif
64
65 /* For BFD64 and bfd_vma. */
66 #include "bfd.h"
67
68 /* An address in the program being debugged. Host byte order. Rather
69 than duplicate all the logic in BFD which figures out what type
70 this is (long, long long, etc.) and whether it needs to be 64
71 bits (the host/target interactions are subtle), we just use
72 bfd_vma. */
73
74 typedef bfd_vma CORE_ADDR;
75
76 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
77
78 #ifndef LONGEST
79
80 #ifdef BFD64
81
82 #define LONGEST BFD_HOST_64_BIT
83 #define ULONGEST BFD_HOST_U_64_BIT
84
85 #else /* No BFD64 */
86
87 #ifdef CC_HAS_LONG_LONG
88 #define LONGEST long long
89 #define ULONGEST unsigned long long
90 #else
91 #ifdef BFD_HOST_64_BIT
92 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
93 (e.g. i386-windows) so try it. */
94 #define LONGEST BFD_HOST_64_BIT
95 #define ULONGEST BFD_HOST_U_64_BIT
96 #else
97 #define LONGEST long
98 #define ULONGEST unsigned long
99 #endif
100 #endif
101
102 #endif /* No BFD64 */
103
104 #endif /* ! LONGEST */
105
106 #ifndef min
107 #define min(a, b) ((a) < (b) ? (a) : (b))
108 #endif
109 #ifndef max
110 #define max(a, b) ((a) > (b) ? (a) : (b))
111 #endif
112
113 /* Macros to do string compares.
114
115 NOTE: cagney/2000-03-14:
116
117 While old code can continue to refer to these macros, new code is
118 probably better off using strcmp() directly vis: ``strcmp() == 0''
119 and ``strcmp() != 0''.
120
121 This is because modern compilers can directly inline strcmp()
122 making the original justification for these macros - avoid function
123 call overhead by pre-testing the first characters
124 (``*X==*Y?...:0'') - redundant.
125
126 ``Even if [...] testing the first character does have a modest
127 performance improvement, I'd rather that whenever a performance
128 issue is found that we spend the effort on algorithmic
129 optimizations than micro-optimizing.'' J.T. */
130
131 #define STRCMP(a,b) (*(a) == *(b) ? strcmp ((a), (b)) : (int)*(a) - (int)*(b))
132 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
133 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
134
135 /* The character GNU C++ uses to build identifiers that must be unique from
136 the program's identifiers (such as $this and $$vptr). */
137 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
138
139 /* Check if a character is one of the commonly used C++ marker characters. */
140 extern int is_cplus_marker (int);
141
142 /* use tui interface if non-zero */
143 extern int tui_version;
144
145 #if defined(TUI)
146 /* all invocations of TUIDO should have two sets of parens */
147 #define TUIDO(x) tuiDo x
148 #else
149 #define TUIDO(x)
150 #endif
151
152 /* enable xdb commands if set */
153 extern int xdb_commands;
154
155 /* enable dbx commands if set */
156 extern int dbx_commands;
157
158 extern int quit_flag;
159 extern int immediate_quit;
160 extern int sevenbit_strings;
161
162 extern void quit (void);
163
164 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
165 benefits of having a ``QUIT'' macro rather than a function are
166 marginal. If the overhead of a QUIT function call is proving
167 significant then its calling frequency should probably be reduced
168 [kingdon]. A profile analyzing the current situtation is
169 needed. */
170
171 #ifdef QUIT
172 /* do twice to force compiler warning */
173 #define QUIT_FIXME "FIXME"
174 #define QUIT_FIXME "ignoring redefinition of QUIT"
175 #else
176 #define QUIT { \
177 if (quit_flag) quit (); \
178 if (interactive_hook) interactive_hook (); \
179 PROGRESS (1); \
180 }
181 #endif
182
183 /* Languages represented in the symbol table and elsewhere.
184 This should probably be in language.h, but since enum's can't
185 be forward declared to satisfy opaque references before their
186 actual definition, needs to be here. */
187
188 enum language
189 {
190 language_unknown, /* Language not known */
191 language_auto, /* Placeholder for automatic setting */
192 language_c, /* C */
193 language_cplus, /* C++ */
194 language_java, /* Java */
195 language_chill, /* Chill */
196 language_fortran, /* Fortran */
197 language_m2, /* Modula-2 */
198 language_asm, /* Assembly language */
199 language_scm /* Scheme / Guile */
200 };
201
202 enum precision_type
203 {
204 single_precision,
205 double_precision,
206 unspecified_precision
207 };
208
209 /* the cleanup list records things that have to be undone
210 if an error happens (descriptors to be closed, memory to be freed, etc.)
211 Each link in the chain records a function to call and an
212 argument to give it.
213
214 Use make_cleanup to add an element to the cleanup chain.
215 Use do_cleanups to do all cleanup actions back to a given
216 point in the chain. Use discard_cleanups to remove cleanups
217 from the chain back to a given point, not doing them. */
218
219 struct cleanup
220 {
221 struct cleanup *next;
222 void (*function) (PTR);
223 PTR arg;
224 };
225
226
227 /* The ability to declare that a function never returns is useful, but
228 not really required to compile GDB successfully, so the NORETURN and
229 ATTR_NORETURN macros normally expand into nothing. */
230
231 /* If compiling with older versions of GCC, a function may be declared
232 "volatile" to indicate that it does not return. */
233
234 #ifndef NORETURN
235 #if defined(__GNUC__) \
236 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
237 #define NORETURN volatile
238 #else
239 #define NORETURN /* nothing */
240 #endif
241 #endif
242
243 /* GCC 2.5 and later versions define a function attribute "noreturn",
244 which is the preferred way to declare that a function never returns.
245 However GCC 2.7 appears to be the first version in which this fully
246 works everywhere we use it. */
247
248 #ifndef ATTR_NORETURN
249 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
250 #define ATTR_NORETURN __attribute__ ((noreturn))
251 #else
252 #define ATTR_NORETURN /* nothing */
253 #endif
254 #endif
255
256 #ifndef ATTR_FORMAT
257 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
258 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
259 #else
260 #define ATTR_FORMAT(type, x, y) /* nothing */
261 #endif
262 #endif
263
264 /* Needed for various prototypes */
265
266 struct symtab;
267 struct breakpoint;
268
269 /* From blockframe.c */
270
271 extern int inside_entry_func (CORE_ADDR);
272
273 extern int inside_entry_file (CORE_ADDR addr);
274
275 extern int inside_main_func (CORE_ADDR pc);
276
277 /* From ch-lang.c, for the moment. (FIXME) */
278
279 extern char *chill_demangle (const char *);
280
281 /* From utils.c */
282
283 extern void initialize_utils (void);
284
285 extern void notice_quit (void);
286
287 extern int strcmp_iw (const char *, const char *);
288
289 extern int subset_compare (char *, char *);
290
291 extern char *safe_strerror (int);
292
293 extern void init_malloc (void *);
294
295 extern void request_quit (int);
296
297 extern void do_cleanups (struct cleanup *);
298 extern void do_final_cleanups (struct cleanup *);
299 extern void do_my_cleanups (struct cleanup **, struct cleanup *);
300 extern void do_run_cleanups (struct cleanup *);
301 extern void do_exec_cleanups (struct cleanup *);
302 extern void do_exec_error_cleanups (struct cleanup *);
303
304 extern void discard_cleanups (struct cleanup *);
305 extern void discard_final_cleanups (struct cleanup *);
306 extern void discard_exec_error_cleanups (struct cleanup *);
307 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
308
309 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
310 make_cleanup function declarations below. Do not use this typedef
311 as a cast when passing functions into the make_cleanup() code.
312 Instead either use a bounce function or add a wrapper function.
313 Calling a f(char*) function with f(void*) is non-portable. */
314 typedef void (make_cleanup_ftype) (void *);
315
316 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
317
318 extern struct cleanup *make_cleanup_freeargv (char **);
319
320 struct ui_file;
321 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
322
323 extern struct cleanup *make_cleanup_close (int fd);
324
325 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
326
327 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
328
329 extern struct cleanup *make_my_cleanup (struct cleanup **,
330 make_cleanup_ftype *, void *);
331
332 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
333
334 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
335 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
336
337 extern struct cleanup *save_cleanups (void);
338 extern struct cleanup *save_final_cleanups (void);
339 extern struct cleanup *save_my_cleanups (struct cleanup **);
340
341 extern void restore_cleanups (struct cleanup *);
342 extern void restore_final_cleanups (struct cleanup *);
343 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
344
345 extern void free_current_contents (void *);
346
347 extern void null_cleanup (void *);
348
349 extern int myread (int, char *, int);
350
351 extern int query (char *, ...) ATTR_FORMAT (printf, 1, 2);
352
353 #if !defined (USE_MMALLOC)
354 /* NOTE: cagney/2000-03-04: The mmalloc functions need to use PTR
355 rather than void* so that they are consistent with
356 ../mmalloc/mmalloc.h. */
357 extern PTR mcalloc (PTR, size_t, size_t);
358 extern PTR mmalloc (PTR, size_t);
359 extern PTR mrealloc (PTR, PTR, size_t);
360 extern void mfree (PTR, PTR);
361 #endif
362
363 extern void init_page_info (void);
364
365 extern CORE_ADDR host_pointer_to_address (void *ptr);
366 extern void *address_to_host_pointer (CORE_ADDR addr);
367
368 /* From demangle.c */
369
370 extern void set_demangling_style (char *);
371
372 /* From tm.h */
373
374 struct type;
375 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
376 extern use_struct_convention_fn generic_use_struct_convention;
377
378 typedef unsigned char *(breakpoint_from_pc_fn) (CORE_ADDR * pcptr, int *lenptr);
379 \f
380 /* Annotation stuff. */
381
382 extern int annotation_level; /* in stack.c */
383 \f
384 extern void begin_line (void);
385
386 extern void wrap_here (char *);
387
388 extern void reinitialize_more_filter (void);
389
390 /* Normal results */
391 extern struct ui_file *gdb_stdout;
392 /* Serious error notifications */
393 extern struct ui_file *gdb_stderr;
394 /* Log/debug/trace messages that should bypass normal stdout/stderr
395 filtering. For momement, always call this stream using
396 *_unfiltered. In the very near future that restriction shall be
397 removed - either call shall be unfiltered. (cagney 1999-06-13). */
398 extern struct ui_file *gdb_stdlog;
399 /* Target output that should bypass normal stdout/stderr filtering.
400 For momement, always call this stream using *_unfiltered. In the
401 very near future that restriction shall be removed - either call
402 shall be unfiltered. (cagney 1999-07-02). */
403 extern struct ui_file *gdb_stdtarg;
404
405 #if defined(TUI)
406 #include "tui.h"
407 #include "tuiCommand.h"
408 #include "tuiData.h"
409 #include "tuiIO.h"
410 #include "tuiLayout.h"
411 #include "tuiWin.h"
412 #endif
413
414 #include "ui-file.h"
415
416 /* More generic printf like operations */
417
418 extern void fputs_filtered (const char *, struct ui_file *);
419
420 extern void fputs_unfiltered (const char *, struct ui_file *);
421
422 extern int fputc_filtered (int c, struct ui_file *);
423
424 extern int fputc_unfiltered (int c, struct ui_file *);
425
426 extern int putchar_unfiltered (int c);
427
428 extern void puts_filtered (const char *);
429
430 extern void puts_unfiltered (const char *);
431
432 extern void puts_debug (char *prefix, char *string, char *suffix);
433
434 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
435
436 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
437
438 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
439
440 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
441
442 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
443
444 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
445
446 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
447
448 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
449
450 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
451
452 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
453
454 extern void print_spaces (int, struct ui_file *);
455
456 extern void print_spaces_filtered (int, struct ui_file *);
457
458 extern char *n_spaces (int);
459
460 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
461
462 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
463
464 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
465
466 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
467 extern void gdb_print_host_address (void *addr, struct ui_file *stream);
468
469 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
470 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
471 for ``%*''. */
472 extern int strlen_paddr (void);
473 extern char *paddr (CORE_ADDR addr);
474 extern char *paddr_nz (CORE_ADDR addr);
475 extern char *paddr_u (CORE_ADDR addr);
476 extern char *paddr_d (LONGEST addr);
477
478 extern char *phex (ULONGEST l, int sizeof_l);
479 extern char *phex_nz (ULONGEST l, int sizeof_l);
480
481 extern void fprintf_symbol_filtered (struct ui_file *, char *,
482 enum language, int);
483
484 extern NORETURN void perror_with_name (char *) ATTR_NORETURN;
485
486 extern void print_sys_errmsg (char *, int);
487
488 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
489 "const char *" in unistd.h, so we can't declare the argument
490 as "char *". */
491
492 extern char *re_comp (const char *);
493
494 /* From symfile.c */
495
496 extern void symbol_file_command (char *, int);
497
498 /* Remote targets may wish to use this as their load function. */
499 extern void generic_load (char *name, int from_tty);
500
501 /* Summarise a download */
502 extern void print_transfer_performance (struct ui_file *stream,
503 unsigned long data_count,
504 unsigned long write_count,
505 unsigned long time_count);
506
507 /* From top.c */
508
509 typedef void initialize_file_ftype (void);
510
511 extern char *skip_quoted (char *);
512
513 extern char *gdb_readline (char *);
514
515 extern char *command_line_input (char *, int, char *);
516
517 extern void print_prompt (void);
518
519 extern int input_from_terminal_p (void);
520
521 extern int info_verbose;
522
523 /* From printcmd.c */
524
525 extern void set_next_address (CORE_ADDR);
526
527 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
528 char *);
529
530 extern int build_address_symbolic (CORE_ADDR addr,
531 int do_demangle,
532 char **name,
533 int *offset,
534 char **filename,
535 int *line,
536 int *unmapped);
537
538 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
539
540 extern void print_address (CORE_ADDR, struct ui_file *);
541
542 /* From source.c */
543
544 extern int openp (char *, int, char *, int, int, char **);
545
546 extern int source_full_path_of (char *, char **);
547
548 extern void mod_path (char *, char **);
549
550 extern void directory_command (char *, int);
551
552 extern void init_source_path (void);
553
554 extern char *symtab_to_filename (struct symtab *);
555
556 /* From exec.c */
557
558 extern void exec_set_section_offsets (bfd_signed_vma text_off,
559 bfd_signed_vma data_off,
560 bfd_signed_vma bss_off);
561
562 /* From findvar.c */
563
564 extern int read_relative_register_raw_bytes (int, char *);
565
566 /* Possible lvalue types. Like enum language, this should be in
567 value.h, but needs to be here for the same reason. */
568
569 enum lval_type
570 {
571 /* Not an lval. */
572 not_lval,
573 /* In memory. Could be a saved register. */
574 lval_memory,
575 /* In a register. */
576 lval_register,
577 /* In a gdb internal variable. */
578 lval_internalvar,
579 /* Part of a gdb internal variable (structure field). */
580 lval_internalvar_component,
581 /* In a register series in a frame not the current one, which may have been
582 partially saved or saved in different places (otherwise would be
583 lval_register or lval_memory). */
584 lval_reg_frame_relative
585 };
586
587 struct frame_info;
588
589 void default_get_saved_register (char *raw_buffer, int *optimized,
590 CORE_ADDR * addrp,
591 struct frame_info *frame, int regnum,
592 enum lval_type *lval);
593
594 /* From readline (but not in any readline .h files). */
595
596 extern char *tilde_expand (char *);
597
598 /* Control types for commands */
599
600 enum misc_command_type
601 {
602 ok_command,
603 end_command,
604 else_command,
605 nop_command
606 };
607
608 enum command_control_type
609 {
610 simple_control,
611 break_control,
612 continue_control,
613 while_control,
614 if_control,
615 invalid_control
616 };
617
618 /* Structure for saved commands lines
619 (for breakpoints, defined commands, etc). */
620
621 struct command_line
622 {
623 struct command_line *next;
624 char *line;
625 enum command_control_type control_type;
626 int body_count;
627 struct command_line **body_list;
628 };
629
630 extern struct command_line *read_command_lines (char *, int);
631
632 extern void free_command_lines (struct command_line **);
633
634 /* To continue the execution commands when running gdb asynchronously.
635 A continuation structure contains a pointer to a function to be called
636 to finish the command, once the target has stopped. Such mechanism is
637 used bt the finish and until commands, and in the remote protocol
638 when opening an extended-remote connection. */
639
640 struct continuation_arg
641 {
642 struct continuation_arg *next;
643 union continuation_data {
644 void *pointer;
645 int integer;
646 long longint;
647 } data;
648 };
649
650 struct continuation
651 {
652 void (*continuation_hook) (struct continuation_arg *);
653 struct continuation_arg *arg_list;
654 struct continuation *next;
655 };
656 struct continuation continuation;
657
658 /* In infrun.c. */
659 extern struct continuation *cmd_continuation;
660 /* Used only by the step_1 function. */
661 extern struct continuation *intermediate_continuation;
662
663 /* From utils.c */
664 extern void add_continuation (void (*)(struct continuation_arg *),
665 struct continuation_arg *);
666 extern void do_all_continuations (void);
667 extern void discard_all_continuations (void);
668
669 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
670 struct continuation_arg *);
671 extern void do_all_intermediate_continuations (void);
672 extern void discard_all_intermediate_continuations (void);
673
674 /* String containing the current directory (what getwd would return). */
675
676 extern char *current_directory;
677
678 /* Default radixes for input and output. Only some values supported. */
679 extern unsigned input_radix;
680 extern unsigned output_radix;
681
682 /* Possibilities for prettyprint parameters to routines which print
683 things. Like enum language, this should be in value.h, but needs
684 to be here for the same reason. FIXME: If we can eliminate this
685 as an arg to LA_VAL_PRINT, then we can probably move it back to
686 value.h. */
687
688 enum val_prettyprint
689 {
690 Val_no_prettyprint = 0,
691 Val_prettyprint,
692 /* Use the default setting which the user has specified. */
693 Val_pretty_default
694 };
695 \f
696
697 /* Host machine definition. This will be a symlink to one of the
698 xm-*.h files, built by the `configure' script. */
699
700 #include "xm.h"
701
702 /* Native machine support. This will be a symlink to one of the
703 nm-*.h files, built by the `configure' script. */
704
705 #include "nm.h"
706
707 /* Target machine definition. This will be a symlink to one of the
708 tm-*.h files, built by the `configure' script. */
709
710 #include "tm.h"
711
712 /* If the xm.h file did not define the mode string used to open the
713 files, assume that binary files are opened the same way as text
714 files */
715 #ifndef FOPEN_RB
716 #include "fopen-same.h"
717 #endif
718
719 /* Microsoft C can't deal with const pointers */
720
721 #ifdef _MSC_VER
722 #define CONST_PTR
723 #else
724 #define CONST_PTR const
725 #endif
726
727 /*
728 * Allow things in gdb to be declared "volatile". If compiling ANSI, it
729 * just works. If compiling with gcc but non-ansi, redefine to __volatile__.
730 * If non-ansi, non-gcc, then eliminate "volatile" entirely, making those
731 * objects be read-write rather than read-only.
732 */
733
734 #ifndef volatile
735 #ifndef __STDC__
736 #ifdef __GNUC__
737 #define volatile __volatile__
738 #else
739 #define volatile /* nothing */
740 #endif /* GNUC */
741 #endif /* STDC */
742 #endif /* volatile */
743
744 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
745 FIXME: Assumes 2's complement arithmetic */
746
747 #if !defined (UINT_MAX)
748 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
749 #endif
750
751 #if !defined (INT_MAX)
752 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
753 #endif
754
755 #if !defined (INT_MIN)
756 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
757 #endif
758
759 #if !defined (ULONG_MAX)
760 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
761 #endif
762
763 #if !defined (LONG_MAX)
764 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
765 #endif
766
767 #if !defined (ULONGEST_MAX)
768 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 32-bits */
769 #endif
770
771 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 32-bits */
772 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
773 #endif
774
775 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
776 arguments to a function, number in a value history, register number, etc.)
777 where the value must not be larger than can fit in an int. */
778
779 extern int longest_to_int (LONGEST);
780
781 /* Assorted functions we can declare, now that const and volatile are
782 defined. */
783
784 extern char *savestring (const char *, int);
785
786 extern char *msavestring (void *, const char *, int);
787
788 extern char *strsave (const char *);
789
790 extern char *mstrsave (void *, const char *);
791
792 /* FIXME; was long, but this causes compile errors in msvc if already
793 defined */
794 #ifdef _MSC_VER
795 extern PTR xmmalloc (PTR, size_t);
796 extern PTR xmrealloc (PTR, PTR, size_t);
797 #else
798 extern PTR xmmalloc (PTR, long);
799 extern PTR xmrealloc (PTR, PTR, long);
800 #endif
801
802 extern int parse_escape (char **);
803
804 /* Message to be printed before the error message, when an error occurs. */
805
806 extern char *error_pre_print;
807
808 /* Message to be printed before the error message, when an error occurs. */
809
810 extern char *quit_pre_print;
811
812 /* Message to be printed before the warning message, when a warning occurs. */
813
814 extern char *warning_pre_print;
815
816 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
817
818 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN;
819
820 /* DEPRECATED: Use error(), verror() or error_stream(). */
821 extern NORETURN void error_begin (void);
822
823 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
824
825 /* Returns a freshly allocate buffer containing the last error
826 message. */
827 extern char *error_last_message (void);
828
829 extern NORETURN void internal_verror (const char *, va_list ap) ATTR_NORETURN;
830
831 extern NORETURN void internal_error (char *, ...) ATTR_NORETURN;
832
833 extern NORETURN void nomem (long) ATTR_NORETURN;
834
835 /* Reasons for calling return_to_top_level. Note: enum value 0 is
836 reserved for internal use as the return value from an initial
837 setjmp(). */
838
839 enum return_reason
840 {
841 /* User interrupt. */
842 RETURN_QUIT = 1,
843 /* Any other error. */
844 RETURN_ERROR
845 };
846
847 #define ALL_CLEANUPS ((struct cleanup *)0)
848
849 #define RETURN_MASK(reason) (1 << (int)(reason))
850 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
851 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
852 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
853 typedef int return_mask;
854
855 extern NORETURN void return_to_top_level (enum return_reason) ATTR_NORETURN;
856
857 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
858 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
859 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
860 value. It's unfortunate that, catch_errors() does not return an
861 indication of the exact exception that it caught - quit_flag might
862 help. */
863
864 typedef int (catch_errors_ftype) (PTR);
865 extern int catch_errors (catch_errors_ftype *, PTR, char *, return_mask);
866
867 /* Template to catch_errors() that wraps calls to command
868 functions. */
869
870 typedef void (catch_command_errors_ftype) (char *, int);
871 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
872
873 extern void warning_begin (void);
874
875 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
876
877 /* Global functions from other, non-gdb GNU thingies.
878 Libiberty thingies are no longer declared here. We include libiberty.h
879 above, instead. */
880
881 #ifndef GETENV_PROVIDED
882 extern char *getenv (const char *);
883 #endif
884
885 /* From other system libraries */
886
887 #ifdef HAVE_STDDEF_H
888 #include <stddef.h>
889 #endif
890
891 #ifdef HAVE_STDLIB_H
892 #if defined(_MSC_VER) && !defined(__cplusplus)
893 /* msvc defines these in stdlib.h for c code */
894 #undef min
895 #undef max
896 #endif
897 #include <stdlib.h>
898 #endif
899 #ifndef min
900 #define min(a, b) ((a) < (b) ? (a) : (b))
901 #endif
902 #ifndef max
903 #define max(a, b) ((a) > (b) ? (a) : (b))
904 #endif
905
906
907 /* We take the address of fclose later, but some stdio's forget
908 to declare this. We can't always declare it since there's
909 no way to declare the parameters without upsetting some compiler
910 somewhere. */
911
912 #ifndef FCLOSE_PROVIDED
913 extern int fclose (FILE *);
914 #endif
915
916 #ifndef atof
917 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
918 #endif
919
920 #ifndef MALLOC_INCOMPATIBLE
921
922 #ifdef NEED_DECLARATION_MALLOC
923 extern PTR malloc ();
924 #endif
925
926 #ifdef NEED_DECLARATION_REALLOC
927 extern PTR realloc ();
928 #endif
929
930 #ifdef NEED_DECLARATION_FREE
931 extern void free ();
932 #endif
933
934 #endif /* MALLOC_INCOMPATIBLE */
935
936 /* Various possibilities for alloca. */
937 #ifndef alloca
938 #ifdef __GNUC__
939 #define alloca __builtin_alloca
940 #else /* Not GNU C */
941 #ifdef HAVE_ALLOCA_H
942 #include <alloca.h>
943 #else
944 #ifdef _AIX
945 #pragma alloca
946 #else
947
948 /* We need to be careful not to declare this in a way which conflicts with
949 bison. Bison never declares it as char *, but under various circumstances
950 (like __hpux) we need to use void *. */
951 #if defined (__STDC__) || defined (__hpux)
952 extern void *alloca ();
953 #else /* Don't use void *. */
954 extern char *alloca ();
955 #endif /* Don't use void *. */
956 #endif /* Not _AIX */
957 #endif /* Not HAVE_ALLOCA_H */
958 #endif /* Not GNU C */
959 #endif /* alloca not defined */
960
961 /* HOST_BYTE_ORDER must be defined to one of these. */
962
963 #ifdef HAVE_ENDIAN_H
964 #include <endian.h>
965 #endif
966
967 #if !defined (BIG_ENDIAN)
968 #define BIG_ENDIAN 4321
969 #endif
970
971 #if !defined (LITTLE_ENDIAN)
972 #define LITTLE_ENDIAN 1234
973 #endif
974
975 /* Dynamic target-system-dependent parameters for GDB. */
976 #include "gdbarch.h"
977 #if (GDB_MULTI_ARCH == 0)
978 /* Multi-arch targets _should_ be including "arch-utils.h" directly
979 into their *-tdep.c file. This is a prop to help old non-
980 multi-arch targets to continue to compile. */
981 #include "arch-utils.h"
982 #endif
983
984 /* Static target-system-dependent parameters for GDB. */
985
986 /* Number of bits in a char or unsigned char for the target machine.
987 Just like CHAR_BIT in <limits.h> but describes the target machine. */
988 #if !defined (TARGET_CHAR_BIT)
989 #define TARGET_CHAR_BIT 8
990 #endif
991
992 /* Number of bits in a short or unsigned short for the target machine. */
993 #if !defined (TARGET_SHORT_BIT)
994 #define TARGET_SHORT_BIT (2 * TARGET_CHAR_BIT)
995 #endif
996
997 /* Number of bits in an int or unsigned int for the target machine. */
998 #if !defined (TARGET_INT_BIT)
999 #define TARGET_INT_BIT (4 * TARGET_CHAR_BIT)
1000 #endif
1001
1002 /* Number of bits in a long or unsigned long for the target machine. */
1003 #if !defined (TARGET_LONG_BIT)
1004 #define TARGET_LONG_BIT (4 * TARGET_CHAR_BIT)
1005 #endif
1006
1007 /* Number of bits in a long long or unsigned long long for the target machine. */
1008 #if !defined (TARGET_LONG_LONG_BIT)
1009 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
1010 #endif
1011
1012 /* Number of bits in a float for the target machine. */
1013 #if !defined (TARGET_FLOAT_BIT)
1014 #define TARGET_FLOAT_BIT (4 * TARGET_CHAR_BIT)
1015 #endif
1016
1017 /* Number of bits in a double for the target machine. */
1018 #if !defined (TARGET_DOUBLE_BIT)
1019 #define TARGET_DOUBLE_BIT (8 * TARGET_CHAR_BIT)
1020 #endif
1021
1022 /* Number of bits in a long double for the target machine. */
1023 #if !defined (TARGET_LONG_DOUBLE_BIT)
1024 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
1025 #endif
1026
1027 /* Number of bits in a pointer for the target machine */
1028 #if !defined (TARGET_PTR_BIT)
1029 #define TARGET_PTR_BIT TARGET_INT_BIT
1030 #endif
1031
1032 /* Number of bits in a BFD_VMA for the target object file format. */
1033 #if !defined (TARGET_BFD_VMA_BIT)
1034 #define TARGET_BFD_VMA_BIT TARGET_PTR_BIT
1035 #endif
1036
1037 /* If we picked up a copy of CHAR_BIT from a configuration file
1038 (which may get it by including <limits.h>) then use it to set
1039 the number of bits in a host char. If not, use the same size
1040 as the target. */
1041
1042 #if defined (CHAR_BIT)
1043 #define HOST_CHAR_BIT CHAR_BIT
1044 #else
1045 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1046 #endif
1047
1048 /* The bit byte-order has to do just with numbering of bits in
1049 debugging symbols and such. Conceptually, it's quite separate
1050 from byte/word byte order. */
1051
1052 #if !defined (BITS_BIG_ENDIAN)
1053 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
1054 #endif
1055
1056 /* In findvar.c. */
1057
1058 extern LONGEST extract_signed_integer (void *, int);
1059
1060 extern ULONGEST extract_unsigned_integer (void *, int);
1061
1062 extern int extract_long_unsigned_integer (void *, int, LONGEST *);
1063
1064 extern CORE_ADDR extract_address (void *, int);
1065
1066 extern CORE_ADDR extract_typed_address (void *buf, struct type *type);
1067
1068 extern void store_signed_integer (void *, int, LONGEST);
1069
1070 extern void store_unsigned_integer (void *, int, ULONGEST);
1071
1072 extern void store_address (void *, int, LONGEST);
1073
1074 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1075
1076 /* Setup definitions for host and target floating point formats. We need to
1077 consider the format for `float', `double', and `long double' for both target
1078 and host. We need to do this so that we know what kind of conversions need
1079 to be done when converting target numbers to and from the hosts DOUBLEST
1080 data type. */
1081
1082 /* This is used to indicate that we don't know the format of the floating point
1083 number. Typically, this is useful for native ports, where the actual format
1084 is irrelevant, since no conversions will be taking place. */
1085
1086 extern const struct floatformat floatformat_unknown;
1087
1088 #if HOST_BYTE_ORDER == BIG_ENDIAN
1089 #ifndef HOST_FLOAT_FORMAT
1090 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_big
1091 #endif
1092 #ifndef HOST_DOUBLE_FORMAT
1093 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_big
1094 #endif
1095 #else /* LITTLE_ENDIAN */
1096 #ifndef HOST_FLOAT_FORMAT
1097 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_little
1098 #endif
1099 #ifndef HOST_DOUBLE_FORMAT
1100 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_little
1101 #endif
1102 #endif
1103
1104 #ifndef HOST_LONG_DOUBLE_FORMAT
1105 #define HOST_LONG_DOUBLE_FORMAT &floatformat_unknown
1106 #endif
1107
1108 /* Use `long double' if the host compiler supports it. (Note that this is not
1109 necessarily any longer than `double'. On SunOS/gcc, it's the same as
1110 double.) This is necessary because GDB internally converts all floating
1111 point values to the widest type supported by the host.
1112
1113 There are problems however, when the target `long double' is longer than the
1114 host's `long double'. In general, we'll probably reduce the precision of
1115 any such values and print a warning. */
1116
1117 #ifdef HAVE_LONG_DOUBLE
1118 typedef long double DOUBLEST;
1119 #else
1120 typedef double DOUBLEST;
1121 #endif
1122
1123 extern void floatformat_to_doublest (const struct floatformat *,
1124 char *, DOUBLEST *);
1125 extern void floatformat_from_doublest (const struct floatformat *,
1126 DOUBLEST *, char *);
1127 extern DOUBLEST extract_floating (void *, int);
1128
1129 extern void store_floating (void *, int, DOUBLEST);
1130 \f
1131 /* On some machines there are bits in addresses which are not really
1132 part of the address, but are used by the kernel, the hardware, etc.
1133 for special purposes. ADDR_BITS_REMOVE takes out any such bits
1134 so we get a "real" address such as one would find in a symbol
1135 table. This is used only for addresses of instructions, and even then
1136 I'm not sure it's used in all contexts. It exists to deal with there
1137 being a few stray bits in the PC which would mislead us, not as some sort
1138 of generic thing to handle alignment or segmentation (it's possible it
1139 should be in TARGET_READ_PC instead). */
1140 #if !defined (ADDR_BITS_REMOVE)
1141 #define ADDR_BITS_REMOVE(addr) (addr)
1142 #endif /* No ADDR_BITS_REMOVE. */
1143
1144 /* From valops.c */
1145
1146 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1147
1148 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1149
1150 extern int watchdog;
1151
1152 /* Hooks for alternate command interfaces. */
1153
1154 #ifdef UI_OUT
1155 /* The name of the interpreter if specified on the command line. */
1156 extern char *interpreter_p;
1157 #endif
1158
1159 /* If a given interpreter matches INTERPRETER_P then it should update
1160 command_loop_hook and init_ui_hook with the per-interpreter
1161 implementation. */
1162 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1163
1164 struct target_waitstatus;
1165 struct cmd_list_element;
1166
1167 /* Should the asynchronous variant of the interpreter (using the
1168 event-loop) be enabled? */
1169 extern int event_loop_p;
1170
1171 extern void (*init_ui_hook) (char *argv0);
1172 extern void (*command_loop_hook) (void);
1173 extern void (*show_load_progress) (const char *section,
1174 unsigned long section_sent,
1175 unsigned long section_size,
1176 unsigned long total_sent,
1177 unsigned long total_size);
1178 extern void (*print_frame_info_listing_hook) (struct symtab * s,
1179 int line, int stopline,
1180 int noerror);
1181 extern struct frame_info *parse_frame_specification (char *frame_exp);
1182 extern int (*query_hook) (const char *, va_list);
1183 extern void (*warning_hook) (const char *, va_list);
1184 extern void (*flush_hook) (struct ui_file * stream);
1185 extern void (*create_breakpoint_hook) (struct breakpoint * b);
1186 extern void (*delete_breakpoint_hook) (struct breakpoint * bpt);
1187 extern void (*modify_breakpoint_hook) (struct breakpoint * bpt);
1188 extern void (*interactive_hook) (void);
1189 extern void (*registers_changed_hook) (void);
1190 extern void (*readline_begin_hook) (char *,...);
1191 extern char *(*readline_hook) (char *);
1192 extern void (*readline_end_hook) (void);
1193 extern void (*register_changed_hook) (int regno);
1194 extern void (*memory_changed_hook) (CORE_ADDR addr, int len);
1195 extern void (*context_hook) (int);
1196 extern int (*target_wait_hook) (int pid, struct target_waitstatus * status);
1197
1198 extern void (*attach_hook) (void);
1199 extern void (*detach_hook) (void);
1200 extern void (*call_command_hook) (struct cmd_list_element * c,
1201 char *cmd, int from_tty);
1202
1203 extern void (*set_hook) (struct cmd_list_element * c);
1204
1205 extern NORETURN void (*error_hook) (void) ATTR_NORETURN;
1206
1207 extern void (*error_begin_hook) (void);
1208
1209 extern int (*ui_load_progress_hook) (const char *section, unsigned long num);
1210
1211
1212 /* Inhibit window interface if non-zero. */
1213
1214 extern int use_windows;
1215
1216 /* Symbolic definitions of filename-related things. */
1217 /* FIXME, this doesn't work very well if host and executable
1218 filesystems conventions are different. */
1219
1220 #ifndef DIRNAME_SEPARATOR
1221 #define DIRNAME_SEPARATOR ':'
1222 #endif
1223
1224 #ifndef SLASH_P
1225 #if defined(__GO32__)||defined(_WIN32)
1226 #define SLASH_P(X) ((X)=='\\')
1227 #else
1228 #define SLASH_P(X) ((X)=='/')
1229 #endif
1230 #endif
1231
1232 #ifndef SLASH_CHAR
1233 #if defined(__GO32__)||defined(_WIN32)
1234 #define SLASH_CHAR '\\'
1235 #else
1236 #define SLASH_CHAR '/'
1237 #endif
1238 #endif
1239
1240 #ifndef SLASH_STRING
1241 #if defined(__GO32__)||defined(_WIN32)
1242 #define SLASH_STRING "\\"
1243 #else
1244 #define SLASH_STRING "/"
1245 #endif
1246 #endif
1247
1248 #ifndef ROOTED_P
1249 #define ROOTED_P(X) (SLASH_P((X)[0]))
1250 #endif
1251
1252 /* On some systems, PIDGET is defined to extract the inferior pid from
1253 an internal pid that has the thread id and pid in seperate bit
1254 fields. If not defined, then just use the entire internal pid as
1255 the actual pid. */
1256
1257 #ifndef PIDGET
1258 #define PIDGET(PID) (PID)
1259 #define TIDGET(PID) 0
1260 #define MERGEPID(PID, TID) (PID)
1261 #endif
1262
1263 /* If under Cygwin, provide backwards compatibility with older
1264 Cygwin compilers that don't define the current cpp define. */
1265 #ifdef __CYGWIN32__
1266 #ifndef __CYGWIN__
1267 #define __CYGWIN__
1268 #endif
1269 #endif
1270
1271 /* Define well known filenos if the system does not define them. */
1272 #ifndef STDIN_FILENO
1273 #define STDIN_FILENO 0
1274 #endif
1275 #ifndef STDOUT_FILENO
1276 #define STDOUT_FILENO 1
1277 #endif
1278 #ifndef STDERR_FILENO
1279 #define STDERR_FILENO 2
1280 #endif
1281
1282 /* If this definition isn't overridden by the header files, assume
1283 that isatty and fileno exist on this system. */
1284 #ifndef ISATTY
1285 #define ISATTY(FP) (isatty (fileno (FP)))
1286 #endif
1287
1288 \f
1289 /* FIXME: cagney/1999-12-13: The following will be moved to gdb.h /
1290 libgdb.h or gdblib.h. */
1291
1292 /* Return-code (RC) from a gdb library call. (The abreviation RC is
1293 taken from the sim/common directory.) */
1294
1295 enum gdb_rc {
1296 /* The operation failed. The failure message can be fetched by
1297 calling ``char *error_last_message(void)''. The value is
1298 determined by the catch_errors() interface. */
1299 /* NOTE: Since ``defs.h:catch_errors()'' does not return an error /
1300 internal / quit indication it is not possible to return that
1301 here. */
1302 GDB_RC_FAIL = 0,
1303 /* No error occured but nothing happened. Due to the catch_errors()
1304 interface, this must be non-zero. */
1305 GDB_RC_NONE = 1,
1306 /* The operation was successful. Due to the catch_errors()
1307 interface, this must be non-zero. */
1308 GDB_RC_OK = 2
1309 };
1310
1311
1312 /* Print the specified breakpoint on GDB_STDOUT. (Eventually this
1313 function will ``print'' the object on ``output''). */
1314 enum gdb_rc gdb_breakpoint_query (/* struct {ui,gdb}_out *output, */ int bnum);
1315
1316 /* Create a breakpoint at ADDRESS (a GDB source and line). */
1317 enum gdb_rc gdb_breakpoint (char *address, char *condition,
1318 int hardwareflag, int tempflag,
1319 int thread, int ignore_count);
1320 enum gdb_rc gdb_thread_select (/* output object */ char *tidstr);
1321
1322 #ifdef UI_OUT
1323 /* Print a list of known thread ids. */
1324 enum gdb_rc gdb_list_thread_ids (/* output object */);
1325
1326 /* Switch thread and print notification. */
1327 #endif
1328 #endif /* #ifndef DEFS_H */
This page took 0.056657 seconds and 5 git commands to generate.