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