Use M_INTWAIT, not M_NOWAIT. We don't really support fast interrupt
[dragonfly.git] / contrib / gdb / gdb / defs.h
1 /* Basic, host-specific, and target-specific definitions for GDB.
2    Copyright (C) 1986, 89, 91, 92, 93, 94, 95, 96, 98, 1999
3    Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
20
21 #ifndef DEFS_H
22 #define DEFS_H
23
24 #include "config.h"             /* Generated by configure */
25 #include <stdio.h>
26 #include <errno.h>              /* System call error return status */
27 #include <limits.h>
28 #include <stdlib.h>
29 #include <string.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 /* Just in case they're not defined in stdio.h. */
38
39 #ifndef SEEK_SET
40 #define SEEK_SET 0
41 #endif
42 #ifndef SEEK_CUR
43 #define SEEK_CUR 1
44 #endif
45
46 /* First include ansidecl.h so we can use the various macro definitions
47    here and in all subsequent file inclusions.  */
48
49 #include "ansidecl.h"
50
51 #ifdef ANSI_PROTOTYPES
52 #include <stdarg.h>
53 #else
54 #include <varargs.h>
55 #endif
56
57 #include "libiberty.h"
58
59 /* libiberty.h can't declare this one, but evidently we can.  */
60 extern char *strsignal PARAMS ((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 #ifndef min
80 #define min(a, b) ((a) < (b) ? (a) : (b))
81 #endif
82 #ifndef max
83 #define max(a, b) ((a) > (b) ? (a) : (b))
84 #endif
85
86 /* Gdb does *lots* of string compares.  Use macros to speed them up by
87    avoiding function calls if the first characters are not the same. */
88
89 #define STRCMP(a,b) (*(a) == *(b) ? strcmp ((a), (b)) : (int)*(a) - (int)*(b))
90 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
91 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
92
93 /* The character GNU C++ uses to build identifiers that must be unique from
94    the program's identifiers (such as $this and $$vptr).  */
95 #define CPLUS_MARKER '$'        /* May be overridden to '.' for SysV */
96
97 /* Check if a character is one of the commonly used C++ marker characters.  */
98 extern int is_cplus_marker PARAMS ((int));
99
100 /* use tui interface if non-zero */
101 extern int tui_version;
102
103 #if defined(TUI)
104 /* all invocations of TUIDO should have two sets of parens */
105 #define TUIDO(x)        tuiDo x
106 #else
107 #define TUIDO(x)
108 #endif
109
110 /* enable xdb commands if set */
111 extern int xdb_commands;
112
113 /* enable dbx commands if set */
114 extern int dbx_commands;
115
116 extern int quit_flag;
117 extern int immediate_quit;
118 extern int sevenbit_strings;
119
120 extern void quit PARAMS ((void));
121
122 #ifdef QUIT
123 /* do twice to force compiler warning */
124 #define QUIT_FIXME "FIXME"
125 #define QUIT_FIXME "ignoring redefinition of QUIT"
126 #else
127 #define QUIT { \
128   if (quit_flag) quit (); \
129   if (interactive_hook) interactive_hook (); \
130   PROGRESS (1); \
131 }
132 #endif
133
134 /* Command classes are top-level categories into which commands are broken
135    down for "help" purposes.  
136    Notes on classes: class_alias is for alias commands which are not
137    abbreviations of the original command.  class-pseudo is for commands
138    which are not really commands nor help topics ("stop").  */
139
140 enum command_class
141 {
142   /* Special args to help_list */
143   all_classes = -2, all_commands = -1,
144   /* Classes of commands */
145   no_class = -1, class_run = 0, class_vars, class_stack,
146   class_files, class_support, class_info, class_breakpoint, class_trace,
147   class_alias, class_obscure, class_user, class_maintenance,
148   class_pseudo, class_tui, class_xdb
149 };
150
151 /* Languages represented in the symbol table and elsewhere.
152    This should probably be in language.h, but since enum's can't
153    be forward declared to satisfy opaque references before their
154    actual definition, needs to be here. */
155
156 enum language 
157 {
158    language_unknown,            /* Language not known */
159    language_auto,               /* Placeholder for automatic setting */
160    language_c,                  /* C */
161    language_cplus,              /* C++ */
162    language_java,               /* Java */
163    language_chill,              /* Chill */
164    language_fortran,            /* Fortran */
165    language_m2,                 /* Modula-2 */
166    language_asm,                /* Assembly language */
167    language_scm                 /* Scheme / Guile */
168 };
169
170 enum precision_type
171 {
172   single_precision,
173   double_precision,
174   unspecified_precision
175 };
176    
177 /* the cleanup list records things that have to be undone
178    if an error happens (descriptors to be closed, memory to be freed, etc.)
179    Each link in the chain records a function to call and an
180    argument to give it.
181
182    Use make_cleanup to add an element to the cleanup chain.
183    Use do_cleanups to do all cleanup actions back to a given
184    point in the chain.  Use discard_cleanups to remove cleanups
185    from the chain back to a given point, not doing them.  */
186
187 struct cleanup
188 {
189   struct cleanup *next;
190   void (*function) PARAMS ((PTR));
191   PTR arg;
192 };
193
194
195 /* The ability to declare that a function never returns is useful, but
196    not really required to compile GDB successfully, so the NORETURN and
197    ATTR_NORETURN macros normally expand into nothing.  */
198
199 /* If compiling with older versions of GCC, a function may be declared
200    "volatile" to indicate that it does not return.  */
201
202 #ifndef NORETURN
203 # if defined(__GNUC__) \
204      && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
205 #  define NORETURN volatile
206 # else
207 #  define NORETURN /* nothing */
208 # endif
209 #endif
210
211 /* GCC 2.5 and later versions define a function attribute "noreturn",
212    which is the preferred way to declare that a function never returns.
213    However GCC 2.7 appears to be the first version in which this fully
214    works everywhere we use it. */
215
216 #ifndef ATTR_NORETURN
217 # if defined(__GNUC__) && __GNUC__ >= 2 && __GNUC_MINOR__ >= 7
218 #  define ATTR_NORETURN __attribute__ ((noreturn))
219 # else
220 #  define ATTR_NORETURN /* nothing */
221 # endif
222 #endif
223
224 #ifndef ATTR_FORMAT
225 # if defined(__GNUC__) && __GNUC__ >= 2 && __GNUC_MINOR__ >= 4 && defined (__ANSI_PROTOTYPES)
226 #  define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
227 # else
228 #  define ATTR_FORMAT(type, x, y) /* nothing */
229 # endif
230 #endif
231
232 /* Needed for various prototypes */
233
234 #ifdef __STDC__
235 struct symtab;
236 struct breakpoint;
237 #endif
238
239 /* From blockframe.c */
240
241 extern int inside_entry_func PARAMS ((CORE_ADDR));
242
243 extern int inside_entry_file PARAMS ((CORE_ADDR addr));
244
245 extern int inside_main_func PARAMS ((CORE_ADDR pc));
246
247 /* From ch-lang.c, for the moment. (FIXME) */
248
249 extern char *chill_demangle PARAMS ((const char *));
250
251 /* From utils.c */
252
253 extern void notice_quit PARAMS ((void));
254
255 extern int strcmp_iw PARAMS ((const char *, const char *));
256
257 extern char *safe_strerror PARAMS ((int));
258
259 extern char *safe_strsignal PARAMS ((int));
260
261 extern void init_malloc PARAMS ((void *));
262
263 extern void request_quit PARAMS ((int));
264
265 extern void do_cleanups PARAMS ((struct cleanup *));
266 extern void do_final_cleanups PARAMS ((struct cleanup *));
267 extern void do_my_cleanups PARAMS ((struct cleanup **, struct cleanup *));
268 extern void do_run_cleanups PARAMS ((struct cleanup *));
269
270 extern void discard_cleanups PARAMS ((struct cleanup *));
271 extern void discard_final_cleanups PARAMS ((struct cleanup *));
272 extern void discard_my_cleanups PARAMS ((struct cleanup **, struct cleanup *));
273
274 typedef void (*make_cleanup_func) PARAMS ((void *));
275
276 extern struct cleanup *make_cleanup PARAMS ((make_cleanup_func, void *));
277
278 extern struct cleanup *make_final_cleanup PARAMS ((make_cleanup_func, void *));
279
280 extern struct cleanup *make_my_cleanup PARAMS ((struct cleanup **, 
281                                                 make_cleanup_func, void *));
282
283 extern struct cleanup *make_run_cleanup PARAMS ((make_cleanup_func, void *));
284
285 extern struct cleanup *save_cleanups PARAMS ((void));
286 extern struct cleanup *save_final_cleanups PARAMS ((void));
287 extern struct cleanup *save_my_cleanups PARAMS ((struct cleanup **));
288
289 extern void restore_cleanups PARAMS ((struct cleanup *));
290 extern void restore_final_cleanups PARAMS ((struct cleanup *));
291 extern void restore_my_cleanups PARAMS ((struct cleanup **, struct cleanup *));
292
293 extern void free_current_contents PARAMS ((char **));
294
295 extern void null_cleanup PARAMS ((PTR));
296
297 extern int myread PARAMS ((int, char *, int));
298
299 extern int query PARAMS((char *, ...))
300      ATTR_FORMAT(printf, 1, 2);
301
302 #if !defined (USE_MMALLOC)
303 extern PTR mmalloc PARAMS ((PTR, size_t));
304 extern PTR mrealloc PARAMS ((PTR, PTR, size_t));
305 extern void mfree PARAMS ((PTR, PTR));
306 #endif
307
308 /* From demangle.c */
309
310 extern void set_demangling_style PARAMS ((char *));
311
312 /* From tm.h */
313
314 struct type;
315 typedef int (use_struct_convention_fn) PARAMS ((int gcc_p, struct type *value_type));
316 extern use_struct_convention_fn generic_use_struct_convention;
317
318 typedef unsigned char *(breakpoint_from_pc_fn) PARAMS ((CORE_ADDR *pcptr, int *lenptr));
319
320
321 \f
322 /* Annotation stuff.  */
323
324 extern int annotation_level; /* in stack.c */
325 \f
326 extern void begin_line PARAMS ((void));
327
328 extern void wrap_here PARAMS ((char *));
329
330 extern void reinitialize_more_filter PARAMS ((void));
331
332 /* new */
333 enum streamtype
334 {
335   afile,
336   astring
337 };
338
339 /* new */
340 typedef struct tui_stream
341 {
342   enum streamtype ts_streamtype;
343   FILE *ts_filestream;
344   char *ts_strbuf;
345   int ts_buflen;
346 } GDB_FILE;
347
348 extern GDB_FILE *gdb_stdout;
349 extern GDB_FILE *gdb_stderr;
350
351 #if 0
352 typedef FILE GDB_FILE;
353 #define gdb_stdout stdout
354 #define gdb_stderr stderr
355 #endif
356
357 #if defined(TUI)
358 #include "tui.h"
359 #include "tuiCommand.h"
360 #include "tuiData.h"
361 #include "tuiIO.h"
362 #include "tuiLayout.h"
363 #include "tuiWin.h"
364 #endif
365
366 extern void gdb_fclose PARAMS ((GDB_FILE **));
367
368 extern void gdb_flush PARAMS ((GDB_FILE *));
369
370 extern GDB_FILE *gdb_fopen PARAMS ((char * name, char * mode));
371
372 extern void fputs_filtered PARAMS ((const char *, GDB_FILE *));
373
374 extern void fputs_unfiltered PARAMS ((const char *, GDB_FILE *));
375
376 extern int fputc_filtered PARAMS ((int c, GDB_FILE *));
377
378 extern int fputc_unfiltered PARAMS ((int c, GDB_FILE *));
379
380 extern int putchar_unfiltered PARAMS ((int c));
381
382 extern void puts_filtered PARAMS ((const char *));
383
384 extern void puts_unfiltered PARAMS ((const char *));
385
386 extern void puts_debug PARAMS ((char *prefix, char *string, char *suffix));
387
388 extern void vprintf_filtered PARAMS ((const char *, va_list))
389      ATTR_FORMAT(printf, 1, 0);
390
391 extern void vfprintf_filtered PARAMS ((GDB_FILE *, const char *, va_list))
392      ATTR_FORMAT(printf, 2, 0);
393
394 extern void fprintf_filtered PARAMS ((GDB_FILE *, const char *, ...))
395      ATTR_FORMAT(printf, 2, 3);
396
397 extern void fprintfi_filtered PARAMS ((int, GDB_FILE *, const char *, ...))
398      ATTR_FORMAT(printf, 3, 4);
399
400 extern void printf_filtered PARAMS ((const char *, ...))
401      ATTR_FORMAT(printf, 1, 2);
402
403 extern void printfi_filtered PARAMS ((int, const char *, ...))
404      ATTR_FORMAT(printf, 2, 3);
405
406 extern void vprintf_unfiltered PARAMS ((const char *, va_list))
407      ATTR_FORMAT(printf, 1, 0);
408
409 extern void vfprintf_unfiltered PARAMS ((GDB_FILE *, const char *, va_list))
410      ATTR_FORMAT(printf, 2, 0);
411
412 extern void fprintf_unfiltered PARAMS ((GDB_FILE *, const char *, ...))
413      ATTR_FORMAT(printf, 2, 3);
414
415 extern void printf_unfiltered PARAMS ((const char *, ...))
416      ATTR_FORMAT(printf, 1, 2);
417
418 extern int gdb_file_isatty PARAMS ((GDB_FILE *));
419
420 extern GDB_FILE *gdb_file_init_astring PARAMS ((int));
421
422 extern void gdb_file_deallocate PARAMS ((GDB_FILE **));
423
424 extern char *gdb_file_get_strbuf PARAMS ((GDB_FILE *));
425
426 extern void gdb_file_adjust_strbuf PARAMS ((int, GDB_FILE *));
427
428 extern void print_spaces PARAMS ((int, GDB_FILE *));
429
430 extern void print_spaces_filtered PARAMS ((int, GDB_FILE *));
431
432 extern char *n_spaces PARAMS ((int));
433
434 extern void gdb_printchar PARAMS ((int, GDB_FILE *, int));
435
436 extern void gdb_print_address PARAMS ((void *, GDB_FILE *));
437
438 typedef bfd_vma t_addr;
439 typedef bfd_vma t_reg;
440 extern char* paddr PARAMS ((t_addr addr));
441
442 extern char* preg PARAMS ((t_reg reg));
443
444 extern char* paddr_nz PARAMS ((t_addr addr));
445
446 extern char* preg_nz PARAMS ((t_reg reg));
447
448 extern void fprintf_symbol_filtered PARAMS ((GDB_FILE *, char *,
449                                              enum language, int));
450
451 extern NORETURN void perror_with_name PARAMS ((char *)) ATTR_NORETURN;
452
453 extern void print_sys_errmsg PARAMS ((char *, int));
454
455 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
456    "const char *" in unistd.h, so we can't declare the argument
457    as "char *".  */
458
459 extern char *re_comp PARAMS ((const char *));
460
461 /* From symfile.c */
462
463 extern void symbol_file_command PARAMS ((char *, int));
464
465 /* From top.c */
466
467 extern char *skip_quoted PARAMS ((char *));
468
469 extern char *gdb_readline PARAMS ((char *));
470
471 extern char *command_line_input PARAMS ((char *, int, char *));
472
473 extern void print_prompt PARAMS ((void));
474
475 extern int input_from_terminal_p PARAMS ((void));
476
477 extern int info_verbose;
478
479 /* From printcmd.c */
480
481 extern void set_next_address PARAMS ((CORE_ADDR));
482
483 extern void print_address_symbolic PARAMS ((CORE_ADDR, GDB_FILE *, int,
484                                             char *));
485
486 extern void print_address_numeric PARAMS ((CORE_ADDR, int, GDB_FILE *));
487
488 extern void print_address PARAMS ((CORE_ADDR, GDB_FILE *));
489
490 /* From source.c */
491
492 extern int openp PARAMS ((char *, int, char *, int, int, char **));
493
494 extern int source_full_path_of PARAMS ((char *, char **));
495
496 extern void mod_path PARAMS ((char *, char **));
497
498 extern void directory_command PARAMS ((char *, int));
499
500 extern void init_source_path PARAMS ((void));
501
502 extern char *symtab_to_filename PARAMS ((struct symtab *));
503
504 /* From findvar.c */
505
506 extern int read_relative_register_raw_bytes PARAMS ((int, char *));
507
508 #if 0
509 /* From readline (but not in any readline .h files).  */
510
511 extern char *tilde_expand PARAMS ((char *));
512 #endif
513
514 /* Control types for commands */
515
516 enum misc_command_type
517 {
518   ok_command,
519   end_command,
520   else_command,
521   nop_command
522 };
523
524 enum command_control_type
525 {
526   simple_control,
527   break_control,
528   continue_control,
529   while_control,
530   if_control,
531   invalid_control
532 };
533
534 /* Structure for saved commands lines
535    (for breakpoints, defined commands, etc).  */
536
537 struct command_line
538 {
539   struct command_line *next;
540   char *line;
541   enum command_control_type control_type;
542   int body_count;
543   struct command_line **body_list;
544 };
545
546 extern struct command_line *read_command_lines PARAMS ((char *, int));
547
548 extern void free_command_lines PARAMS ((struct command_line **));
549
550 /* String containing the current directory (what getwd would return).  */
551
552 extern char *current_directory;
553
554 /* Default radixes for input and output.  Only some values supported.  */
555 extern unsigned input_radix;
556 extern unsigned output_radix;
557
558 /* Possibilities for prettyprint parameters to routines which print
559    things.  Like enum language, this should be in value.h, but needs
560    to be here for the same reason.  FIXME:  If we can eliminate this
561    as an arg to LA_VAL_PRINT, then we can probably move it back to
562    value.h. */
563
564 enum val_prettyprint
565 {
566   Val_no_prettyprint = 0,
567   Val_prettyprint,
568   /* Use the default setting which the user has specified.  */
569   Val_pretty_default
570 };
571
572 \f
573 /* Host machine definition.  This will be a symlink to one of the
574    xm-*.h files, built by the `configure' script.  */
575
576 #include "xm.h"
577
578 /* Native machine support.  This will be a symlink to one of the
579    nm-*.h files, built by the `configure' script.  */
580
581 #include "nm.h"
582
583 /* Target machine definition.  This will be a symlink to one of the
584    tm-*.h files, built by the `configure' script.  */
585
586 #include "tm.h"
587
588 /* If the xm.h file did not define the mode string used to open the
589    files, assume that binary files are opened the same way as text
590    files */
591 #ifndef FOPEN_RB
592 #include "fopen-same.h"
593 #endif
594
595 /* Microsoft C can't deal with const pointers */
596
597 #ifdef _MSC_VER
598 #define CONST_PTR
599 #else
600 #define CONST_PTR const
601 #endif
602
603 /*
604  * Allow things in gdb to be declared "volatile".  If compiling ANSI, it
605  * just works.  If compiling with gcc but non-ansi, redefine to __volatile__.
606  * If non-ansi, non-gcc, then eliminate "volatile" entirely, making those
607  * objects be read-write rather than read-only.
608  */
609
610 #ifndef volatile
611 #ifndef __STDC__
612 # ifdef __GNUC__
613 #  define volatile __volatile__
614 # else
615 #  define volatile /*nothing*/
616 # endif /* GNUC */
617 #endif /* STDC */
618 #endif /* volatile */
619
620 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
621    FIXME: Assumes 2's complement arithmetic */
622
623 #if !defined (UINT_MAX)
624 #define UINT_MAX ((unsigned int)(~0))           /* 0xFFFFFFFF for 32-bits */
625 #endif
626
627 #if !defined (INT_MAX)
628 #define INT_MAX ((int)(UINT_MAX >> 1))          /* 0x7FFFFFFF for 32-bits */
629 #endif
630
631 #if !defined (INT_MIN)
632 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
633 #endif
634
635 #if !defined (ULONG_MAX)
636 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
637 #endif
638
639 #if !defined (LONG_MAX)
640 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
641 #endif
642
643 #ifndef LONGEST
644
645 #ifdef BFD64
646
647 /* This is to make sure that LONGEST is at least as big as CORE_ADDR.  */
648
649 #define LONGEST BFD_HOST_64_BIT
650 #define ULONGEST BFD_HOST_U_64_BIT
651
652 #else /* No BFD64 */
653
654 #  ifdef CC_HAS_LONG_LONG
655 #    define LONGEST long long
656 #    define ULONGEST unsigned long long
657 #  else
658 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
659    (e.g. i386-windows) so try it.  */
660 #    ifdef BFD_HOST_64_BIT
661 #      define LONGEST BFD_HOST_64_BIT
662 #      define ULONGEST BFD_HOST_U_64_BIT
663 #    else
664 #      define LONGEST long
665 #      define ULONGEST unsigned long
666 #    endif
667 #  endif
668
669 #endif /* No BFD64 */
670
671 #endif /* ! LONGEST */
672
673 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
674    arguments to a function, number in a value history, register number, etc.)
675    where the value must not be larger than can fit in an int.  */
676
677 extern int longest_to_int PARAMS ((LONGEST));
678
679 /* Assorted functions we can declare, now that const and volatile are 
680    defined.  */
681
682 extern char *savestring PARAMS ((const char *, int));
683
684 extern char *msavestring PARAMS ((void *, const char *, int));
685
686 extern char *strsave PARAMS ((const char *));
687
688 extern char *mstrsave PARAMS ((void *, const char *));
689
690 #ifdef _MSC_VER /* FIXME; was long, but this causes compile errors in msvc if already defined */
691 extern PTR xmmalloc PARAMS ((PTR, size_t));
692
693 extern PTR xmrealloc PARAMS ((PTR, PTR, size_t));
694 #else
695 extern PTR xmmalloc PARAMS ((PTR, long));
696
697 extern PTR xmrealloc PARAMS ((PTR, PTR, long));
698 #endif
699
700 extern int parse_escape PARAMS ((char **));
701
702 /* compat - handle old targets that just define REGISTER_NAMES */
703 #ifndef REGISTER_NAME
704 extern char *gdb_register_names[];
705 #define REGISTER_NAME(i) gdb_register_names[i]
706 #endif
707
708 /* Message to be printed before the error message, when an error occurs.  */
709
710 extern char *error_pre_print;
711
712 /* Message to be printed before the error message, when an error occurs.  */
713
714 extern char *quit_pre_print;
715
716 /* Message to be printed before the warning message, when a warning occurs.  */
717
718 extern char *warning_pre_print;
719
720 extern NORETURN void error PARAMS((const char *, ...)) ATTR_NORETURN;
721
722 extern void error_begin PARAMS ((void));
723
724 extern NORETURN void fatal PARAMS((char *, ...)) ATTR_NORETURN;
725
726 extern NORETURN void nomem PARAMS ((long)) ATTR_NORETURN;
727
728 /* Reasons for calling return_to_top_level.  */
729 enum return_reason {
730   /* User interrupt.  */
731   RETURN_QUIT,
732
733   /* Any other error.  */
734   RETURN_ERROR
735 };
736
737 #define RETURN_MASK_QUIT (1 << (int)RETURN_QUIT)
738 #define RETURN_MASK_ERROR (1 << (int)RETURN_ERROR)
739 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
740 typedef int return_mask;
741
742 extern NORETURN void
743 return_to_top_level PARAMS ((enum return_reason)) ATTR_NORETURN;
744
745 typedef int (catch_errors_ftype) PARAMS ((PTR));
746 extern int catch_errors PARAMS ((catch_errors_ftype *, PTR, char *, return_mask));
747
748 extern void warning_begin PARAMS ((void));
749
750 extern void warning PARAMS ((const char *, ...))
751      ATTR_FORMAT(printf, 1, 2);
752
753 /* Global functions from other, non-gdb GNU thingies.
754    Libiberty thingies are no longer declared here.  We include libiberty.h
755    above, instead.  */
756
757 #ifndef GETENV_PROVIDED
758 extern char *getenv PARAMS ((const char *));
759 #endif
760
761 /* From other system libraries */
762
763 #ifdef HAVE_STDDEF_H
764 #include <stddef.h>
765 #endif
766
767 #ifdef HAVE_STDLIB_H
768 #if defined(_MSC_VER) && !defined(__cplusplus)
769 /* msvc defines these in stdlib.h for c code */
770 #undef min
771 #undef max
772 #endif
773 #include <stdlib.h>
774 #endif
775 #ifndef min
776 #define min(a, b) ((a) < (b) ? (a) : (b))
777 #endif
778 #ifndef max
779 #define max(a, b) ((a) > (b) ? (a) : (b))
780 #endif
781
782
783 /* We take the address of fclose later, but some stdio's forget
784    to declare this.  We can't always declare it since there's
785    no way to declare the parameters without upsetting some compiler
786    somewhere. */
787
788 #ifndef FCLOSE_PROVIDED
789 extern int fclose PARAMS ((FILE *));
790 #endif
791
792 #ifndef atof
793 extern double atof PARAMS ((const char *));     /* X3.159-1989  4.10.1.1 */
794 #endif
795
796 #ifndef MALLOC_INCOMPATIBLE
797
798 #ifdef NEED_DECLARATION_MALLOC
799 extern PTR malloc ();
800 #endif
801
802 #ifdef NEED_DECLARATION_REALLOC
803 extern PTR realloc ();
804 #endif
805
806 #ifdef NEED_DECLARATION_FREE
807 extern void free ();
808 #endif
809
810 #endif /* MALLOC_INCOMPATIBLE */
811
812 /* Various possibilities for alloca.  */
813 #ifndef alloca
814 # ifdef __GNUC__
815 #  define alloca __builtin_alloca
816 # else /* Not GNU C */
817 #  ifdef HAVE_ALLOCA_H
818 #   include <alloca.h>
819 #  else
820 #   ifdef _AIX
821  #pragma alloca
822 #   else
823
824 /* We need to be careful not to declare this in a way which conflicts with
825    bison.  Bison never declares it as char *, but under various circumstances
826    (like __hpux) we need to use void *.  */
827 #    if defined (__STDC__) || defined (__hpux)
828    extern void *alloca ();
829 #    else /* Don't use void *.  */
830    extern char *alloca ();
831 #    endif /* Don't use void *.  */
832 #   endif /* Not _AIX */
833 #  endif /* Not HAVE_ALLOCA_H */
834 # endif /* Not GNU C */
835 #endif /* alloca not defined */
836
837 /* HOST_BYTE_ORDER must be defined to one of these.  */
838
839 #ifdef HAVE_ENDIAN_H
840 #include <endian.h>
841 #endif
842
843 #if !defined (BIG_ENDIAN)
844 #define BIG_ENDIAN 4321
845 #endif
846
847 #if !defined (LITTLE_ENDIAN)
848 #define LITTLE_ENDIAN 1234
849 #endif
850
851 /* Dynamic target-system-dependent parameters for GDB. */
852 #include "gdbarch.h"
853
854 /* Static target-system-dependent parameters for GDB. */
855
856 /* Number of bits in a char or unsigned char for the target machine.
857    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
858 #if !defined (TARGET_CHAR_BIT)
859 #define TARGET_CHAR_BIT 8
860 #endif
861
862 /* Number of bits in a short or unsigned short for the target machine. */
863 #if !defined (TARGET_SHORT_BIT)
864 #define TARGET_SHORT_BIT (2 * TARGET_CHAR_BIT)
865 #endif
866
867 /* Number of bits in an int or unsigned int for the target machine. */
868 #if !defined (TARGET_INT_BIT)
869 #define TARGET_INT_BIT (4 * TARGET_CHAR_BIT)
870 #endif
871
872 /* Number of bits in a long or unsigned long for the target machine. */
873 #if !defined (TARGET_LONG_BIT)
874 #define TARGET_LONG_BIT (4 * TARGET_CHAR_BIT)
875 #endif
876
877 /* Number of bits in a long long or unsigned long long for the target machine. */
878 #if !defined (TARGET_LONG_LONG_BIT)
879 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
880 #endif
881
882 /* Number of bits in a float for the target machine. */
883 #if !defined (TARGET_FLOAT_BIT)
884 #define TARGET_FLOAT_BIT (4 * TARGET_CHAR_BIT)
885 #endif
886
887 /* Number of bits in a double for the target machine. */
888 #if !defined (TARGET_DOUBLE_BIT)
889 #define TARGET_DOUBLE_BIT (8 * TARGET_CHAR_BIT)
890 #endif
891
892 /* Number of bits in a long double for the target machine.  */
893 #if !defined (TARGET_LONG_DOUBLE_BIT)
894 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
895 #endif
896
897 /* Number of bits in a pointer for the target machine */
898 #if !defined (TARGET_PTR_BIT)
899 #define TARGET_PTR_BIT TARGET_INT_BIT
900 #endif
901
902 /* If we picked up a copy of CHAR_BIT from a configuration file
903    (which may get it by including <limits.h>) then use it to set
904    the number of bits in a host char.  If not, use the same size
905    as the target. */
906
907 #if defined (CHAR_BIT)
908 #define HOST_CHAR_BIT CHAR_BIT
909 #else
910 #define HOST_CHAR_BIT TARGET_CHAR_BIT
911 #endif
912
913 /* The bit byte-order has to do just with numbering of bits in
914    debugging symbols and such.  Conceptually, it's quite separate
915    from byte/word byte order.  */
916
917 #if !defined (BITS_BIG_ENDIAN)
918 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
919 #endif
920
921 /* In findvar.c.  */
922
923 extern LONGEST extract_signed_integer PARAMS ((void *, int));
924
925 extern ULONGEST extract_unsigned_integer PARAMS ((void *, int));
926
927 extern int extract_long_unsigned_integer PARAMS ((void *, int, LONGEST *));
928
929 extern CORE_ADDR extract_address PARAMS ((void *, int));
930
931 extern void store_signed_integer PARAMS ((PTR, int, LONGEST));
932
933 extern void store_unsigned_integer PARAMS ((PTR, int, ULONGEST));
934
935 extern void store_address PARAMS ((PTR, int, LONGEST));
936
937 /* Setup definitions for host and target floating point formats.  We need to
938    consider the format for `float', `double', and `long double' for both target
939    and host.  We need to do this so that we know what kind of conversions need
940    to be done when converting target numbers to and from the hosts DOUBLEST
941    data type.  */
942
943 /* This is used to indicate that we don't know the format of the floating point
944    number.  Typically, this is useful for native ports, where the actual format
945    is irrelevant, since no conversions will be taking place.  */
946
947 extern const struct floatformat floatformat_unknown;
948
949 #if HOST_BYTE_ORDER == BIG_ENDIAN
950 #  ifndef HOST_FLOAT_FORMAT
951 #    define HOST_FLOAT_FORMAT &floatformat_ieee_single_big
952 #  endif
953 #  ifndef HOST_DOUBLE_FORMAT
954 #    define HOST_DOUBLE_FORMAT &floatformat_ieee_double_big
955 #  endif
956 #else                           /* LITTLE_ENDIAN */
957 #  ifndef HOST_FLOAT_FORMAT
958 #    define HOST_FLOAT_FORMAT &floatformat_ieee_single_little
959 #  endif
960 #  ifndef HOST_DOUBLE_FORMAT
961 #    define HOST_DOUBLE_FORMAT &floatformat_ieee_double_little
962 #  endif
963 #endif
964
965 #ifndef HOST_LONG_DOUBLE_FORMAT
966 #define HOST_LONG_DOUBLE_FORMAT &floatformat_unknown
967 #endif
968
969 #ifndef TARGET_FLOAT_FORMAT
970 #define TARGET_FLOAT_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
971                              ? &floatformat_ieee_single_big \
972                              : &floatformat_ieee_single_little)
973 #endif
974 #ifndef TARGET_DOUBLE_FORMAT
975 #define TARGET_DOUBLE_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
976                               ? &floatformat_ieee_double_big \
977                               : &floatformat_ieee_double_little)
978 #endif
979
980 #ifndef TARGET_LONG_DOUBLE_FORMAT
981 #  define TARGET_LONG_DOUBLE_FORMAT &floatformat_unknown
982 #endif
983
984 /* Use `long double' if the host compiler supports it.  (Note that this is not
985    necessarily any longer than `double'.  On SunOS/gcc, it's the same as
986    double.)  This is necessary because GDB internally converts all floating
987    point values to the widest type supported by the host.
988
989    There are problems however, when the target `long double' is longer than the
990    host's `long double'.  In general, we'll probably reduce the precision of
991    any such values and print a warning.  */
992
993 #ifdef HAVE_LONG_DOUBLE
994 typedef long double DOUBLEST;
995 #else
996 typedef double DOUBLEST;
997 #endif
998
999 extern void floatformat_to_doublest PARAMS ((const struct floatformat *,
1000                                              char *, DOUBLEST *));
1001 extern void floatformat_from_doublest PARAMS ((const struct floatformat *,
1002                                                DOUBLEST *, char *));
1003 extern DOUBLEST extract_floating PARAMS ((void *, int));
1004
1005 extern void store_floating PARAMS ((void *, int, DOUBLEST));
1006 \f
1007 /* On some machines there are bits in addresses which are not really
1008    part of the address, but are used by the kernel, the hardware, etc.
1009    for special purposes.  ADDR_BITS_REMOVE takes out any such bits
1010    so we get a "real" address such as one would find in a symbol
1011    table.  This is used only for addresses of instructions, and even then
1012    I'm not sure it's used in all contexts.  It exists to deal with there
1013    being a few stray bits in the PC which would mislead us, not as some sort
1014    of generic thing to handle alignment or segmentation (it's possible it
1015    should be in TARGET_READ_PC instead).  */
1016 #if !defined (ADDR_BITS_REMOVE)
1017 #define ADDR_BITS_REMOVE(addr) (addr)
1018 #endif /* No ADDR_BITS_REMOVE.  */
1019
1020 /* From valops.c */
1021
1022 extern CORE_ADDR push_bytes PARAMS ((CORE_ADDR, char *, int));
1023
1024 extern CORE_ADDR push_word PARAMS ((CORE_ADDR, ULONGEST));
1025
1026 /* Some parts of gdb might be considered optional, in the sense that they
1027    are not essential for being able to build a working, usable debugger
1028    for a specific environment.  For example, the maintenance commands
1029    are there for the benefit of gdb maintainers.  As another example,
1030    some environments really don't need gdb's that are able to read N
1031    different object file formats.  In order to make it possible (but
1032    not necessarily recommended) to build "stripped down" versions of
1033    gdb, the following defines control selective compilation of those
1034    parts of gdb which can be safely left out when necessary.  Note that
1035    the default is to include everything. */
1036
1037 #ifndef MAINTENANCE_CMDS
1038 #define MAINTENANCE_CMDS 1
1039 #endif
1040
1041 #ifdef MAINTENANCE_CMDS
1042 extern int watchdog;
1043 #endif
1044
1045 /* Hooks for alternate command interfaces.  */
1046
1047 #ifdef __STDC__
1048 struct target_waitstatus;
1049 struct cmd_list_element;
1050 #endif
1051
1052 extern void (*init_ui_hook) PARAMS ((char *argv0));
1053 extern void (*command_loop_hook) PARAMS ((void));
1054 extern void (*fputs_unfiltered_hook) PARAMS ((const char *linebuffer,
1055                                               GDB_FILE *stream));
1056 extern void (*print_frame_info_listing_hook) PARAMS ((struct symtab *s,
1057                                                       int line, int stopline,
1058                                                       int noerror));
1059 extern struct frame_info *parse_frame_specification PARAMS ((char *frame_exp));
1060 extern int  (*query_hook) PARAMS ((const char *, va_list));
1061 extern void (*warning_hook) PARAMS ((const char *, va_list));
1062 extern void (*flush_hook) PARAMS ((GDB_FILE *stream));
1063 extern void (*create_breakpoint_hook) PARAMS ((struct breakpoint *b));
1064 extern void (*delete_breakpoint_hook) PARAMS ((struct breakpoint *bpt));
1065 extern void (*modify_breakpoint_hook) PARAMS ((struct breakpoint *bpt));
1066 extern void (*target_output_hook) PARAMS ((char *));
1067 extern void (*interactive_hook) PARAMS ((void));
1068 extern void (*registers_changed_hook) PARAMS ((void));
1069 extern void (*readline_begin_hook) PARAMS ((char *, ...));
1070 extern char * (*readline_hook) PARAMS ((char *));
1071 extern void (*readline_end_hook) PARAMS ((void));
1072 extern void (*register_changed_hook) PARAMS ((int regno));
1073 extern void (*memory_changed_hook) PARAMS ((CORE_ADDR addr, int len));
1074 extern void (*context_hook) PARAMS ((int));
1075 extern int (*target_wait_hook) PARAMS ((int pid,
1076                                         struct target_waitstatus *status));
1077
1078 extern void (*call_command_hook) PARAMS ((struct cmd_list_element *c,
1079                                           char *cmd, int from_tty));
1080
1081 extern NORETURN void (*error_hook) PARAMS ((void)) ATTR_NORETURN;
1082
1083 extern void (*error_begin_hook) PARAMS ((void));
1084
1085
1086 /* Inhibit window interface if non-zero. */
1087
1088 extern int use_windows;
1089
1090 /* Symbolic definitions of filename-related things.  */
1091 /* FIXME, this doesn't work very well if host and executable
1092    filesystems conventions are different.  */
1093
1094 #ifndef DIRNAME_SEPARATOR
1095 #define DIRNAME_SEPARATOR ':'
1096 #endif
1097
1098 #ifndef SLASH_P
1099 #if defined(__GO32__)||defined(_WIN32)
1100 #define SLASH_P(X) ((X)=='\\')
1101 #else
1102 #define SLASH_P(X) ((X)=='/')
1103 #endif
1104 #endif
1105
1106 #ifndef SLASH_CHAR
1107 #if defined(__GO32__)||defined(_WIN32)
1108 #define SLASH_CHAR '\\'
1109 #else
1110 #define SLASH_CHAR '/'
1111 #endif
1112 #endif
1113
1114 #ifndef SLASH_STRING
1115 #if defined(__GO32__)||defined(_WIN32)
1116 #define SLASH_STRING "\\"
1117 #else
1118 #define SLASH_STRING "/"
1119 #endif
1120 #endif
1121
1122 #ifndef ROOTED_P
1123 #define ROOTED_P(X) (SLASH_P((X)[0]))
1124 #endif
1125
1126 /* On some systems, PIDGET is defined to extract the inferior pid from
1127    an internal pid that has the thread id and pid in seperate bit
1128    fields.  If not defined, then just use the entire internal pid as
1129    the actual pid. */
1130
1131 #ifndef PIDGET
1132 #define PIDGET(pid) (pid)
1133 #endif
1134
1135 /* If under Cygwin, provide backwards compatibility with older
1136    Cygwin compilers that don't define the current cpp define. */
1137 #ifdef __CYGWIN32__
1138 #ifndef __CYGWIN__
1139 #define __CYGWIN__
1140 #endif
1141 #endif
1142
1143 #endif /* #ifndef DEFS_H */