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