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