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