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