* MAINTAINERS (generic symtabs, dwarf readers, elf reader, stabs
[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 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
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
29 #include <stdio.h>
30 #include <errno.h> /* System call error return status. */
31 #include <limits.h>
32
33 #ifdef HAVE_STDDEF_H
34 #include <stddef.h>
35 #else
36 #include <sys/types.h> /* For size_t. */
37 #endif
38
39 #ifdef HAVE_UNISTD_H
40 #include <unistd.h>
41 #endif
42
43 /* First include ansidecl.h so we can use the various macro definitions
44 here and in all subsequent file inclusions. */
45
46 #include "ansidecl.h"
47
48 #include "gdb_locale.h"
49
50 /* For ``enum target_signal''. */
51 #include "gdb/signals.h"
52
53 /* Just in case they're not defined in stdio.h. */
54
55 #ifndef SEEK_SET
56 #define SEEK_SET 0
57 #endif
58 #ifndef SEEK_CUR
59 #define SEEK_CUR 1
60 #endif
61
62 #include <stdarg.h> /* For va_list. */
63
64 #include "libiberty.h"
65
66 /* For BFD64 and bfd_vma. */
67 #include "bfd.h"
68
69 /* An address in the program being debugged. Host byte order. Rather
70 than duplicate all the logic in BFD which figures out what type
71 this is (long, long long, etc.) and whether it needs to be 64
72 bits (the host/target interactions are subtle), we just use
73 bfd_vma. */
74
75 typedef bfd_vma CORE_ADDR;
76
77 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
78
79 #ifndef LONGEST
80
81 #ifdef BFD64
82
83 #define LONGEST BFD_HOST_64_BIT
84 #define ULONGEST BFD_HOST_U_64_BIT
85
86 #else /* No BFD64 */
87
88 #ifdef CC_HAS_LONG_LONG
89 #define LONGEST long long
90 #define ULONGEST unsigned long long
91 #else
92 #ifdef BFD_HOST_64_BIT
93 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
94 (e.g. i386-windows) so try it. */
95 #define LONGEST BFD_HOST_64_BIT
96 #define ULONGEST BFD_HOST_U_64_BIT
97 #else
98 #define LONGEST long
99 #define ULONGEST unsigned long
100 #endif
101 #endif
102
103 #endif /* No BFD64 */
104
105 #endif /* ! LONGEST */
106
107 #ifndef min
108 #define min(a, b) ((a) < (b) ? (a) : (b))
109 #endif
110 #ifndef max
111 #define max(a, b) ((a) > (b) ? (a) : (b))
112 #endif
113
114 /* Macros to do string compares.
115
116 NOTE: cagney/2000-03-14:
117
118 While old code can continue to refer to these macros, new code is
119 probably better off using strcmp() directly vis: ``strcmp() == 0''
120 and ``strcmp() != 0''.
121
122 This is because modern compilers can directly inline strcmp()
123 making the original justification for these macros - avoid function
124 call overhead by pre-testing the first characters
125 (``*X==*Y?...:0'') - redundant.
126
127 ``Even if [...] testing the first character does have a modest
128 performance improvement, I'd rather that whenever a performance
129 issue is found that we spend the effort on algorithmic
130 optimizations than micro-optimizing.'' J.T. */
131
132 /* NOTE: cagney/2003-11-23: All instances of STREQ[N] covered by
133 testing GDB on a stabs system have been replaced by equivalent
134 str[n]cmp calls. To avoid the possability of introducing bugs when
135 making untested changes, the remaining references were deprecated
136 rather than replaced. */
137
138 /* DISCLAIMER: cagney/2003-11-23: Simplified definition of these
139 macros so that they just map directly onto strcmp equivalent. I'm
140 not responsible for any breakage due to code that relied on the old
141 underlying implementation. */
142
143 #define DEPRECATED_STREQ(a,b) (strcmp ((a), (b)) == 0)
144 #define DEPRECATED_STREQN(a,b,c) (strncmp ((a), (b), (c)) == 0)
145
146 /* Check if a character is one of the commonly used C++ marker characters. */
147 extern int is_cplus_marker (int);
148
149 /* enable xdb commands if set */
150 extern int xdb_commands;
151
152 /* enable dbx commands if set */
153 extern int dbx_commands;
154
155 /* System root path, used to find libraries etc. */
156 extern char *gdb_sysroot;
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 (deprecated_interactive_hook) deprecated_interactive_hook (); \
179 }
180 #endif
181
182 /* Languages represented in the symbol table and elsewhere.
183 This should probably be in language.h, but since enum's can't
184 be forward declared to satisfy opaque references before their
185 actual definition, needs to be here. */
186
187 enum language
188 {
189 language_unknown, /* Language not known */
190 language_auto, /* Placeholder for automatic setting */
191 language_c, /* C */
192 language_cplus, /* C++ */
193 language_objc, /* Objective-C */
194 language_java, /* Java */
195 language_fortran, /* Fortran */
196 language_m2, /* Modula-2 */
197 language_asm, /* Assembly language */
198 language_scm, /* Scheme / Guile */
199 language_pascal, /* Pascal */
200 language_ada, /* Ada */
201 language_minimal, /* All other languages, minimal support only */
202 nr_languages
203 };
204
205 enum precision_type
206 {
207 single_precision,
208 double_precision,
209 unspecified_precision
210 };
211
212 /* A generic, not quite boolean, enumeration. */
213 enum auto_boolean
214 {
215 AUTO_BOOLEAN_TRUE,
216 AUTO_BOOLEAN_FALSE,
217 AUTO_BOOLEAN_AUTO
218 };
219
220 /* Potential ways that a function can return a value of a given type. */
221 enum return_value_convention
222 {
223 /* Where the return value has been squeezed into one or more
224 registers. */
225 RETURN_VALUE_REGISTER_CONVENTION,
226 /* Commonly known as the "struct return convention". The caller
227 passes an additional hidden first parameter to the caller. That
228 parameter contains the address at which the value being returned
229 should be stored. While typically, and historically, used for
230 large structs, this is convention is applied to values of many
231 different types. */
232 RETURN_VALUE_STRUCT_CONVENTION,
233 /* Like the "struct return convention" above, but where the ABI
234 guarantees that the called function stores the address at which
235 the value being returned is stored in a well-defined location,
236 such as a register or memory slot in the stack frame. Don't use
237 this if the ABI doesn't explicitly guarantees this. */
238 RETURN_VALUE_ABI_RETURNS_ADDRESS,
239 /* Like the "struct return convention" above, but where the ABI
240 guarantees that the address at which the value being returned is
241 stored will be available in a well-defined location, such as a
242 register or memory slot in the stack frame. Don't use this if
243 the ABI doesn't explicitly guarantees this. */
244 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
245 };
246
247 /* the cleanup list records things that have to be undone
248 if an error happens (descriptors to be closed, memory to be freed, etc.)
249 Each link in the chain records a function to call and an
250 argument to give it.
251
252 Use make_cleanup to add an element to the cleanup chain.
253 Use do_cleanups to do all cleanup actions back to a given
254 point in the chain. Use discard_cleanups to remove cleanups
255 from the chain back to a given point, not doing them. */
256
257 struct cleanup
258 {
259 struct cleanup *next;
260 void (*function) (void *);
261 void *arg;
262 };
263
264
265 /* The ability to declare that a function never returns is useful, but
266 not really required to compile GDB successfully, so the NORETURN and
267 ATTR_NORETURN macros normally expand into nothing. */
268
269 /* If compiling with older versions of GCC, a function may be declared
270 "volatile" to indicate that it does not return. */
271
272 #ifndef NORETURN
273 #if defined(__GNUC__) \
274 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
275 #define NORETURN volatile
276 #else
277 #define NORETURN /* nothing */
278 #endif
279 #endif
280
281 /* GCC 2.5 and later versions define a function attribute "noreturn",
282 which is the preferred way to declare that a function never returns.
283 However GCC 2.7 appears to be the first version in which this fully
284 works everywhere we use it. */
285
286 #ifndef ATTR_NORETURN
287 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
288 #define ATTR_NORETURN __attribute__ ((noreturn))
289 #else
290 #define ATTR_NORETURN /* nothing */
291 #endif
292 #endif
293
294 #ifndef ATTR_FORMAT
295 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
296 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
297 #else
298 #define ATTR_FORMAT(type, x, y) /* nothing */
299 #endif
300 #endif
301
302 /* Be conservative and use enum bitfields only with GCC.
303 This is copied from gcc 3.3.1, system.h. */
304
305 #if defined(__GNUC__) && (__GNUC__ >= 2)
306 #define ENUM_BITFIELD(TYPE) enum TYPE
307 #else
308 #define ENUM_BITFIELD(TYPE) unsigned int
309 #endif
310
311 /* Needed for various prototypes */
312
313 struct symtab;
314 struct breakpoint;
315 struct frame_info;
316
317 /* From blockframe.c */
318
319 extern int inside_entry_func (struct frame_info *this_frame);
320
321 /* From utils.c */
322
323 extern void initialize_utils (void);
324
325 extern void notice_quit (void);
326
327 extern int strcmp_iw (const char *, const char *);
328
329 extern int strcmp_iw_ordered (const char *, const char *);
330
331 extern int streq (const char *, const char *);
332
333 extern int subset_compare (char *, char *);
334
335 extern char *safe_strerror (int);
336
337 extern void request_quit (int);
338
339 extern void do_cleanups (struct cleanup *);
340 extern void do_final_cleanups (struct cleanup *);
341 extern void do_run_cleanups (struct cleanup *);
342 extern void do_exec_cleanups (struct cleanup *);
343 extern void do_exec_error_cleanups (struct cleanup *);
344
345 extern void discard_cleanups (struct cleanup *);
346 extern void discard_final_cleanups (struct cleanup *);
347 extern void discard_exec_error_cleanups (struct cleanup *);
348 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
349
350 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
351 make_cleanup function declarations below. Do not use this typedef
352 as a cast when passing functions into the make_cleanup() code.
353 Instead either use a bounce function or add a wrapper function.
354 Calling a f(char*) function with f(void*) is non-portable. */
355 typedef void (make_cleanup_ftype) (void *);
356
357 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
358
359 extern struct cleanup *make_cleanup_freeargv (char **);
360
361 struct ui_file;
362 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
363
364 struct section_addr_info;
365 extern struct cleanup *(make_cleanup_free_section_addr_info
366 (struct section_addr_info *));
367
368 extern struct cleanup *make_cleanup_close (int fd);
369
370 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
371
372 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
373
374 extern struct cleanup *make_my_cleanup (struct cleanup **,
375 make_cleanup_ftype *, void *);
376
377 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
378
379 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
380 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
381
382 extern struct cleanup *save_cleanups (void);
383 extern struct cleanup *save_final_cleanups (void);
384 extern struct cleanup *save_my_cleanups (struct cleanup **);
385
386 extern void restore_cleanups (struct cleanup *);
387 extern void restore_final_cleanups (struct cleanup *);
388 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
389
390 extern void free_current_contents (void *);
391
392 extern void null_cleanup (void *);
393
394 extern int myread (int, char *, int);
395
396 extern int query (const char *, ...) ATTR_FORMAT (printf, 1, 2);
397 extern int nquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
398 extern int yquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
399
400 extern void init_page_info (void);
401
402 extern char *gdb_realpath (const char *);
403 extern char *xfullpath (const char *);
404
405 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
406 unsigned char *buf, size_t len);
407
408 /* From demangle.c */
409
410 extern void set_demangling_style (char *);
411
412 /* From tm.h */
413
414 struct type;
415 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
416 extern use_struct_convention_fn generic_use_struct_convention;
417
418 \f
419 /* Annotation stuff. */
420
421 extern int annotation_level; /* in stack.c */
422 \f
423 extern void begin_line (void);
424
425 extern void wrap_here (char *);
426
427 extern void reinitialize_more_filter (void);
428
429 /* Normal results */
430 extern struct ui_file *gdb_stdout;
431 /* Input stream */
432 extern struct ui_file *gdb_stdin;
433 /* Serious error notifications */
434 extern struct ui_file *gdb_stderr;
435 /* Log/debug/trace messages that should bypass normal stdout/stderr
436 filtering. For moment, always call this stream using
437 *_unfiltered. In the very near future that restriction shall be
438 removed - either call shall be unfiltered. (cagney 1999-06-13). */
439 extern struct ui_file *gdb_stdlog;
440 /* Target output that should bypass normal stdout/stderr filtering.
441 For moment, always call this stream using *_unfiltered. In the
442 very near future that restriction shall be removed - either call
443 shall be unfiltered. (cagney 1999-07-02). */
444 extern struct ui_file *gdb_stdtarg;
445 extern struct ui_file *gdb_stdtargerr;
446 extern struct ui_file *gdb_stdtargin;
447
448 #include "ui-file.h"
449
450 /* More generic printf like operations. Filtered versions may return
451 non-locally on error. */
452
453 extern void fputs_filtered (const char *, struct ui_file *);
454
455 extern void fputs_unfiltered (const char *, struct ui_file *);
456
457 extern int fputc_filtered (int c, struct ui_file *);
458
459 extern int fputc_unfiltered (int c, struct ui_file *);
460
461 extern int putchar_filtered (int c);
462
463 extern int putchar_unfiltered (int c);
464
465 extern void puts_filtered (const char *);
466
467 extern void puts_unfiltered (const char *);
468
469 extern void puts_filtered_tabular (char *string, int width, int right);
470
471 extern void puts_debug (char *prefix, char *string, char *suffix);
472
473 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
474
475 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
476
477 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
478
479 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
480
481 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
482
483 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
484
485 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
486
487 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
488
489 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
490
491 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
492
493 extern void print_spaces (int, struct ui_file *);
494
495 extern void print_spaces_filtered (int, struct ui_file *);
496
497 extern char *n_spaces (int);
498
499 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
500
501 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
502
503 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
504
505 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
506 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
507
508 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
509 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
510 for ``%*''. */
511 extern int strlen_paddr (void);
512 extern char *paddr (CORE_ADDR addr);
513 extern char *paddr_nz (CORE_ADDR addr);
514 extern char *paddr_u (CORE_ADDR addr);
515 extern char *paddr_d (LONGEST addr);
516
517 extern char *phex (ULONGEST l, int sizeof_l);
518 extern char *phex_nz (ULONGEST l, int sizeof_l);
519 extern char *int_string (LONGEST, int, int, int, int);
520
521 /* Like paddr() only print/scan raw CORE_ADDR. The output from
522 core_addr_to_string() can be passed direct to
523 string_to_core_addr(). */
524 extern const char *core_addr_to_string (const CORE_ADDR addr);
525 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
526 extern CORE_ADDR string_to_core_addr (const char *my_string);
527
528 /* Return a string that contains a number formatted as a hex
529 string. */
530 extern char *hex_string (LONGEST);
531 extern char *hex_string_custom (LONGEST, int);
532
533 extern void fprintf_symbol_filtered (struct ui_file *, char *,
534 enum language, int);
535
536 extern NORETURN void perror_with_name (const char *) ATTR_NORETURN;
537
538 extern void print_sys_errmsg (const char *, int);
539
540 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
541 "const char *" in unistd.h, so we can't declare the argument
542 as "char *". */
543
544 extern char *re_comp (const char *);
545
546 /* From symfile.c */
547
548 extern void symbol_file_command (char *, int);
549
550 /* Remote targets may wish to use this as their load function. */
551 extern void generic_load (char *name, int from_tty);
552
553 /* Summarise a download */
554 extern void print_transfer_performance (struct ui_file *stream,
555 unsigned long data_count,
556 unsigned long write_count,
557 unsigned long time_count);
558
559 /* From top.c */
560
561 typedef void initialize_file_ftype (void);
562
563 extern char *skip_quoted (char *);
564
565 extern char *gdb_readline (char *);
566
567 extern char *gdb_readline_wrapper (char *);
568
569 extern char *command_line_input (char *, int, char *);
570
571 extern void print_prompt (void);
572
573 extern int input_from_terminal_p (void);
574
575 extern int info_verbose;
576
577 /* From printcmd.c */
578
579 extern void set_next_address (CORE_ADDR);
580
581 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
582 char *);
583
584 extern int build_address_symbolic (CORE_ADDR addr,
585 int do_demangle,
586 char **name,
587 int *offset,
588 char **filename,
589 int *line,
590 int *unmapped);
591
592 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
593
594 extern void print_address (CORE_ADDR, struct ui_file *);
595
596 /* From source.c */
597
598 #define OPF_TRY_CWD_FIRST 0x01
599 #define OPF_SEARCH_IN_PATH 0x02
600
601 extern int openp (const char *, int, const char *, int, int, char **);
602
603 extern int source_full_path_of (char *, char **);
604
605 extern void mod_path (char *, char **);
606
607 extern void add_path (char *, char **, int);
608
609 extern void directory_command (char *, int);
610
611 extern char *source_path;
612
613 extern void init_source_path (void);
614
615 extern void init_last_source_visited (void);
616
617 /* From exec.c */
618
619 extern void exec_set_section_offsets (bfd_signed_vma text_off,
620 bfd_signed_vma data_off,
621 bfd_signed_vma bss_off);
622
623 /* Take over the 'find_mapped_memory' vector from exec.c. */
624 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,
625 unsigned long,
626 int, int, int,
627 void *),
628 void *));
629
630 /* Possible lvalue types. Like enum language, this should be in
631 value.h, but needs to be here for the same reason. */
632
633 enum lval_type
634 {
635 /* Not an lval. */
636 not_lval,
637 /* In memory. Could be a saved register. */
638 lval_memory,
639 /* In a register. */
640 lval_register,
641 /* In a gdb internal variable. */
642 lval_internalvar,
643 /* Part of a gdb internal variable (structure field). */
644 lval_internalvar_component,
645 /* In a register series in a frame not the current one, which may have been
646 partially saved or saved in different places (otherwise would be
647 lval_register or lval_memory). */
648 lval_reg_frame_relative
649 };
650
651 /* Control types for commands */
652
653 enum misc_command_type
654 {
655 ok_command,
656 end_command,
657 else_command,
658 nop_command
659 };
660
661 enum command_control_type
662 {
663 simple_control,
664 break_control,
665 continue_control,
666 while_control,
667 if_control,
668 invalid_control
669 };
670
671 /* Structure for saved commands lines
672 (for breakpoints, defined commands, etc). */
673
674 struct command_line
675 {
676 struct command_line *next;
677 char *line;
678 enum command_control_type control_type;
679 int body_count;
680 struct command_line **body_list;
681 };
682
683 extern struct command_line *read_command_lines (char *, int);
684
685 extern void free_command_lines (struct command_line **);
686
687 /* To continue the execution commands when running gdb asynchronously.
688 A continuation structure contains a pointer to a function to be called
689 to finish the command, once the target has stopped. Such mechanism is
690 used bt the finish and until commands, and in the remote protocol
691 when opening an extended-remote connection. */
692
693 struct continuation_arg
694 {
695 struct continuation_arg *next;
696 union continuation_data {
697 void *pointer;
698 int integer;
699 long longint;
700 } data;
701 };
702
703 struct continuation
704 {
705 void (*continuation_hook) (struct continuation_arg *);
706 struct continuation_arg *arg_list;
707 struct continuation *next;
708 };
709
710 /* In infrun.c. */
711 extern struct continuation *cmd_continuation;
712 /* Used only by the step_1 function. */
713 extern struct continuation *intermediate_continuation;
714
715 /* From utils.c */
716 extern void add_continuation (void (*)(struct continuation_arg *),
717 struct continuation_arg *);
718 extern void do_all_continuations (void);
719 extern void discard_all_continuations (void);
720
721 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
722 struct continuation_arg *);
723 extern void do_all_intermediate_continuations (void);
724 extern void discard_all_intermediate_continuations (void);
725
726 /* String containing the current directory (what getwd would return). */
727
728 extern char *current_directory;
729
730 /* Default radixes for input and output. Only some values supported. */
731 extern unsigned input_radix;
732 extern unsigned output_radix;
733
734 /* Possibilities for prettyprint parameters to routines which print
735 things. Like enum language, this should be in value.h, but needs
736 to be here for the same reason. FIXME: If we can eliminate this
737 as an arg to LA_VAL_PRINT, then we can probably move it back to
738 value.h. */
739
740 enum val_prettyprint
741 {
742 Val_no_prettyprint = 0,
743 Val_prettyprint,
744 /* Use the default setting which the user has specified. */
745 Val_pretty_default
746 };
747
748 /* The ptid struct is a collection of the various "ids" necessary
749 for identifying the inferior. This consists of the process id
750 (pid), thread id (tid), and other fields necessary for uniquely
751 identifying the inferior process/thread being debugged. When
752 manipulating ptids, the constructors, accessors, and predicate
753 declared in inferior.h should be used. These are as follows:
754
755 ptid_build - Make a new ptid from a pid, lwp, and tid.
756 pid_to_ptid - Make a new ptid from just a pid.
757 ptid_get_pid - Fetch the pid component of a ptid.
758 ptid_get_lwp - Fetch the lwp component of a ptid.
759 ptid_get_tid - Fetch the tid component of a ptid.
760 ptid_equal - Test to see if two ptids are equal.
761
762 Please do NOT access the struct ptid members directly (except, of
763 course, in the implementation of the above ptid manipulation
764 functions). */
765
766 struct ptid
767 {
768 /* Process id */
769 int pid;
770
771 /* Lightweight process id */
772 long lwp;
773
774 /* Thread id */
775 long tid;
776 };
777
778 typedef struct ptid ptid_t;
779
780 \f
781
782 /* Optional host machine definition. Pure autoconf targets will not
783 need a "xm.h" file. This will be a symlink to one of the xm-*.h
784 files, built by the `configure' script. */
785
786 #ifdef GDB_XM_FILE
787 #include "xm.h"
788 #endif
789
790 /* Optional native machine support. Non-native (and possibly pure
791 multi-arch) targets do not need a "nm.h" file. This will be a
792 symlink to one of the nm-*.h files, built by the `configure'
793 script. */
794
795 #ifdef GDB_NM_FILE
796 #include "nm.h"
797 #endif
798
799 /* Optional target machine definition. Pure multi-arch configurations
800 do not need a "tm.h" file. This will be a symlink to one of the
801 tm-*.h files, built by the `configure' script. */
802
803 #ifdef GDB_TM_FILE
804 #include "tm.h"
805 #endif
806
807 /* If the xm.h file did not define the mode string used to open the
808 files, assume that binary files are opened the same way as text
809 files */
810 #ifndef FOPEN_RB
811 #include "fopen-same.h"
812 #endif
813
814 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
815 FIXME: Assumes 2's complement arithmetic */
816
817 #if !defined (UINT_MAX)
818 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
819 #endif
820
821 #if !defined (INT_MAX)
822 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
823 #endif
824
825 #if !defined (INT_MIN)
826 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
827 #endif
828
829 #if !defined (ULONG_MAX)
830 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
831 #endif
832
833 #if !defined (LONG_MAX)
834 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
835 #endif
836
837 #if !defined (ULONGEST_MAX)
838 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
839 #endif
840
841 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
842 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
843 #endif
844
845 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
846 arguments to a function, number in a value history, register number, etc.)
847 where the value must not be larger than can fit in an int. */
848
849 extern int longest_to_int (LONGEST);
850
851 /* Assorted functions we can declare, now that const and volatile are
852 defined. */
853
854 extern char *savestring (const char *, size_t);
855
856 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
857 "libiberty.h". */
858 extern void xfree (void *);
859
860 /* Utility macros to allocate typed memory. Avoids errors like:
861 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
862 sizeof (struct foo), 0). */
863 #define XZALLOC(TYPE) ((TYPE*) memset (xmalloc (sizeof (TYPE)), 0, sizeof (TYPE)))
864 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
865 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
866
867 /* Like asprintf/vasprintf but get an internal_error if the call
868 fails. */
869 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
870 extern void xvasprintf (char **ret, const char *format, va_list ap);
871
872 /* Like asprintf and vasprintf, but return the string, throw an error
873 if no memory. */
874 extern char *xstrprintf (const char *format, ...) ATTR_FORMAT (printf, 1, 2);
875 extern char *xstrvprintf (const char *format, va_list ap);
876
877 extern int parse_escape (char **);
878
879 /* Message to be printed before the error message, when an error occurs. */
880
881 extern char *error_pre_print;
882
883 /* Message to be printed before the error message, when an error occurs. */
884
885 extern char *quit_pre_print;
886
887 /* Message to be printed before the warning message, when a warning occurs. */
888
889 extern char *warning_pre_print;
890
891 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
892
893 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
894
895 extern NORETURN void error_silent (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
896
897 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
898
899 /* Initialize the error buffer. */
900 extern void error_init (void);
901
902 /* Returns a freshly allocate buffer containing the last error
903 message. */
904 extern char *error_last_message (void);
905
906 /* Output arbitrary error message. */
907 extern void error_output_message (char *pre_print, char *msg);
908
909 extern NORETURN void internal_verror (const char *file, int line,
910 const char *, va_list ap) ATTR_NORETURN;
911
912 extern NORETURN void internal_error (const char *file, int line,
913 const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
914
915 extern void internal_vwarning (const char *file, int line,
916 const char *, va_list ap);
917
918 extern void internal_warning (const char *file, int line,
919 const char *, ...) ATTR_FORMAT (printf, 3, 4);
920
921 extern NORETURN void nomem (long) ATTR_NORETURN;
922
923 /* Reasons for calling throw_exception(). NOTE: all reason values
924 must be less than zero. enum value 0 is reserved for internal use
925 as the return value from an initial setjmp(). The function
926 catch_exceptions() reserves values >= 0 as legal results from its
927 wrapped function. */
928
929 enum return_reason
930 {
931 /* User interrupt. */
932 RETURN_QUIT = -2,
933 /* Any other error. */
934 RETURN_ERROR
935 };
936
937 #define ALL_CLEANUPS ((struct cleanup *)0)
938
939 #define RETURN_MASK(reason) (1 << (int)(-reason))
940 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
941 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
942 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
943 typedef int return_mask;
944
945 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
946 to the inner most containing exception handler established using
947 catch_exceptions() (or the legacy catch_errors()).
948
949 Code normally throws an exception using error() et.al. For various
950 reaons, GDB also contains code that throws an exception directly.
951 For instance, the remote*.c targets contain CNTRL-C signal handlers
952 that propogate the QUIT event up the exception chain. ``This could
953 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
954
955 extern NORETURN void throw_exception (enum return_reason) ATTR_NORETURN;
956
957 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
958 handler. If an exception (enum return_reason) is thrown using
959 throw_exception() than all cleanups installed since
960 catch_exceptions() was entered are invoked, the (-ve) exception
961 value is then returned by catch_exceptions. If FUNC() returns
962 normally (with a postive or zero return value) then that value is
963 returned by catch_exceptions(). It is an internal_error() for
964 FUNC() to return a negative value.
965
966 For the period of the FUNC() call: UIOUT is installed as the output
967 builder; ERRSTRING is installed as the error/quit message; and a
968 new cleanup_chain is established. The old values are restored
969 before catch_exceptions() returns.
970
971 The variant catch_exceptions_with_msg() is the same as
972 catch_exceptions() but adds the ability to return an allocated
973 copy of the gdb error message. This is used when a silent error is
974 issued and the caller wants to manually issue the error message.
975
976 FIXME; cagney/2001-08-13: The need to override the global UIOUT
977 builder variable should just go away.
978
979 This function superseeds catch_errors().
980
981 This function uses SETJMP() and LONGJUMP(). */
982
983 struct ui_out;
984 typedef int (catch_exceptions_ftype) (struct ui_out *ui_out, void *args);
985 extern int catch_exceptions (struct ui_out *uiout,
986 catch_exceptions_ftype *func, void *func_args,
987 char *errstring, return_mask mask);
988 extern int catch_exceptions_with_msg (struct ui_out *uiout,
989 catch_exceptions_ftype *func,
990 void *func_args,
991 char *errstring, char **gdberrmsg,
992 return_mask mask);
993
994 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
995 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
996 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
997 value. It's unfortunate that, catch_errors() does not return an
998 indication of the exact exception that it caught - quit_flag might
999 help.
1000
1001 This function is superseeded by catch_exceptions(). */
1002
1003 typedef int (catch_errors_ftype) (void *);
1004 extern int catch_errors (catch_errors_ftype *, void *, char *, return_mask);
1005
1006 /* Template to catch_errors() that wraps calls to command
1007 functions. */
1008
1009 typedef void (catch_command_errors_ftype) (char *, int);
1010 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
1011
1012 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
1013
1014 extern void vwarning (const char *, va_list args);
1015
1016 /* List of known OS ABIs. If you change this, make sure to update the
1017 table in osabi.c. */
1018 enum gdb_osabi
1019 {
1020 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
1021
1022 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
1023
1024 GDB_OSABI_SVR4,
1025 GDB_OSABI_HURD,
1026 GDB_OSABI_SOLARIS,
1027 GDB_OSABI_OSF1,
1028 GDB_OSABI_LINUX,
1029 GDB_OSABI_FREEBSD_AOUT,
1030 GDB_OSABI_FREEBSD_ELF,
1031 GDB_OSABI_NETBSD_AOUT,
1032 GDB_OSABI_NETBSD_ELF,
1033 GDB_OSABI_OPENBSD_ELF,
1034 GDB_OSABI_WINCE,
1035 GDB_OSABI_GO32,
1036 GDB_OSABI_NETWARE,
1037 GDB_OSABI_IRIX,
1038 GDB_OSABI_LYNXOS,
1039 GDB_OSABI_INTERIX,
1040 GDB_OSABI_HPUX_ELF,
1041 GDB_OSABI_HPUX_SOM,
1042
1043 GDB_OSABI_ARM_EABI_V1,
1044 GDB_OSABI_ARM_EABI_V2,
1045 GDB_OSABI_ARM_APCS,
1046 GDB_OSABI_QNXNTO,
1047
1048 GDB_OSABI_CYGWIN,
1049
1050 GDB_OSABI_INVALID /* keep this last */
1051 };
1052
1053 /* Global functions from other, non-gdb GNU thingies.
1054 Libiberty thingies are no longer declared here. We include libiberty.h
1055 above, instead. */
1056
1057 /* From other system libraries */
1058
1059 #ifdef HAVE_STDDEF_H
1060 #include <stddef.h>
1061 #endif
1062
1063 #ifdef HAVE_STDLIB_H
1064 #include <stdlib.h>
1065 #endif
1066 #ifndef min
1067 #define min(a, b) ((a) < (b) ? (a) : (b))
1068 #endif
1069 #ifndef max
1070 #define max(a, b) ((a) > (b) ? (a) : (b))
1071 #endif
1072
1073
1074 #ifndef atof
1075 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1076 #endif
1077
1078 /* Various possibilities for alloca. */
1079 #ifndef alloca
1080 #ifdef __GNUC__
1081 #define alloca __builtin_alloca
1082 #else /* Not GNU C */
1083 #ifdef HAVE_ALLOCA_H
1084 #include <alloca.h>
1085 #else
1086 #ifdef _AIX
1087 #pragma alloca
1088 #else
1089
1090 /* We need to be careful not to declare this in a way which conflicts with
1091 bison. Bison never declares it as char *, but under various circumstances
1092 (like __hpux) we need to use void *. */
1093 extern void *alloca ();
1094 #endif /* Not _AIX */
1095 #endif /* Not HAVE_ALLOCA_H */
1096 #endif /* Not GNU C */
1097 #endif /* alloca not defined */
1098
1099 /* Dynamic target-system-dependent parameters for GDB. */
1100 #include "gdbarch.h"
1101
1102 /* Maximum size of a register. Something small, but large enough for
1103 all known ISAs. If it turns out to be too small, make it bigger. */
1104
1105 enum { MAX_REGISTER_SIZE = 16 };
1106
1107 /* Static target-system-dependent parameters for GDB. */
1108
1109 /* Number of bits in a char or unsigned char for the target machine.
1110 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1111 #if !defined (TARGET_CHAR_BIT)
1112 #define TARGET_CHAR_BIT 8
1113 #endif
1114
1115 /* If we picked up a copy of CHAR_BIT from a configuration file
1116 (which may get it by including <limits.h>) then use it to set
1117 the number of bits in a host char. If not, use the same size
1118 as the target. */
1119
1120 #if defined (CHAR_BIT)
1121 #define HOST_CHAR_BIT CHAR_BIT
1122 #else
1123 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1124 #endif
1125
1126 /* The bit byte-order has to do just with numbering of bits in
1127 debugging symbols and such. Conceptually, it's quite separate
1128 from byte/word byte order. */
1129
1130 #if !defined (BITS_BIG_ENDIAN)
1131 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1132 #endif
1133
1134 /* In findvar.c. */
1135
1136 extern LONGEST extract_signed_integer (const void *, int);
1137
1138 extern ULONGEST extract_unsigned_integer (const void *, int);
1139
1140 extern int extract_long_unsigned_integer (const void *, int, LONGEST *);
1141
1142 extern CORE_ADDR extract_typed_address (const void *buf, struct type *type);
1143
1144 extern void store_signed_integer (void *, int, LONGEST);
1145
1146 extern void store_unsigned_integer (void *, int, ULONGEST);
1147
1148 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1149
1150 \f
1151 /* From valops.c */
1152
1153 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1154
1155 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1156
1157 extern int watchdog;
1158
1159 /* Hooks for alternate command interfaces. */
1160
1161 /* The name of the interpreter if specified on the command line. */
1162 extern char *interpreter_p;
1163
1164 /* If a given interpreter matches INTERPRETER_P then it should update
1165 deprecated_command_loop_hook and deprecated_init_ui_hook with the
1166 per-interpreter implementation. */
1167 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1168 should be moved here. */
1169
1170 struct target_waitstatus;
1171 struct cmd_list_element;
1172
1173 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1174 extern void (*deprecated_post_add_symbol_hook) (void);
1175 extern void (*selected_frame_level_changed_hook) (int);
1176 extern int (*deprecated_ui_loop_hook) (int signo);
1177 extern void (*deprecated_init_ui_hook) (char *argv0);
1178 extern void (*deprecated_command_loop_hook) (void);
1179 extern void (*deprecated_show_load_progress) (const char *section,
1180 unsigned long section_sent,
1181 unsigned long section_size,
1182 unsigned long total_sent,
1183 unsigned long total_size);
1184 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1185 int line, int stopline,
1186 int noerror);
1187 extern struct frame_info *parse_frame_specification (char *frame_exp);
1188 extern int (*deprecated_query_hook) (const char *, va_list);
1189 extern void (*deprecated_warning_hook) (const char *, va_list);
1190 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1191 extern void (*deprecated_create_breakpoint_hook) (struct breakpoint * b);
1192 extern void (*deprecated_delete_breakpoint_hook) (struct breakpoint * bpt);
1193 extern void (*deprecated_modify_breakpoint_hook) (struct breakpoint * bpt);
1194 extern void (*deprecated_interactive_hook) (void);
1195 extern void (*deprecated_registers_changed_hook) (void);
1196 extern void (*deprecated_readline_begin_hook) (char *,...);
1197 extern char *(*deprecated_readline_hook) (char *);
1198 extern void (*deprecated_readline_end_hook) (void);
1199 extern void (*deprecated_register_changed_hook) (int regno);
1200 extern void (*deprecated_memory_changed_hook) (CORE_ADDR addr, int len);
1201 extern void (*deprecated_context_hook) (int);
1202 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1203 struct target_waitstatus * status);
1204
1205 extern void (*deprecated_attach_hook) (void);
1206 extern void (*deprecated_detach_hook) (void);
1207 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1208 char *cmd, int from_tty);
1209
1210 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1211
1212 extern void (*deprecated_error_hook) (void);
1213
1214 extern void (*deprecated_error_begin_hook) (void);
1215
1216 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1217 unsigned long num);
1218
1219
1220 /* Inhibit window interface if non-zero. */
1221
1222 extern int use_windows;
1223
1224 /* Symbolic definitions of filename-related things. */
1225 /* FIXME, this doesn't work very well if host and executable
1226 filesystems conventions are different. */
1227
1228 #ifndef DIRNAME_SEPARATOR
1229 #define DIRNAME_SEPARATOR ':'
1230 #endif
1231
1232 #ifndef SLASH_STRING
1233 #define SLASH_STRING "/"
1234 #endif
1235
1236 #ifdef __MSDOS__
1237 # define CANT_FORK
1238 # define GLOBAL_CURDIR
1239 #endif
1240
1241 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1242 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1243 in the code actually refer to a lightweight process id, i.e,
1244 something that can be considered a process id in its own right for
1245 certain purposes. */
1246
1247 #ifndef PIDGET
1248 #define PIDGET(PTID) (ptid_get_pid (PTID))
1249 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1250 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1251 #endif
1252
1253 /* Define well known filenos if the system does not define them. */
1254 #ifndef STDIN_FILENO
1255 #define STDIN_FILENO 0
1256 #endif
1257 #ifndef STDOUT_FILENO
1258 #define STDOUT_FILENO 1
1259 #endif
1260 #ifndef STDERR_FILENO
1261 #define STDERR_FILENO 2
1262 #endif
1263
1264 /* If this definition isn't overridden by the header files, assume
1265 that isatty and fileno exist on this system. */
1266 #ifndef ISATTY
1267 #define ISATTY(FP) (isatty (fileno (FP)))
1268 #endif
1269
1270 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1271 power of 2). Round up/down when necessary. Examples of correct
1272 use include:
1273
1274 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1275 write_memory (addr, value, len);
1276 addr += len;
1277
1278 and:
1279
1280 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1281 write_memory (sp, value, len);
1282
1283 Note that uses such as:
1284
1285 write_memory (addr, value, len);
1286 addr += align_up (len, 8);
1287
1288 and:
1289
1290 sp -= align_up (len, 8);
1291 write_memory (sp, value, len);
1292
1293 are typically not correct as they don't ensure that the address (SP
1294 or ADDR) is correctly aligned (relying on previous alignment to
1295 keep things right). This is also why the methods are called
1296 "align_..." instead of "round_..." as the latter reads better with
1297 this incorrect coding style. */
1298
1299 extern ULONGEST align_up (ULONGEST v, int n);
1300 extern ULONGEST align_down (ULONGEST v, int n);
1301
1302 #endif /* #ifndef DEFS_H */
This page took 0.055444 seconds and 4 git commands to generate.