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