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