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