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