Multiarch TARGET_FLOAT_FORMAT, TARGET_DOUBLE_FORMAT,
[deliverable/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_close (int fd);
336
337 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
338
339 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
340
341 extern struct cleanup *make_my_cleanup (struct cleanup **,
342 make_cleanup_ftype *, void *);
343
344 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
345
346 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
347 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
348
349 extern struct cleanup *save_cleanups (void);
350 extern struct cleanup *save_final_cleanups (void);
351 extern struct cleanup *save_my_cleanups (struct cleanup **);
352
353 extern void restore_cleanups (struct cleanup *);
354 extern void restore_final_cleanups (struct cleanup *);
355 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
356
357 extern void free_current_contents (void *);
358
359 extern void null_cleanup (void *);
360
361 extern int myread (int, char *, int);
362
363 extern int query (char *, ...) ATTR_FORMAT (printf, 1, 2);
364
365 #if !defined (USE_MMALLOC)
366 /* NOTE: cagney/2000-03-04: The mmalloc functions need to use PTR
367 rather than void* so that they are consistent with
368 ../mmalloc/mmalloc.h. */
369 extern PTR mcalloc (PTR, size_t, size_t);
370 extern PTR mmalloc (PTR, size_t);
371 extern PTR mrealloc (PTR, PTR, size_t);
372 extern void mfree (PTR, PTR);
373 #endif
374
375 extern void init_page_info (void);
376
377 /* From demangle.c */
378
379 extern void set_demangling_style (char *);
380
381 /* From tm.h */
382
383 struct type;
384 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
385 extern use_struct_convention_fn generic_use_struct_convention;
386
387 typedef unsigned char *(breakpoint_from_pc_fn) (CORE_ADDR * pcptr, int *lenptr);
388 \f
389 /* Annotation stuff. */
390
391 extern int annotation_level; /* in stack.c */
392 \f
393 extern void begin_line (void);
394
395 extern void wrap_here (char *);
396
397 extern void reinitialize_more_filter (void);
398
399 /* Normal results */
400 extern struct ui_file *gdb_stdout;
401 /* Serious error notifications */
402 extern struct ui_file *gdb_stderr;
403 /* Log/debug/trace messages that should bypass normal stdout/stderr
404 filtering. For momement, always call this stream using
405 *_unfiltered. In the very near future that restriction shall be
406 removed - either call shall be unfiltered. (cagney 1999-06-13). */
407 extern struct ui_file *gdb_stdlog;
408 /* Target output that should bypass normal stdout/stderr filtering.
409 For momement, always call this stream using *_unfiltered. In the
410 very near future that restriction shall be removed - either call
411 shall be unfiltered. (cagney 1999-07-02). */
412 extern struct ui_file *gdb_stdtarg;
413
414 #if defined(TUI)
415 #include "tui.h"
416 #include "tuiCommand.h"
417 #include "tuiData.h"
418 #include "tuiIO.h"
419 #include "tuiLayout.h"
420 #include "tuiWin.h"
421 #endif
422
423 #include "ui-file.h"
424
425 /* More generic printf like operations */
426
427 extern void fputs_filtered (const char *, struct ui_file *);
428
429 extern void fputs_unfiltered (const char *, struct ui_file *);
430
431 extern int fputc_filtered (int c, struct ui_file *);
432
433 extern int fputc_unfiltered (int c, struct ui_file *);
434
435 extern int putchar_unfiltered (int c);
436
437 extern void puts_filtered (const char *);
438
439 extern void puts_unfiltered (const char *);
440
441 extern void puts_debug (char *prefix, char *string, char *suffix);
442
443 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
444
445 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
446
447 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
448
449 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
450
451 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
452
453 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
454
455 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
456
457 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
458
459 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
460
461 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
462
463 extern void print_spaces (int, struct ui_file *);
464
465 extern void print_spaces_filtered (int, struct ui_file *);
466
467 extern char *n_spaces (int);
468
469 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
470
471 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
472
473 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
474
475 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
476 extern void gdb_print_host_address (void *addr, struct ui_file *stream);
477
478 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
479 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
480 for ``%*''. */
481 extern int strlen_paddr (void);
482 extern char *paddr (CORE_ADDR addr);
483 extern char *paddr_nz (CORE_ADDR addr);
484 extern char *paddr_u (CORE_ADDR addr);
485 extern char *paddr_d (LONGEST addr);
486
487 extern char *phex (ULONGEST l, int sizeof_l);
488 extern char *phex_nz (ULONGEST l, int sizeof_l);
489
490 extern void fprintf_symbol_filtered (struct ui_file *, char *,
491 enum language, int);
492
493 extern NORETURN void perror_with_name (char *) ATTR_NORETURN;
494
495 extern void print_sys_errmsg (char *, int);
496
497 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
498 "const char *" in unistd.h, so we can't declare the argument
499 as "char *". */
500
501 extern char *re_comp (const char *);
502
503 /* From symfile.c */
504
505 extern void symbol_file_command (char *, int);
506
507 /* Remote targets may wish to use this as their load function. */
508 extern void generic_load (char *name, int from_tty);
509
510 /* Summarise a download */
511 extern void print_transfer_performance (struct ui_file *stream,
512 unsigned long data_count,
513 unsigned long write_count,
514 unsigned long time_count);
515
516 /* From top.c */
517
518 typedef void initialize_file_ftype (void);
519
520 extern char *skip_quoted (char *);
521
522 extern char *gdb_readline (char *);
523
524 extern char *command_line_input (char *, int, char *);
525
526 extern void print_prompt (void);
527
528 extern int input_from_terminal_p (void);
529
530 extern int info_verbose;
531
532 /* From printcmd.c */
533
534 extern void set_next_address (CORE_ADDR);
535
536 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
537 char *);
538
539 extern int build_address_symbolic (CORE_ADDR addr,
540 int do_demangle,
541 char **name,
542 int *offset,
543 char **filename,
544 int *line,
545 int *unmapped);
546
547 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
548
549 extern void print_address (CORE_ADDR, struct ui_file *);
550
551 /* From source.c */
552
553 extern int openp (char *, int, char *, int, int, char **);
554
555 extern int source_full_path_of (char *, char **);
556
557 extern void mod_path (char *, char **);
558
559 extern void directory_command (char *, int);
560
561 extern void init_source_path (void);
562
563 extern char *symtab_to_filename (struct symtab *);
564
565 /* From exec.c */
566
567 extern void exec_set_section_offsets (bfd_signed_vma text_off,
568 bfd_signed_vma data_off,
569 bfd_signed_vma bss_off);
570
571 /* From findvar.c */
572
573 extern int read_relative_register_raw_bytes (int, char *);
574
575 /* Possible lvalue types. Like enum language, this should be in
576 value.h, but needs to be here for the same reason. */
577
578 enum lval_type
579 {
580 /* Not an lval. */
581 not_lval,
582 /* In memory. Could be a saved register. */
583 lval_memory,
584 /* In a register. */
585 lval_register,
586 /* In a gdb internal variable. */
587 lval_internalvar,
588 /* Part of a gdb internal variable (structure field). */
589 lval_internalvar_component,
590 /* In a register series in a frame not the current one, which may have been
591 partially saved or saved in different places (otherwise would be
592 lval_register or lval_memory). */
593 lval_reg_frame_relative
594 };
595
596 struct frame_info;
597
598 void default_get_saved_register (char *raw_buffer, int *optimized,
599 CORE_ADDR * addrp,
600 struct frame_info *frame, int regnum,
601 enum lval_type *lval);
602
603 /* From readline (but not in any readline .h files). */
604
605 extern char *tilde_expand (char *);
606
607 /* Control types for commands */
608
609 enum misc_command_type
610 {
611 ok_command,
612 end_command,
613 else_command,
614 nop_command
615 };
616
617 enum command_control_type
618 {
619 simple_control,
620 break_control,
621 continue_control,
622 while_control,
623 if_control,
624 invalid_control
625 };
626
627 /* Structure for saved commands lines
628 (for breakpoints, defined commands, etc). */
629
630 struct command_line
631 {
632 struct command_line *next;
633 char *line;
634 enum command_control_type control_type;
635 int body_count;
636 struct command_line **body_list;
637 };
638
639 extern struct command_line *read_command_lines (char *, int);
640
641 extern void free_command_lines (struct command_line **);
642
643 /* To continue the execution commands when running gdb asynchronously.
644 A continuation structure contains a pointer to a function to be called
645 to finish the command, once the target has stopped. Such mechanism is
646 used bt the finish and until commands, and in the remote protocol
647 when opening an extended-remote connection. */
648
649 struct continuation_arg
650 {
651 struct continuation_arg *next;
652 union continuation_data {
653 void *pointer;
654 int integer;
655 long longint;
656 } data;
657 };
658
659 struct continuation
660 {
661 void (*continuation_hook) (struct continuation_arg *);
662 struct continuation_arg *arg_list;
663 struct continuation *next;
664 };
665 struct continuation continuation;
666
667 /* In infrun.c. */
668 extern struct continuation *cmd_continuation;
669 /* Used only by the step_1 function. */
670 extern struct continuation *intermediate_continuation;
671
672 /* From utils.c */
673 extern void add_continuation (void (*)(struct continuation_arg *),
674 struct continuation_arg *);
675 extern void do_all_continuations (void);
676 extern void discard_all_continuations (void);
677
678 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
679 struct continuation_arg *);
680 extern void do_all_intermediate_continuations (void);
681 extern void discard_all_intermediate_continuations (void);
682
683 /* String containing the current directory (what getwd would return). */
684
685 extern char *current_directory;
686
687 /* Default radixes for input and output. Only some values supported. */
688 extern unsigned input_radix;
689 extern unsigned output_radix;
690
691 /* Possibilities for prettyprint parameters to routines which print
692 things. Like enum language, this should be in value.h, but needs
693 to be here for the same reason. FIXME: If we can eliminate this
694 as an arg to LA_VAL_PRINT, then we can probably move it back to
695 value.h. */
696
697 enum val_prettyprint
698 {
699 Val_no_prettyprint = 0,
700 Val_prettyprint,
701 /* Use the default setting which the user has specified. */
702 Val_pretty_default
703 };
704 \f
705
706 /* Host machine definition. This will be a symlink to one of the
707 xm-*.h files, built by the `configure' script. */
708
709 #include "xm.h"
710
711 /* Native machine support. This will be a symlink to one of the
712 nm-*.h files, built by the `configure' script. */
713
714 #include "nm.h"
715
716 /* Target machine definition. This will be a symlink to one of the
717 tm-*.h files, built by the `configure' script. */
718
719 #include "tm.h"
720
721 /* If the xm.h file did not define the mode string used to open the
722 files, assume that binary files are opened the same way as text
723 files */
724 #ifndef FOPEN_RB
725 #include "fopen-same.h"
726 #endif
727
728 /* Microsoft C can't deal with const pointers */
729
730 #ifdef _MSC_VER
731 #define CONST_PTR
732 #else
733 #define CONST_PTR const
734 #endif
735
736 /*
737 * Allow things in gdb to be declared "volatile". If compiling ANSI, it
738 * just works. If compiling with gcc but non-ansi, redefine to __volatile__.
739 * If non-ansi, non-gcc, then eliminate "volatile" entirely, making those
740 * objects be read-write rather than read-only.
741 */
742
743 #ifndef volatile
744 #ifndef __STDC__
745 #ifdef __GNUC__
746 #define volatile __volatile__
747 #else
748 #define volatile /* nothing */
749 #endif /* GNUC */
750 #endif /* STDC */
751 #endif /* volatile */
752
753 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
754 FIXME: Assumes 2's complement arithmetic */
755
756 #if !defined (UINT_MAX)
757 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
758 #endif
759
760 #if !defined (INT_MAX)
761 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
762 #endif
763
764 #if !defined (INT_MIN)
765 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
766 #endif
767
768 #if !defined (ULONG_MAX)
769 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
770 #endif
771
772 #if !defined (LONG_MAX)
773 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
774 #endif
775
776 #if !defined (ULONGEST_MAX)
777 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 32-bits */
778 #endif
779
780 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 32-bits */
781 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
782 #endif
783
784 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
785 arguments to a function, number in a value history, register number, etc.)
786 where the value must not be larger than can fit in an int. */
787
788 extern int longest_to_int (LONGEST);
789
790 /* Assorted functions we can declare, now that const and volatile are
791 defined. */
792
793 extern char *savestring (const char *, int);
794
795 extern char *msavestring (void *, const char *, int);
796
797 extern char *strsave (const char *);
798
799 extern char *mstrsave (void *, const char *);
800
801 /* FIXME; was long, but this causes compile errors in msvc if already
802 defined */
803 #ifdef _MSC_VER
804 extern PTR xmmalloc (PTR, size_t);
805 extern PTR xmrealloc (PTR, PTR, size_t);
806 #else
807 extern PTR xmmalloc (PTR, long);
808 extern PTR xmrealloc (PTR, PTR, long);
809 #endif
810
811 extern int parse_escape (char **);
812
813 /* Message to be printed before the error message, when an error occurs. */
814
815 extern char *error_pre_print;
816
817 /* Message to be printed before the error message, when an error occurs. */
818
819 extern char *quit_pre_print;
820
821 /* Message to be printed before the warning message, when a warning occurs. */
822
823 extern char *warning_pre_print;
824
825 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
826
827 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN;
828
829 /* DEPRECATED: Use error(), verror() or error_stream(). */
830 extern NORETURN void error_begin (void);
831
832 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
833
834 /* Returns a freshly allocate buffer containing the last error
835 message. */
836 extern char *error_last_message (void);
837
838 extern NORETURN void internal_verror (const char *, va_list ap) ATTR_NORETURN;
839
840 extern NORETURN void internal_error (char *, ...) ATTR_NORETURN;
841
842 extern NORETURN void nomem (long) ATTR_NORETURN;
843
844 /* Reasons for calling return_to_top_level. Note: enum value 0 is
845 reserved for internal use as the return value from an initial
846 setjmp(). */
847
848 enum return_reason
849 {
850 /* User interrupt. */
851 RETURN_QUIT = 1,
852 /* Any other error. */
853 RETURN_ERROR
854 };
855
856 #define ALL_CLEANUPS ((struct cleanup *)0)
857
858 #define RETURN_MASK(reason) (1 << (int)(reason))
859 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
860 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
861 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
862 typedef int return_mask;
863
864 extern NORETURN void return_to_top_level (enum return_reason) ATTR_NORETURN;
865
866 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
867 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
868 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
869 value. It's unfortunate that, catch_errors() does not return an
870 indication of the exact exception that it caught - quit_flag might
871 help. */
872
873 typedef int (catch_errors_ftype) (PTR);
874 extern int catch_errors (catch_errors_ftype *, PTR, char *, return_mask);
875
876 /* Template to catch_errors() that wraps calls to command
877 functions. */
878
879 typedef void (catch_command_errors_ftype) (char *, int);
880 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
881
882 extern void warning_begin (void);
883
884 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
885
886 /* Global functions from other, non-gdb GNU thingies.
887 Libiberty thingies are no longer declared here. We include libiberty.h
888 above, instead. */
889
890 #ifndef GETENV_PROVIDED
891 extern char *getenv (const char *);
892 #endif
893
894 /* From other system libraries */
895
896 #ifdef HAVE_STDDEF_H
897 #include <stddef.h>
898 #endif
899
900 #ifdef HAVE_STDLIB_H
901 #if defined(_MSC_VER) && !defined(__cplusplus)
902 /* msvc defines these in stdlib.h for c code */
903 #undef min
904 #undef max
905 #endif
906 #include <stdlib.h>
907 #endif
908 #ifndef min
909 #define min(a, b) ((a) < (b) ? (a) : (b))
910 #endif
911 #ifndef max
912 #define max(a, b) ((a) > (b) ? (a) : (b))
913 #endif
914
915
916 /* We take the address of fclose later, but some stdio's forget
917 to declare this. We can't always declare it since there's
918 no way to declare the parameters without upsetting some compiler
919 somewhere. */
920
921 #ifndef FCLOSE_PROVIDED
922 extern int fclose (FILE *);
923 #endif
924
925 #ifndef atof
926 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
927 #endif
928
929 #ifndef MALLOC_INCOMPATIBLE
930
931 #ifdef NEED_DECLARATION_MALLOC
932 extern PTR malloc ();
933 #endif
934
935 #ifdef NEED_DECLARATION_REALLOC
936 extern PTR realloc ();
937 #endif
938
939 #ifdef NEED_DECLARATION_FREE
940 extern void free ();
941 #endif
942
943 #endif /* MALLOC_INCOMPATIBLE */
944
945 /* Various possibilities for alloca. */
946 #ifndef alloca
947 #ifdef __GNUC__
948 #define alloca __builtin_alloca
949 #else /* Not GNU C */
950 #ifdef HAVE_ALLOCA_H
951 #include <alloca.h>
952 #else
953 #ifdef _AIX
954 #pragma alloca
955 #else
956
957 /* We need to be careful not to declare this in a way which conflicts with
958 bison. Bison never declares it as char *, but under various circumstances
959 (like __hpux) we need to use void *. */
960 #if defined (__STDC__) || defined (__hpux)
961 extern void *alloca ();
962 #else /* Don't use void *. */
963 extern char *alloca ();
964 #endif /* Don't use void *. */
965 #endif /* Not _AIX */
966 #endif /* Not HAVE_ALLOCA_H */
967 #endif /* Not GNU C */
968 #endif /* alloca not defined */
969
970 /* HOST_BYTE_ORDER must be defined to one of these. */
971
972 #ifdef HAVE_ENDIAN_H
973 #include <endian.h>
974 #endif
975
976 #if !defined (BIG_ENDIAN)
977 #define BIG_ENDIAN 4321
978 #endif
979
980 #if !defined (LITTLE_ENDIAN)
981 #define LITTLE_ENDIAN 1234
982 #endif
983
984 /* Dynamic target-system-dependent parameters for GDB. */
985 #include "gdbarch.h"
986 #if (GDB_MULTI_ARCH == 0)
987 /* Multi-arch targets _should_ be including "arch-utils.h" directly
988 into their *-tdep.c file. This is a prop to help old non-
989 multi-arch targets to continue to compile. */
990 #include "arch-utils.h"
991 #endif
992
993 /* Static target-system-dependent parameters for GDB. */
994
995 /* Number of bits in a char or unsigned char for the target machine.
996 Just like CHAR_BIT in <limits.h> but describes the target machine. */
997 #if !defined (TARGET_CHAR_BIT)
998 #define TARGET_CHAR_BIT 8
999 #endif
1000
1001 /* Number of bits in a short or unsigned short for the target machine. */
1002 #if !defined (TARGET_SHORT_BIT)
1003 #define TARGET_SHORT_BIT (2 * TARGET_CHAR_BIT)
1004 #endif
1005
1006 /* Number of bits in an int or unsigned int for the target machine. */
1007 #if !defined (TARGET_INT_BIT)
1008 #define TARGET_INT_BIT (4 * TARGET_CHAR_BIT)
1009 #endif
1010
1011 /* Number of bits in a long or unsigned long for the target machine. */
1012 #if !defined (TARGET_LONG_BIT)
1013 #define TARGET_LONG_BIT (4 * TARGET_CHAR_BIT)
1014 #endif
1015
1016 /* Number of bits in a long long or unsigned long long for the target machine. */
1017 #if !defined (TARGET_LONG_LONG_BIT)
1018 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
1019 #endif
1020
1021 /* Number of bits in a float for the target machine. */
1022 #if !defined (TARGET_FLOAT_BIT)
1023 #define TARGET_FLOAT_BIT (4 * TARGET_CHAR_BIT)
1024 #endif
1025
1026 /* Number of bits in a double for the target machine. */
1027 #if !defined (TARGET_DOUBLE_BIT)
1028 #define TARGET_DOUBLE_BIT (8 * TARGET_CHAR_BIT)
1029 #endif
1030
1031 /* Number of bits in a long double for the target machine. */
1032 #if !defined (TARGET_LONG_DOUBLE_BIT)
1033 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
1034 #endif
1035
1036 /* Number of bits in a pointer for the target machine */
1037 #if !defined (TARGET_PTR_BIT)
1038 #define TARGET_PTR_BIT TARGET_INT_BIT
1039 #endif
1040
1041 /* Number of bits in a BFD_VMA for the target object file format. */
1042 #if !defined (TARGET_BFD_VMA_BIT)
1043 #define TARGET_BFD_VMA_BIT TARGET_PTR_BIT
1044 #endif
1045
1046 /* If we picked up a copy of CHAR_BIT from a configuration file
1047 (which may get it by including <limits.h>) then use it to set
1048 the number of bits in a host char. If not, use the same size
1049 as the target. */
1050
1051 #if defined (CHAR_BIT)
1052 #define HOST_CHAR_BIT CHAR_BIT
1053 #else
1054 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1055 #endif
1056
1057 /* The bit byte-order has to do just with numbering of bits in
1058 debugging symbols and such. Conceptually, it's quite separate
1059 from byte/word byte order. */
1060
1061 #if !defined (BITS_BIG_ENDIAN)
1062 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
1063 #endif
1064
1065 /* In findvar.c. */
1066
1067 extern LONGEST extract_signed_integer (void *, int);
1068
1069 extern ULONGEST extract_unsigned_integer (void *, int);
1070
1071 extern int extract_long_unsigned_integer (void *, int, LONGEST *);
1072
1073 extern CORE_ADDR extract_address (void *, int);
1074
1075 extern CORE_ADDR extract_typed_address (void *buf, struct type *type);
1076
1077 extern void store_signed_integer (void *, int, LONGEST);
1078
1079 extern void store_unsigned_integer (void *, int, ULONGEST);
1080
1081 extern void store_address (void *, int, LONGEST);
1082
1083 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1084
1085 /* Setup definitions for host and target floating point formats. We need to
1086 consider the format for `float', `double', and `long double' for both target
1087 and host. We need to do this so that we know what kind of conversions need
1088 to be done when converting target numbers to and from the hosts DOUBLEST
1089 data type. */
1090
1091 /* This is used to indicate that we don't know the format of the floating point
1092 number. Typically, this is useful for native ports, where the actual format
1093 is irrelevant, since no conversions will be taking place. */
1094
1095 extern const struct floatformat floatformat_unknown;
1096
1097 #if HOST_BYTE_ORDER == BIG_ENDIAN
1098 #ifndef HOST_FLOAT_FORMAT
1099 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_big
1100 #endif
1101 #ifndef HOST_DOUBLE_FORMAT
1102 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_big
1103 #endif
1104 #else /* LITTLE_ENDIAN */
1105 #ifndef HOST_FLOAT_FORMAT
1106 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_little
1107 #endif
1108 #ifndef HOST_DOUBLE_FORMAT
1109 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_little
1110 #endif
1111 #endif
1112
1113 #ifndef HOST_LONG_DOUBLE_FORMAT
1114 #define HOST_LONG_DOUBLE_FORMAT &floatformat_unknown
1115 #endif
1116
1117 /* Use `long double' if the host compiler supports it. (Note that this is not
1118 necessarily any longer than `double'. On SunOS/gcc, it's the same as
1119 double.) This is necessary because GDB internally converts all floating
1120 point values to the widest type supported by the host.
1121
1122 There are problems however, when the target `long double' is longer than the
1123 host's `long double'. In general, we'll probably reduce the precision of
1124 any such values and print a warning. */
1125
1126 #ifdef HAVE_LONG_DOUBLE
1127 typedef long double DOUBLEST;
1128 #else
1129 typedef double DOUBLEST;
1130 #endif
1131
1132 extern void floatformat_to_doublest (const struct floatformat *,
1133 char *, DOUBLEST *);
1134 extern void floatformat_from_doublest (const struct floatformat *,
1135 DOUBLEST *, char *);
1136 extern DOUBLEST extract_floating (void *, int);
1137
1138 extern void store_floating (void *, int, DOUBLEST);
1139 \f
1140 /* On some machines there are bits in addresses which are not really
1141 part of the address, but are used by the kernel, the hardware, etc.
1142 for special purposes. ADDR_BITS_REMOVE takes out any such bits
1143 so we get a "real" address such as one would find in a symbol
1144 table. This is used only for addresses of instructions, and even then
1145 I'm not sure it's used in all contexts. It exists to deal with there
1146 being a few stray bits in the PC which would mislead us, not as some sort
1147 of generic thing to handle alignment or segmentation (it's possible it
1148 should be in TARGET_READ_PC instead). */
1149 #if !defined (ADDR_BITS_REMOVE)
1150 #define ADDR_BITS_REMOVE(addr) (addr)
1151 #endif /* No ADDR_BITS_REMOVE. */
1152
1153 /* From valops.c */
1154
1155 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1156
1157 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1158
1159 extern int watchdog;
1160
1161 /* Hooks for alternate command interfaces. */
1162
1163 #ifdef UI_OUT
1164 /* The name of the interpreter if specified on the command line. */
1165 extern char *interpreter_p;
1166 #endif
1167
1168 /* If a given interpreter matches INTERPRETER_P then it should update
1169 command_loop_hook and init_ui_hook with the per-interpreter
1170 implementation. */
1171 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1172
1173 struct target_waitstatus;
1174 struct cmd_list_element;
1175
1176 /* Should the asynchronous variant of the interpreter (using the
1177 event-loop) be enabled? */
1178 extern int event_loop_p;
1179
1180 extern void (*init_ui_hook) (char *argv0);
1181 extern void (*command_loop_hook) (void);
1182 extern void (*show_load_progress) (const char *section,
1183 unsigned long section_sent,
1184 unsigned long section_size,
1185 unsigned long total_sent,
1186 unsigned long total_size);
1187 extern void (*print_frame_info_listing_hook) (struct symtab * s,
1188 int line, int stopline,
1189 int noerror);
1190 extern struct frame_info *parse_frame_specification (char *frame_exp);
1191 extern int (*query_hook) (const char *, va_list);
1192 extern void (*warning_hook) (const char *, va_list);
1193 extern void (*flush_hook) (struct ui_file * stream);
1194 extern void (*create_breakpoint_hook) (struct breakpoint * b);
1195 extern void (*delete_breakpoint_hook) (struct breakpoint * bpt);
1196 extern void (*modify_breakpoint_hook) (struct breakpoint * bpt);
1197 extern void (*interactive_hook) (void);
1198 extern void (*registers_changed_hook) (void);
1199 extern void (*readline_begin_hook) (char *,...);
1200 extern char *(*readline_hook) (char *);
1201 extern void (*readline_end_hook) (void);
1202 extern void (*register_changed_hook) (int regno);
1203 extern void (*memory_changed_hook) (CORE_ADDR addr, int len);
1204 extern void (*context_hook) (int);
1205 extern int (*target_wait_hook) (int pid, struct target_waitstatus * status);
1206
1207 extern void (*attach_hook) (void);
1208 extern void (*detach_hook) (void);
1209 extern void (*call_command_hook) (struct cmd_list_element * c,
1210 char *cmd, int from_tty);
1211
1212 extern void (*set_hook) (struct cmd_list_element * c);
1213
1214 extern NORETURN void (*error_hook) (void) ATTR_NORETURN;
1215
1216 extern void (*error_begin_hook) (void);
1217
1218 extern int (*ui_load_progress_hook) (const char *section, unsigned long num);
1219
1220
1221 /* Inhibit window interface if non-zero. */
1222
1223 extern int use_windows;
1224
1225 /* Symbolic definitions of filename-related things. */
1226 /* FIXME, this doesn't work very well if host and executable
1227 filesystems conventions are different. */
1228
1229 #ifndef DIRNAME_SEPARATOR
1230 #define DIRNAME_SEPARATOR ':'
1231 #endif
1232
1233 #ifndef SLASH_P
1234 #if defined(__GO32__)||defined(_WIN32)
1235 #define SLASH_P(X) ((X)=='\\')
1236 #else
1237 #define SLASH_P(X) ((X)=='/')
1238 #endif
1239 #endif
1240
1241 #ifndef SLASH_CHAR
1242 #if defined(__GO32__)||defined(_WIN32)
1243 #define SLASH_CHAR '\\'
1244 #else
1245 #define SLASH_CHAR '/'
1246 #endif
1247 #endif
1248
1249 #ifndef SLASH_STRING
1250 #if defined(__GO32__)||defined(_WIN32)
1251 #define SLASH_STRING "\\"
1252 #else
1253 #define SLASH_STRING "/"
1254 #endif
1255 #endif
1256
1257 #ifndef ROOTED_P
1258 #define ROOTED_P(X) (SLASH_P((X)[0]))
1259 #endif
1260
1261 /* On some systems, PIDGET is defined to extract the inferior pid from
1262 an internal pid that has the thread id and pid in seperate bit
1263 fields. If not defined, then just use the entire internal pid as
1264 the actual pid. */
1265
1266 #ifndef PIDGET
1267 #define PIDGET(PID) (PID)
1268 #define TIDGET(PID) 0
1269 #define MERGEPID(PID, TID) (PID)
1270 #endif
1271
1272 /* If under Cygwin, provide backwards compatibility with older
1273 Cygwin compilers that don't define the current cpp define. */
1274 #ifdef __CYGWIN32__
1275 #ifndef __CYGWIN__
1276 #define __CYGWIN__
1277 #endif
1278 #endif
1279
1280 /* Define well known filenos if the system does not define them. */
1281 #ifndef STDIN_FILENO
1282 #define STDIN_FILENO 0
1283 #endif
1284 #ifndef STDOUT_FILENO
1285 #define STDOUT_FILENO 1
1286 #endif
1287 #ifndef STDERR_FILENO
1288 #define STDERR_FILENO 2
1289 #endif
1290
1291 /* If this definition isn't overridden by the header files, assume
1292 that isatty and fileno exist on this system. */
1293 #ifndef ISATTY
1294 #define ISATTY(FP) (isatty (fileno (FP)))
1295 #endif
1296
1297 \f
1298 /* FIXME: cagney/1999-12-13: The following will be moved to gdb.h /
1299 libgdb.h or gdblib.h. */
1300
1301 /* Return-code (RC) from a gdb library call. (The abreviation RC is
1302 taken from the sim/common directory.) */
1303
1304 enum gdb_rc {
1305 /* The operation failed. The failure message can be fetched by
1306 calling ``char *error_last_message(void)''. The value is
1307 determined by the catch_errors() interface. */
1308 /* NOTE: Since ``defs.h:catch_errors()'' does not return an error /
1309 internal / quit indication it is not possible to return that
1310 here. */
1311 GDB_RC_FAIL = 0,
1312 /* No error occured but nothing happened. Due to the catch_errors()
1313 interface, this must be non-zero. */
1314 GDB_RC_NONE = 1,
1315 /* The operation was successful. Due to the catch_errors()
1316 interface, this must be non-zero. */
1317 GDB_RC_OK = 2
1318 };
1319
1320
1321 /* Print the specified breakpoint on GDB_STDOUT. (Eventually this
1322 function will ``print'' the object on ``output''). */
1323 enum gdb_rc gdb_breakpoint_query (/* struct {ui,gdb}_out *output, */ int bnum);
1324
1325 /* Create a breakpoint at ADDRESS (a GDB source and line). */
1326 enum gdb_rc gdb_breakpoint (char *address, char *condition,
1327 int hardwareflag, int tempflag,
1328 int thread, int ignore_count);
1329 enum gdb_rc gdb_thread_select (/* output object */ char *tidstr);
1330
1331 #ifdef UI_OUT
1332 /* Print a list of known thread ids. */
1333 enum gdb_rc gdb_list_thread_ids (/* output object */);
1334
1335 /* Switch thread and print notification. */
1336 #endif
1337 #endif /* #ifndef DEFS_H */
This page took 0.094488 seconds and 5 git commands to generate.