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