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