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.
7 This file is part of GDB.
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.
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.
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. */
27 #include "config.h" /* Generated by configure */
29 #include <errno.h> /* System call error return status */
35 #include <sys/types.h> /* for size_t */
42 /* Just in case they're not defined in stdio.h. */
51 /* First include ansidecl.h so we can use the various macro definitions
52 here and in all subsequent file inclusions. */
56 #include <stdarg.h> /* for va_list */
58 #include "libiberty.h"
66 /* For BFD64 and bfd_vma. */
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). */
74 #define GDB_MULTI_ARCH_PARTIAL 1
76 /* The target is partially multi-arched. Both the multi-arch vector
77 and "tm.h" provide definitions. "tm.h" cannot override a definition
78 provided by the multi-arch vector. It is detected as a compilation
81 This setting is only useful during a multi-arch conversion. */
83 #define GDB_MULTI_ARCH_TM 2
85 /* The target is pure multi-arch. The MULTI-ARCH vector provides all
86 definitions. "tm.h" is linked to an empty file. */
88 #define GDB_MULTI_ARCH_PURE 3
92 /* An address in the program being debugged. Host byte order. Rather
93 than duplicate all the logic in BFD which figures out what type
94 this is (long, long long, etc.) and whether it needs to be 64
95 bits (the host/target interactions are subtle), we just use
98 typedef bfd_vma CORE_ADDR;
100 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
106 #define LONGEST BFD_HOST_64_BIT
107 #define ULONGEST BFD_HOST_U_64_BIT
111 #ifdef CC_HAS_LONG_LONG
112 #define LONGEST long long
113 #define ULONGEST unsigned long long
115 #ifdef BFD_HOST_64_BIT
116 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
117 (e.g. i386-windows) so try it. */
118 #define LONGEST BFD_HOST_64_BIT
119 #define ULONGEST BFD_HOST_U_64_BIT
122 #define ULONGEST unsigned long
126 #endif /* No BFD64 */
128 #endif /* ! LONGEST */
131 #define min(a, b) ((a) < (b) ? (a) : (b))
134 #define max(a, b) ((a) > (b) ? (a) : (b))
137 /* Macros to do string compares.
139 NOTE: cagney/2000-03-14:
141 While old code can continue to refer to these macros, new code is
142 probably better off using strcmp() directly vis: ``strcmp() == 0''
143 and ``strcmp() != 0''.
145 This is because modern compilers can directly inline strcmp()
146 making the original justification for these macros - avoid function
147 call overhead by pre-testing the first characters
148 (``*X==*Y?...:0'') - redundant.
150 ``Even if [...] testing the first character does have a modest
151 performance improvement, I'd rather that whenever a performance
152 issue is found that we spend the effort on algorithmic
153 optimizations than micro-optimizing.'' J.T. */
155 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
156 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
158 /* The character GNU C++ uses to build identifiers that must be unique from
159 the program's identifiers (such as $this and $$vptr). */
160 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
162 /* Check if a character is one of the commonly used C++ marker characters. */
163 extern int is_cplus_marker (int);
165 /* use tui interface if non-zero */
166 extern int tui_version;
168 /* enable xdb commands if set */
169 extern int xdb_commands;
171 /* enable dbx commands if set */
172 extern int dbx_commands;
174 extern int quit_flag;
175 extern int immediate_quit;
176 extern int sevenbit_strings;
178 extern void quit (void);
180 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
181 benefits of having a ``QUIT'' macro rather than a function are
182 marginal. If the overhead of a QUIT function call is proving
183 significant then its calling frequency should probably be reduced
184 [kingdon]. A profile analyzing the current situtation is
188 /* do twice to force compiler warning */
189 #define QUIT_FIXME "FIXME"
190 #define QUIT_FIXME "ignoring redefinition of QUIT"
193 if (quit_flag) quit (); \
194 if (interactive_hook) interactive_hook (); \
199 /* Languages represented in the symbol table and elsewhere.
200 This should probably be in language.h, but since enum's can't
201 be forward declared to satisfy opaque references before their
202 actual definition, needs to be here. */
206 language_unknown, /* Language not known */
207 language_auto, /* Placeholder for automatic setting */
209 language_cplus, /* C++ */
210 language_java, /* Java */
211 language_chill, /* Chill */
212 language_fortran, /* Fortran */
213 language_m2, /* Modula-2 */
214 language_asm, /* Assembly language */
215 language_scm, /* Scheme / Guile */
216 language_pascal /* Pascal */
223 unspecified_precision
226 /* The numbering of these signals is chosen to match traditional unix
227 signals (insofar as various unices use the same numbers, anyway).
228 It is also the numbering of the GDB remote protocol. Other remote
229 protocols, if they use a different numbering, should make sure to
230 translate appropriately.
232 Since these numbers have actually made it out into other software
233 (stubs, etc.), you mustn't disturb the assigned numbering. If you
234 need to add new signals here, add them to the end of the explicitly
237 This is based strongly on Unix/POSIX signals for several reasons:
238 (1) This set of signals represents a widely-accepted attempt to
239 represent events of this sort in a portable fashion, (2) we want a
240 signal to make it from wait to child_wait to the user intact, (3) many
241 remote protocols use a similar encoding. However, it is
242 recognized that this set of signals has limitations (such as not
243 distinguishing between various kinds of SIGSEGV, or not
244 distinguishing hitting a breakpoint from finishing a single step).
245 So in the future we may get around this either by adding additional
246 signals for breakpoint, single-step, etc., or by adding signal
247 codes; the latter seems more in the spirit of what BSD, System V,
248 etc. are doing to address these issues. */
250 /* For an explanation of what each signal means, see
251 target_signal_to_string. */
255 /* Used some places (e.g. stop_signal) to record the concept that
256 there is no signal. */
258 TARGET_SIGNAL_FIRST = 0,
259 TARGET_SIGNAL_HUP = 1,
260 TARGET_SIGNAL_INT = 2,
261 TARGET_SIGNAL_QUIT = 3,
262 TARGET_SIGNAL_ILL = 4,
263 TARGET_SIGNAL_TRAP = 5,
264 TARGET_SIGNAL_ABRT = 6,
265 TARGET_SIGNAL_EMT = 7,
266 TARGET_SIGNAL_FPE = 8,
267 TARGET_SIGNAL_KILL = 9,
268 TARGET_SIGNAL_BUS = 10,
269 TARGET_SIGNAL_SEGV = 11,
270 TARGET_SIGNAL_SYS = 12,
271 TARGET_SIGNAL_PIPE = 13,
272 TARGET_SIGNAL_ALRM = 14,
273 TARGET_SIGNAL_TERM = 15,
274 TARGET_SIGNAL_URG = 16,
275 TARGET_SIGNAL_STOP = 17,
276 TARGET_SIGNAL_TSTP = 18,
277 TARGET_SIGNAL_CONT = 19,
278 TARGET_SIGNAL_CHLD = 20,
279 TARGET_SIGNAL_TTIN = 21,
280 TARGET_SIGNAL_TTOU = 22,
281 TARGET_SIGNAL_IO = 23,
282 TARGET_SIGNAL_XCPU = 24,
283 TARGET_SIGNAL_XFSZ = 25,
284 TARGET_SIGNAL_VTALRM = 26,
285 TARGET_SIGNAL_PROF = 27,
286 TARGET_SIGNAL_WINCH = 28,
287 TARGET_SIGNAL_LOST = 29,
288 TARGET_SIGNAL_USR1 = 30,
289 TARGET_SIGNAL_USR2 = 31,
290 TARGET_SIGNAL_PWR = 32,
291 /* Similar to SIGIO. Perhaps they should have the same number. */
292 TARGET_SIGNAL_POLL = 33,
293 TARGET_SIGNAL_WIND = 34,
294 TARGET_SIGNAL_PHONE = 35,
295 TARGET_SIGNAL_WAITING = 36,
296 TARGET_SIGNAL_LWP = 37,
297 TARGET_SIGNAL_DANGER = 38,
298 TARGET_SIGNAL_GRANT = 39,
299 TARGET_SIGNAL_RETRACT = 40,
300 TARGET_SIGNAL_MSG = 41,
301 TARGET_SIGNAL_SOUND = 42,
302 TARGET_SIGNAL_SAK = 43,
303 TARGET_SIGNAL_PRIO = 44,
304 TARGET_SIGNAL_REALTIME_33 = 45,
305 TARGET_SIGNAL_REALTIME_34 = 46,
306 TARGET_SIGNAL_REALTIME_35 = 47,
307 TARGET_SIGNAL_REALTIME_36 = 48,
308 TARGET_SIGNAL_REALTIME_37 = 49,
309 TARGET_SIGNAL_REALTIME_38 = 50,
310 TARGET_SIGNAL_REALTIME_39 = 51,
311 TARGET_SIGNAL_REALTIME_40 = 52,
312 TARGET_SIGNAL_REALTIME_41 = 53,
313 TARGET_SIGNAL_REALTIME_42 = 54,
314 TARGET_SIGNAL_REALTIME_43 = 55,
315 TARGET_SIGNAL_REALTIME_44 = 56,
316 TARGET_SIGNAL_REALTIME_45 = 57,
317 TARGET_SIGNAL_REALTIME_46 = 58,
318 TARGET_SIGNAL_REALTIME_47 = 59,
319 TARGET_SIGNAL_REALTIME_48 = 60,
320 TARGET_SIGNAL_REALTIME_49 = 61,
321 TARGET_SIGNAL_REALTIME_50 = 62,
322 TARGET_SIGNAL_REALTIME_51 = 63,
323 TARGET_SIGNAL_REALTIME_52 = 64,
324 TARGET_SIGNAL_REALTIME_53 = 65,
325 TARGET_SIGNAL_REALTIME_54 = 66,
326 TARGET_SIGNAL_REALTIME_55 = 67,
327 TARGET_SIGNAL_REALTIME_56 = 68,
328 TARGET_SIGNAL_REALTIME_57 = 69,
329 TARGET_SIGNAL_REALTIME_58 = 70,
330 TARGET_SIGNAL_REALTIME_59 = 71,
331 TARGET_SIGNAL_REALTIME_60 = 72,
332 TARGET_SIGNAL_REALTIME_61 = 73,
333 TARGET_SIGNAL_REALTIME_62 = 74,
334 TARGET_SIGNAL_REALTIME_63 = 75,
336 /* Used internally by Solaris threads. See signal(5) on Solaris. */
337 TARGET_SIGNAL_CANCEL = 76,
339 /* Yes, this pains me, too. But LynxOS didn't have SIG32, and now
340 Linux does, and we can't disturb the numbering, since it's part
341 of the remote protocol. Note that in some GDB's
342 TARGET_SIGNAL_REALTIME_32 is number 76. */
343 TARGET_SIGNAL_REALTIME_32,
344 /* Yet another pain, IRIX 6 has SIG64. */
345 TARGET_SIGNAL_REALTIME_64,
346 /* Yet another pain, Linux/MIPS might go up to 128. */
347 TARGET_SIGNAL_REALTIME_65,
348 TARGET_SIGNAL_REALTIME_66,
349 TARGET_SIGNAL_REALTIME_67,
350 TARGET_SIGNAL_REALTIME_68,
351 TARGET_SIGNAL_REALTIME_69,
352 TARGET_SIGNAL_REALTIME_70,
353 TARGET_SIGNAL_REALTIME_71,
354 TARGET_SIGNAL_REALTIME_72,
355 TARGET_SIGNAL_REALTIME_73,
356 TARGET_SIGNAL_REALTIME_74,
357 TARGET_SIGNAL_REALTIME_75,
358 TARGET_SIGNAL_REALTIME_76,
359 TARGET_SIGNAL_REALTIME_77,
360 TARGET_SIGNAL_REALTIME_78,
361 TARGET_SIGNAL_REALTIME_79,
362 TARGET_SIGNAL_REALTIME_80,
363 TARGET_SIGNAL_REALTIME_81,
364 TARGET_SIGNAL_REALTIME_82,
365 TARGET_SIGNAL_REALTIME_83,
366 TARGET_SIGNAL_REALTIME_84,
367 TARGET_SIGNAL_REALTIME_85,
368 TARGET_SIGNAL_REALTIME_86,
369 TARGET_SIGNAL_REALTIME_87,
370 TARGET_SIGNAL_REALTIME_88,
371 TARGET_SIGNAL_REALTIME_89,
372 TARGET_SIGNAL_REALTIME_90,
373 TARGET_SIGNAL_REALTIME_91,
374 TARGET_SIGNAL_REALTIME_92,
375 TARGET_SIGNAL_REALTIME_93,
376 TARGET_SIGNAL_REALTIME_94,
377 TARGET_SIGNAL_REALTIME_95,
378 TARGET_SIGNAL_REALTIME_96,
379 TARGET_SIGNAL_REALTIME_97,
380 TARGET_SIGNAL_REALTIME_98,
381 TARGET_SIGNAL_REALTIME_99,
382 TARGET_SIGNAL_REALTIME_100,
383 TARGET_SIGNAL_REALTIME_101,
384 TARGET_SIGNAL_REALTIME_102,
385 TARGET_SIGNAL_REALTIME_103,
386 TARGET_SIGNAL_REALTIME_104,
387 TARGET_SIGNAL_REALTIME_105,
388 TARGET_SIGNAL_REALTIME_106,
389 TARGET_SIGNAL_REALTIME_107,
390 TARGET_SIGNAL_REALTIME_108,
391 TARGET_SIGNAL_REALTIME_109,
392 TARGET_SIGNAL_REALTIME_110,
393 TARGET_SIGNAL_REALTIME_111,
394 TARGET_SIGNAL_REALTIME_112,
395 TARGET_SIGNAL_REALTIME_113,
396 TARGET_SIGNAL_REALTIME_114,
397 TARGET_SIGNAL_REALTIME_115,
398 TARGET_SIGNAL_REALTIME_116,
399 TARGET_SIGNAL_REALTIME_117,
400 TARGET_SIGNAL_REALTIME_118,
401 TARGET_SIGNAL_REALTIME_119,
402 TARGET_SIGNAL_REALTIME_120,
403 TARGET_SIGNAL_REALTIME_121,
404 TARGET_SIGNAL_REALTIME_122,
405 TARGET_SIGNAL_REALTIME_123,
406 TARGET_SIGNAL_REALTIME_124,
407 TARGET_SIGNAL_REALTIME_125,
408 TARGET_SIGNAL_REALTIME_126,
409 TARGET_SIGNAL_REALTIME_127,
411 #if defined(MACH) || defined(__MACH__)
412 /* Mach exceptions */
413 TARGET_EXC_BAD_ACCESS,
414 TARGET_EXC_BAD_INSTRUCTION,
415 TARGET_EXC_ARITHMETIC,
416 TARGET_EXC_EMULATION,
418 TARGET_EXC_BREAKPOINT,
422 /* Some signal we don't know about. */
423 TARGET_SIGNAL_UNKNOWN,
425 /* Use whatever signal we use when one is not specifically specified
426 (for passing to proceed and so on). */
427 TARGET_SIGNAL_DEFAULT,
429 /* Last and unused enum value, for sizing arrays, etc. */
433 /* the cleanup list records things that have to be undone
434 if an error happens (descriptors to be closed, memory to be freed, etc.)
435 Each link in the chain records a function to call and an
438 Use make_cleanup to add an element to the cleanup chain.
439 Use do_cleanups to do all cleanup actions back to a given
440 point in the chain. Use discard_cleanups to remove cleanups
441 from the chain back to a given point, not doing them. */
445 struct cleanup *next;
446 void (*function) (PTR);
451 /* The ability to declare that a function never returns is useful, but
452 not really required to compile GDB successfully, so the NORETURN and
453 ATTR_NORETURN macros normally expand into nothing. */
455 /* If compiling with older versions of GCC, a function may be declared
456 "volatile" to indicate that it does not return. */
459 #if defined(__GNUC__) \
460 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
461 #define NORETURN volatile
463 #define NORETURN /* nothing */
467 /* GCC 2.5 and later versions define a function attribute "noreturn",
468 which is the preferred way to declare that a function never returns.
469 However GCC 2.7 appears to be the first version in which this fully
470 works everywhere we use it. */
472 #ifndef ATTR_NORETURN
473 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
474 #define ATTR_NORETURN __attribute__ ((noreturn))
476 #define ATTR_NORETURN /* nothing */
481 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
482 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
484 #define ATTR_FORMAT(type, x, y) /* nothing */
488 /* Needed for various prototypes */
493 /* From blockframe.c */
495 extern int inside_entry_func (CORE_ADDR);
497 extern int inside_entry_file (CORE_ADDR addr);
499 extern int inside_main_func (CORE_ADDR pc);
501 /* From ch-lang.c, for the moment. (FIXME) */
503 extern char *chill_demangle (const char *);
507 extern void initialize_utils (void);
509 extern void notice_quit (void);
511 extern int strcmp_iw (const char *, const char *);
513 extern int subset_compare (char *, char *);
515 extern char *safe_strerror (int);
517 extern void init_malloc (void *);
519 extern void request_quit (int);
521 extern void do_cleanups (struct cleanup *);
522 extern void do_final_cleanups (struct cleanup *);
523 extern void do_my_cleanups (struct cleanup **, struct cleanup *);
524 extern void do_run_cleanups (struct cleanup *);
525 extern void do_exec_cleanups (struct cleanup *);
526 extern void do_exec_error_cleanups (struct cleanup *);
528 extern void discard_cleanups (struct cleanup *);
529 extern void discard_final_cleanups (struct cleanup *);
530 extern void discard_exec_error_cleanups (struct cleanup *);
531 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
533 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
534 make_cleanup function declarations below. Do not use this typedef
535 as a cast when passing functions into the make_cleanup() code.
536 Instead either use a bounce function or add a wrapper function.
537 Calling a f(char*) function with f(void*) is non-portable. */
538 typedef void (make_cleanup_ftype) (void *);
540 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
542 extern struct cleanup *make_cleanup_freeargv (char **);
545 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
547 extern struct cleanup *make_cleanup_close (int fd);
549 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
551 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
553 extern struct cleanup *make_my_cleanup (struct cleanup **,
554 make_cleanup_ftype *, void *);
556 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
558 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
559 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
561 extern struct cleanup *save_cleanups (void);
562 extern struct cleanup *save_final_cleanups (void);
563 extern struct cleanup *save_my_cleanups (struct cleanup **);
565 extern void restore_cleanups (struct cleanup *);
566 extern void restore_final_cleanups (struct cleanup *);
567 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
569 extern void free_current_contents (void *);
571 extern void null_cleanup (void *);
573 extern int myread (int, char *, int);
575 extern int query (char *, ...) ATTR_FORMAT (printf, 1, 2);
577 extern void init_page_info (void);
579 extern CORE_ADDR host_pointer_to_address (void *ptr);
580 extern void *address_to_host_pointer (CORE_ADDR addr);
582 /* From demangle.c */
584 extern void set_demangling_style (char *);
589 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
590 extern use_struct_convention_fn generic_use_struct_convention;
592 typedef unsigned char *(breakpoint_from_pc_fn) (CORE_ADDR * pcptr, int *lenptr);
594 /* Annotation stuff. */
596 extern int annotation_level; /* in stack.c */
598 extern void begin_line (void);
600 extern void wrap_here (char *);
602 extern void reinitialize_more_filter (void);
605 extern struct ui_file *gdb_stdout;
606 /* Serious error notifications */
607 extern struct ui_file *gdb_stderr;
608 /* Log/debug/trace messages that should bypass normal stdout/stderr
609 filtering. For momement, always call this stream using
610 *_unfiltered. In the very near future that restriction shall be
611 removed - either call shall be unfiltered. (cagney 1999-06-13). */
612 extern struct ui_file *gdb_stdlog;
613 /* Target output that should bypass normal stdout/stderr filtering.
614 For momement, always call this stream using *_unfiltered. In the
615 very near future that restriction shall be removed - either call
616 shall be unfiltered. (cagney 1999-07-02). */
617 extern struct ui_file *gdb_stdtarg;
625 /* More generic printf like operations. Filtered versions may return
626 non-locally on error. */
628 extern void fputs_filtered (const char *, struct ui_file *);
630 extern void fputs_unfiltered (const char *, struct ui_file *);
632 extern int fputc_filtered (int c, struct ui_file *);
634 extern int fputc_unfiltered (int c, struct ui_file *);
636 extern int putchar_filtered (int c);
638 extern int putchar_unfiltered (int c);
640 extern void puts_filtered (const char *);
642 extern void puts_unfiltered (const char *);
644 extern void puts_debug (char *prefix, char *string, char *suffix);
646 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
648 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
650 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
652 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
654 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
656 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
658 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
660 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
662 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
664 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
666 extern void print_spaces (int, struct ui_file *);
668 extern void print_spaces_filtered (int, struct ui_file *);
670 extern char *n_spaces (int);
672 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
674 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
676 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
678 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
679 extern void gdb_print_host_address (void *addr, struct ui_file *stream);
681 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
682 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
684 extern int strlen_paddr (void);
685 extern char *paddr (CORE_ADDR addr);
686 extern char *paddr_nz (CORE_ADDR addr);
687 extern char *paddr_u (CORE_ADDR addr);
688 extern char *paddr_d (LONGEST addr);
690 extern char *phex (ULONGEST l, int sizeof_l);
691 extern char *phex_nz (ULONGEST l, int sizeof_l);
693 /* Like paddr() only print/scan raw CORE_ADDR. The output from
694 core_addr_to_string() can be passed direct to
695 string_to_core_addr(). */
696 extern const char *core_addr_to_string (const CORE_ADDR addr);
697 extern CORE_ADDR string_to_core_addr (const char *my_string);
699 extern void fprintf_symbol_filtered (struct ui_file *, char *,
702 extern NORETURN void perror_with_name (char *) ATTR_NORETURN;
704 extern void print_sys_errmsg (char *, int);
706 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
707 "const char *" in unistd.h, so we can't declare the argument
710 extern char *re_comp (const char *);
714 extern void symbol_file_command (char *, int);
716 /* Remote targets may wish to use this as their load function. */
717 extern void generic_load (char *name, int from_tty);
719 /* Summarise a download */
720 extern void print_transfer_performance (struct ui_file *stream,
721 unsigned long data_count,
722 unsigned long write_count,
723 unsigned long time_count);
727 typedef void initialize_file_ftype (void);
729 extern char *skip_quoted (char *);
731 extern char *gdb_readline (char *);
733 extern char *command_line_input (char *, int, char *);
735 extern void print_prompt (void);
737 extern int input_from_terminal_p (void);
739 extern int info_verbose;
741 /* From printcmd.c */
743 extern void set_next_address (CORE_ADDR);
745 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
748 extern int build_address_symbolic (CORE_ADDR addr,
756 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
758 extern void print_address (CORE_ADDR, struct ui_file *);
762 extern int openp (const char *, int, const char *, int, int, char **);
764 extern int source_full_path_of (char *, char **);
766 extern void mod_path (char *, char **);
768 extern void directory_command (char *, int);
770 extern void init_source_path (void);
772 extern char *symtab_to_filename (struct symtab *);
776 extern void exec_set_section_offsets (bfd_signed_vma text_off,
777 bfd_signed_vma data_off,
778 bfd_signed_vma bss_off);
782 extern int read_relative_register_raw_bytes (int, char *);
784 /* Possible lvalue types. Like enum language, this should be in
785 value.h, but needs to be here for the same reason. */
791 /* In memory. Could be a saved register. */
795 /* In a gdb internal variable. */
797 /* Part of a gdb internal variable (structure field). */
798 lval_internalvar_component,
799 /* In a register series in a frame not the current one, which may have been
800 partially saved or saved in different places (otherwise would be
801 lval_register or lval_memory). */
802 lval_reg_frame_relative
807 /* From readline (but not in any readline .h files). */
809 extern char *tilde_expand (char *);
811 /* Control types for commands */
813 enum misc_command_type
821 enum command_control_type
831 /* Structure for saved commands lines
832 (for breakpoints, defined commands, etc). */
836 struct command_line *next;
838 enum command_control_type control_type;
840 struct command_line **body_list;
843 extern struct command_line *read_command_lines (char *, int);
845 extern void free_command_lines (struct command_line **);
847 /* To continue the execution commands when running gdb asynchronously.
848 A continuation structure contains a pointer to a function to be called
849 to finish the command, once the target has stopped. Such mechanism is
850 used bt the finish and until commands, and in the remote protocol
851 when opening an extended-remote connection. */
853 struct continuation_arg
855 struct continuation_arg *next;
856 union continuation_data {
865 void (*continuation_hook) (struct continuation_arg *);
866 struct continuation_arg *arg_list;
867 struct continuation *next;
871 extern struct continuation *cmd_continuation;
872 /* Used only by the step_1 function. */
873 extern struct continuation *intermediate_continuation;
876 extern void add_continuation (void (*)(struct continuation_arg *),
877 struct continuation_arg *);
878 extern void do_all_continuations (void);
879 extern void discard_all_continuations (void);
881 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
882 struct continuation_arg *);
883 extern void do_all_intermediate_continuations (void);
884 extern void discard_all_intermediate_continuations (void);
886 /* String containing the current directory (what getwd would return). */
888 extern char *current_directory;
890 /* Default radixes for input and output. Only some values supported. */
891 extern unsigned input_radix;
892 extern unsigned output_radix;
894 /* Possibilities for prettyprint parameters to routines which print
895 things. Like enum language, this should be in value.h, but needs
896 to be here for the same reason. FIXME: If we can eliminate this
897 as an arg to LA_VAL_PRINT, then we can probably move it back to
902 Val_no_prettyprint = 0,
904 /* Use the default setting which the user has specified. */
908 /* The ptid struct is a collection of the various "ids" necessary
909 for identifying the inferior. This consists of the process id
910 (pid), thread id (tid), and other fields necessary for uniquely
911 identifying the inferior process/thread being debugged. When
912 manipulating ptids, the constructors, accessors, and predicate
913 declared in inferior.h should be used. These are as follows:
915 ptid_build - Make a new ptid from a pid, lwp, and tid.
916 pid_to_ptid - Make a new ptid from just a pid.
917 ptid_get_pid - Fetch the pid component of a ptid.
918 ptid_get_lwp - Fetch the lwp component of a ptid.
919 ptid_get_tid - Fetch the tid component of a ptid.
920 ptid_equal - Test to see if two ptids are equal.
922 Please do NOT access the struct ptid members directly (except, of
923 course, in the implementation of the above ptid manipulation
931 /* Lightweight process id */
938 typedef struct ptid ptid_t;
942 /* Optional host machine definition. Pure autoconf targets will not
943 need a "xm.h" file. This will be a symlink to one of the xm-*.h
944 files, built by the `configure' script. */
950 /* Optional native machine support. Non-native (and possibly pure
951 multi-arch) targets do not need a "nm.h" file. This will be a
952 symlink to one of the nm-*.h files, built by the `configure'
959 /* Optional target machine definition. Pure multi-arch configurations
960 do not need a "tm.h" file. This will be a symlink to one of the
961 tm-*.h files, built by the `configure' script. */
967 /* GDB_MULTI_ARCH is normally set by configure.in using information
968 from configure.tgt or the config/%/%.mt Makefile fragment. Since
969 some targets have defined it in their "tm.h" file, delay providing
970 a default definition until after "tm.h" has been included.. */
972 #ifndef GDB_MULTI_ARCH
973 #define GDB_MULTI_ARCH 0
977 /* If the xm.h file did not define the mode string used to open the
978 files, assume that binary files are opened the same way as text
981 #include "fopen-same.h"
984 #define CONST_PTR const
986 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
987 FIXME: Assumes 2's complement arithmetic */
989 #if !defined (UINT_MAX)
990 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
993 #if !defined (INT_MAX)
994 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
997 #if !defined (INT_MIN)
998 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
1001 #if !defined (ULONG_MAX)
1002 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
1005 #if !defined (LONG_MAX)
1006 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
1009 #if !defined (ULONGEST_MAX)
1010 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
1013 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
1014 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
1017 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
1018 arguments to a function, number in a value history, register number, etc.)
1019 where the value must not be larger than can fit in an int. */
1021 extern int longest_to_int (LONGEST);
1023 /* Assorted functions we can declare, now that const and volatile are
1026 extern char *savestring (const char *, size_t);
1028 extern char *msavestring (void *, const char *, size_t);
1030 extern char *mstrsave (void *, const char *);
1032 #if !defined (USE_MMALLOC)
1033 /* NOTE: cagney/2000-03-04: The mmalloc functions need to use PTR
1034 rather than void* so that they are consistent with the delcaration
1035 in ../mmalloc/mmalloc.h. */
1036 extern PTR mcalloc (PTR, size_t, size_t);
1037 extern PTR mmalloc (PTR, size_t);
1038 extern PTR mrealloc (PTR, PTR, size_t);
1039 extern void mfree (PTR, PTR);
1042 /* Robust versions of same. Throw an internal error when no memory,
1043 guard against stray NULL arguments. */
1044 extern void *xmmalloc (void *md, size_t size);
1045 extern void *xmrealloc (void *md, void *ptr, size_t size);
1046 extern void *xmcalloc (void *md, size_t number, size_t size);
1047 extern void xmfree (void *md, void *ptr);
1049 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
1051 extern void xfree (void *);
1053 /* Like asprintf/vasprintf but get an internal_error if the call
1055 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
1056 extern void xvasprintf (char **ret, const char *format, va_list ap);
1058 extern int parse_escape (char **);
1060 /* Message to be printed before the error message, when an error occurs. */
1062 extern char *error_pre_print;
1064 /* Message to be printed before the error message, when an error occurs. */
1066 extern char *quit_pre_print;
1068 /* Message to be printed before the warning message, when a warning occurs. */
1070 extern char *warning_pre_print;
1072 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
1074 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN;
1076 /* DEPRECATED: Use error(), verror() or error_stream(). */
1077 extern NORETURN void error_begin (void);
1079 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
1081 /* Returns a freshly allocate buffer containing the last error
1083 extern char *error_last_message (void);
1085 extern NORETURN void internal_verror (const char *file, int line,
1086 const char *, va_list ap) ATTR_NORETURN;
1088 extern NORETURN void internal_error (const char *file, int line,
1089 const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
1091 extern NORETURN void nomem (long) ATTR_NORETURN;
1093 /* Reasons for calling return_to_top_level. NOTE: all reason values
1094 must be less than zero. enum value 0 is reserved for internal use
1095 as the return value from an initial setjmp(). The function
1096 catch_exceptions() reserves values >= 0 as legal results from its
1097 wrapped function. */
1101 /* User interrupt. */
1103 /* Any other error. */
1107 #define ALL_CLEANUPS ((struct cleanup *)0)
1109 #define RETURN_MASK(reason) (1 << (int)(-reason))
1110 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
1111 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
1112 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
1113 typedef int return_mask;
1115 extern NORETURN void return_to_top_level (enum return_reason) ATTR_NORETURN;
1117 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
1118 handler. If an exception (enum return_reason) is thrown using
1119 return_to_top_level() than all cleanups installed since
1120 catch_exceptions() was entered are invoked, the (-ve) exception
1121 value is then returned by catch_exceptions. If FUNC() returns
1122 normally (with a postive or zero return value) then that value is
1123 returned by catch_exceptions(). It is an internal_error() for
1124 FUNC() to return a negative value.
1126 For the period of the FUNC() call: UIOUT is installed as the output
1127 builder; ERRSTRING is installed as the error/quit message; and a
1128 new cleanup_chain is established. The old values are restored
1129 before catch_exceptions() returns.
1131 FIXME; cagney/2001-08-13: The need to override the global UIOUT
1132 builder variable should just go away.
1134 This function superseeds catch_errors().
1136 This function uses SETJMP() and LONGJUMP(). */
1139 typedef int (catch_exceptions_ftype) (struct ui_out *ui_out, void *args);
1140 extern int catch_exceptions (struct ui_out *uiout,
1141 catch_exceptions_ftype *func, void *func_args,
1142 char *errstring, return_mask mask);
1144 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
1145 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
1146 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
1147 value. It's unfortunate that, catch_errors() does not return an
1148 indication of the exact exception that it caught - quit_flag might
1151 This function is superseeded by catch_exceptions(). */
1153 typedef int (catch_errors_ftype) (PTR);
1154 extern int catch_errors (catch_errors_ftype *, PTR, char *, return_mask);
1156 /* Template to catch_errors() that wraps calls to command
1159 typedef void (catch_command_errors_ftype) (char *, int);
1160 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
1162 extern void warning_begin (void);
1164 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
1166 /* Global functions from other, non-gdb GNU thingies.
1167 Libiberty thingies are no longer declared here. We include libiberty.h
1170 #ifndef GETENV_PROVIDED
1171 extern char *getenv (const char *);
1174 /* From other system libraries */
1176 #ifdef HAVE_STDDEF_H
1180 #ifdef HAVE_STDLIB_H
1184 #define min(a, b) ((a) < (b) ? (a) : (b))
1187 #define max(a, b) ((a) > (b) ? (a) : (b))
1191 /* We take the address of fclose later, but some stdio's forget
1192 to declare this. We can't always declare it since there's
1193 no way to declare the parameters without upsetting some compiler
1196 #ifndef FCLOSE_PROVIDED
1197 extern int fclose (FILE *);
1201 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1204 /* Various possibilities for alloca. */
1207 #define alloca __builtin_alloca
1208 #else /* Not GNU C */
1209 #ifdef HAVE_ALLOCA_H
1216 /* We need to be careful not to declare this in a way which conflicts with
1217 bison. Bison never declares it as char *, but under various circumstances
1218 (like __hpux) we need to use void *. */
1219 extern void *alloca ();
1220 #endif /* Not _AIX */
1221 #endif /* Not HAVE_ALLOCA_H */
1222 #endif /* Not GNU C */
1223 #endif /* alloca not defined */
1225 /* HOST_BYTE_ORDER must be defined to one of these. */
1227 #ifdef HAVE_ENDIAN_H
1231 #if !defined (BIG_ENDIAN)
1232 #define BIG_ENDIAN 4321
1235 #if !defined (LITTLE_ENDIAN)
1236 #define LITTLE_ENDIAN 1234
1239 /* Dynamic target-system-dependent parameters for GDB. */
1240 #include "gdbarch.h"
1241 #if (GDB_MULTI_ARCH == 0)
1242 /* Multi-arch targets _should_ be including "arch-utils.h" directly
1243 into their *-tdep.c file. This is a prop to help old non-
1244 multi-arch targets to continue to compile. */
1245 #include "arch-utils.h"
1248 /* Static target-system-dependent parameters for GDB. */
1250 /* Number of bits in a char or unsigned char for the target machine.
1251 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1252 #if !defined (TARGET_CHAR_BIT)
1253 #define TARGET_CHAR_BIT 8
1256 /* If we picked up a copy of CHAR_BIT from a configuration file
1257 (which may get it by including <limits.h>) then use it to set
1258 the number of bits in a host char. If not, use the same size
1261 #if defined (CHAR_BIT)
1262 #define HOST_CHAR_BIT CHAR_BIT
1264 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1267 /* The bit byte-order has to do just with numbering of bits in
1268 debugging symbols and such. Conceptually, it's quite separate
1269 from byte/word byte order. */
1271 #if !defined (BITS_BIG_ENDIAN)
1272 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
1277 extern LONGEST extract_signed_integer (void *, int);
1279 extern ULONGEST extract_unsigned_integer (void *, int);
1281 extern int extract_long_unsigned_integer (void *, int, LONGEST *);
1283 extern CORE_ADDR extract_address (void *, int);
1285 extern CORE_ADDR extract_typed_address (void *buf, struct type *type);
1287 extern void store_signed_integer (void *, int, LONGEST);
1289 extern void store_unsigned_integer (void *, int, ULONGEST);
1291 extern void store_address (void *, int, LONGEST);
1293 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1298 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1300 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1302 extern int watchdog;
1304 /* Hooks for alternate command interfaces. */
1307 /* The name of the interpreter if specified on the command line. */
1308 extern char *interpreter_p;
1311 /* If a given interpreter matches INTERPRETER_P then it should update
1312 command_loop_hook and init_ui_hook with the per-interpreter
1314 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1316 struct target_waitstatus;
1317 struct cmd_list_element;
1319 /* Should the asynchronous variant of the interpreter (using the
1320 event-loop) be enabled? */
1321 extern int event_loop_p;
1323 extern void (*init_ui_hook) (char *argv0);
1324 extern void (*command_loop_hook) (void);
1325 extern void (*show_load_progress) (const char *section,
1326 unsigned long section_sent,
1327 unsigned long section_size,
1328 unsigned long total_sent,
1329 unsigned long total_size);
1330 extern void (*print_frame_info_listing_hook) (struct symtab * s,
1331 int line, int stopline,
1333 extern struct frame_info *parse_frame_specification (char *frame_exp);
1334 extern int (*query_hook) (const char *, va_list);
1335 extern void (*warning_hook) (const char *, va_list);
1336 extern void (*flush_hook) (struct ui_file * stream);
1337 extern void (*create_breakpoint_hook) (struct breakpoint * b);
1338 extern void (*delete_breakpoint_hook) (struct breakpoint * bpt);
1339 extern void (*modify_breakpoint_hook) (struct breakpoint * bpt);
1340 extern void (*interactive_hook) (void);
1341 extern void (*registers_changed_hook) (void);
1342 extern void (*readline_begin_hook) (char *,...);
1343 extern char *(*readline_hook) (char *);
1344 extern void (*readline_end_hook) (void);
1345 extern void (*register_changed_hook) (int regno);
1346 extern void (*memory_changed_hook) (CORE_ADDR addr, int len);
1347 extern void (*context_hook) (int);
1348 extern ptid_t (*target_wait_hook) (ptid_t ptid,
1349 struct target_waitstatus * status);
1351 extern void (*attach_hook) (void);
1352 extern void (*detach_hook) (void);
1353 extern void (*call_command_hook) (struct cmd_list_element * c,
1354 char *cmd, int from_tty);
1356 extern void (*set_hook) (struct cmd_list_element * c);
1358 extern NORETURN void (*error_hook) (void) ATTR_NORETURN;
1360 extern void (*error_begin_hook) (void);
1362 extern int (*ui_load_progress_hook) (const char *section, unsigned long num);
1365 /* Inhibit window interface if non-zero. */
1367 extern int use_windows;
1369 /* Symbolic definitions of filename-related things. */
1370 /* FIXME, this doesn't work very well if host and executable
1371 filesystems conventions are different. */
1373 #ifndef DIRNAME_SEPARATOR
1374 #define DIRNAME_SEPARATOR ':'
1377 #ifndef SLASH_STRING
1378 #define SLASH_STRING "/"
1383 # define GLOBAL_CURDIR
1386 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1387 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1388 in the code actually refer to a lightweight process id, i.e,
1389 something that can be considered a process id in its own right for
1390 certain purposes. */
1393 #define PIDGET(PTID) (ptid_get_pid (PTID))
1394 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1395 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1398 /* Define well known filenos if the system does not define them. */
1399 #ifndef STDIN_FILENO
1400 #define STDIN_FILENO 0
1402 #ifndef STDOUT_FILENO
1403 #define STDOUT_FILENO 1
1405 #ifndef STDERR_FILENO
1406 #define STDERR_FILENO 2
1409 /* If this definition isn't overridden by the header files, assume
1410 that isatty and fileno exist on this system. */
1412 #define ISATTY(FP) (isatty (fileno (FP)))
1415 #endif /* #ifndef DEFS_H */