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