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