* Makefile.in (VERSION): Bump to 4.5.6.
[deliverable/binutils-gdb.git] / gdb / defs.h
1 /* Basic, host-specific, and target-specific definitions for GDB.
2 Copyright (C) 1986, 1989, 1991 Free Software Foundation, Inc.
3
4 This file is part of GDB.
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20 #if !defined (DEFS_H)
21 #define DEFS_H 1
22
23 #include <stdio.h>
24
25 /* First include ansidecl.h so we can use the various macro definitions
26 in all subsequent file inclusions. FIXME: This inclusion can now
27 be removed from all files that include defs.h */
28
29 #include "ansidecl.h"
30
31 /* We could use the EXFUN macro in ansidecl.h to handle prototypes, but
32 the name is misleading the the result is ugly. So just define a simple
33 macro to handle the parameter lists. */
34
35 #ifdef __STDC__
36 #define PARAMS(paramlist) paramlist
37 #else
38 #define PARAMS(paramlist) ()
39 #endif
40
41 /* An address in the program being debugged. Host byte order. */
42 typedef unsigned int CORE_ADDR;
43
44 #define min(a, b) ((a) < (b) ? (a) : (b))
45 #define max(a, b) ((a) > (b) ? (a) : (b))
46
47 /* The character C++ uses to build identifiers that must be unique from
48 the program's identifiers (such as $this and $$vptr). */
49 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
50
51 #include <errno.h> /* System call error return status */
52
53 extern int quit_flag;
54 extern int immediate_quit;
55
56 extern void
57 quit PARAMS ((void));
58
59 #define QUIT { if (quit_flag) quit (); }
60
61 /* Notes on classes: class_alias is for alias commands which are not
62 abbreviations of the original command. */
63
64 enum command_class
65 {
66 /* Special args to help_list */
67 all_classes = -2, all_commands = -1,
68 /* Classes of commands */
69 no_class = -1, class_run = 0, class_vars, class_stack,
70 class_files, class_support, class_info, class_breakpoint,
71 class_alias, class_obscure, class_user
72 };
73
74 /* the cleanup list records things that have to be undone
75 if an error happens (descriptors to be closed, memory to be freed, etc.)
76 Each link in the chain records a function to call and an
77 argument to give it.
78
79 Use make_cleanup to add an element to the cleanup chain.
80 Use do_cleanups to do all cleanup actions back to a given
81 point in the chain. Use discard_cleanups to remove cleanups
82 from the chain back to a given point, not doing them. */
83
84 struct cleanup
85 {
86 struct cleanup *next;
87 void (*function) PARAMS ((PTR));
88 PTR arg;
89 };
90
91 /* From blockframe.c */
92
93 extern int
94 inside_entry_func PARAMS ((CORE_ADDR));
95
96 extern int
97 inside_entry_file PARAMS ((CORE_ADDR addr));
98
99 extern int
100 inside_main_func PARAMS ((CORE_ADDR pc));
101
102 /* From cplus-dem.c */
103
104 extern char *
105 cplus_demangle PARAMS ((const char *, int));
106
107 extern char *
108 cplus_mangle_opname PARAMS ((char *, int));
109
110 /* From libmmalloc.a (memory mapped malloc library) */
111
112 extern PTR
113 mmalloc_attach PARAMS ((int, PTR));
114
115 extern PTR
116 mmalloc_detach PARAMS ((PTR));
117
118 extern PTR
119 mmalloc PARAMS ((PTR, long));
120
121 extern PTR
122 mrealloc PARAMS ((PTR, PTR, long));
123
124 extern void
125 mfree PARAMS ((PTR, PTR));
126
127 extern int
128 mmalloc_setkey PARAMS ((PTR, int, PTR));
129
130 extern PTR
131 mmalloc_getkey PARAMS ((PTR, int));
132
133 /* From utils.c */
134
135 extern char *
136 demangle_and_match PARAMS ((const char *, const char *, int));
137
138 extern int
139 strcmp_iw PARAMS ((const char *, const char *));
140
141 extern char *
142 safe_strerror PARAMS ((int));
143
144 extern char *
145 safe_strsignal PARAMS ((int));
146
147 extern void
148 init_malloc PARAMS ((PTR));
149
150 extern void
151 request_quit PARAMS ((int));
152
153 extern void
154 do_cleanups PARAMS ((struct cleanup *));
155
156 extern void
157 discard_cleanups PARAMS ((struct cleanup *));
158
159 /* The bare make_cleanup function is one of those rare beasts that
160 takes almost any type of function as the first arg and anything that
161 will fit in a "void *" as the second arg.
162
163 Should be, once all calls and called-functions are cleaned up:
164 extern struct cleanup *
165 make_cleanup PARAMS ((void (*function) (PTR), PTR));
166
167 Until then, lint and/or various type-checking compiler options will
168 complain about make_cleanup calls. It'd be wrong to just cast things,
169 since the type actually passed when the function is called would be
170 wrong. */
171
172 extern struct cleanup *
173 make_cleanup ();
174
175 extern struct cleanup *
176 save_cleanups PARAMS ((void));
177
178 extern void
179 restore_cleanups PARAMS ((struct cleanup *));
180
181 extern void
182 free_current_contents PARAMS ((char **));
183
184 extern void
185 null_cleanup PARAMS ((char **));
186
187 extern int
188 myread PARAMS ((int, char *, int));
189
190 extern int
191 query ();
192
193 extern void
194 wrap_here PARAMS ((char *));
195
196 extern void
197 reinitialize_more_filter PARAMS ((void));
198
199 extern int
200 print_insn PARAMS ((CORE_ADDR, FILE *));
201
202 extern void
203 fputs_filtered PARAMS ((const char *, FILE *));
204
205 extern void
206 puts_filtered PARAMS ((char *));
207
208 extern void
209 fprintf_filtered ();
210
211 extern void
212 printf_filtered ();
213
214 extern void
215 print_spaces PARAMS ((int, FILE *));
216
217 extern void
218 print_spaces_filtered PARAMS ((int, FILE *));
219
220 extern char *
221 n_spaces PARAMS ((int));
222
223 extern void
224 printchar PARAMS ((int, FILE *, int));
225
226 extern char *
227 strdup_demangled PARAMS ((const char *));
228
229 extern void
230 fprint_symbol PARAMS ((FILE *, char *));
231
232 extern void
233 fputs_demangled PARAMS ((char *, FILE *, int));
234
235 extern void
236 perror_with_name PARAMS ((char *));
237
238 extern void
239 print_sys_errmsg PARAMS ((char *, int));
240
241 /* From regex.c */
242
243 extern char *
244 re_comp PARAMS ((char *));
245
246 /* From symfile.c */
247
248 extern void
249 symbol_file_command PARAMS ((char *, int));
250
251 /* From main.c */
252
253 extern char *
254 skip_quoted PARAMS ((char *));
255
256 extern char *
257 gdb_readline PARAMS ((char *));
258
259 extern char *
260 command_line_input PARAMS ((char *, int));
261
262 extern void
263 print_prompt PARAMS ((void));
264
265 extern int
266 batch_mode PARAMS ((void));
267
268 extern int
269 input_from_terminal_p PARAMS ((void));
270
271 extern int
272 catch_errors PARAMS ((int (*) (char *), char *, char *));
273
274 /* From printcmd.c */
275
276 extern void
277 set_next_address PARAMS ((CORE_ADDR));
278
279 extern void
280 print_address_symbolic PARAMS ((CORE_ADDR, FILE *, int, char *));
281
282 extern void
283 print_address PARAMS ((CORE_ADDR, FILE *));
284
285 /* From source.c */
286
287 extern int
288 openp PARAMS ((char *, int, char *, int, int, char **));
289
290 extern void
291 mod_path PARAMS ((char *, char **));
292
293 extern void
294 directory_command PARAMS ((char *, int));
295
296 extern void
297 init_source_path PARAMS ((void));
298
299 /* From findvar.c */
300
301 extern int
302 read_relative_register_raw_bytes PARAMS ((int, char *));
303
304 /* From readline (but not in any readline .h files). */
305
306 extern char *
307 tilde_expand PARAMS ((char *));
308
309 /* Structure for saved commands lines
310 (for breakpoints, defined commands, etc). */
311
312 struct command_line
313 {
314 struct command_line *next;
315 char *line;
316 };
317
318 extern struct command_line *
319 read_command_lines PARAMS ((void));
320
321 extern void
322 free_command_lines PARAMS ((struct command_line **));
323
324 /* String containing the current directory (what getwd would return). */
325
326 extern char *current_directory;
327
328 /* Default radixes for input and output. Only some values supported. */
329 extern unsigned input_radix;
330 extern unsigned output_radix;
331
332 /* Baud rate specified for communication with serial target systems. */
333 extern char *baud_rate;
334
335 /* Languages represented in the symbol table and elsewhere. */
336
337 enum language
338 {
339 language_unknown, /* Language not known */
340 language_auto, /* Placeholder for automatic setting */
341 language_c, /* C */
342 language_cplus, /* C++ */
343 language_m2 /* Modula-2 */
344 };
345
346 /* Return a format string for printf that will print a number in the local
347 (language-specific) hexadecimal format. Result is static and is
348 overwritten by the next call. local_hex_format_custom takes printf
349 options like "08" or "l" (to produce e.g. %08x or %lx). */
350
351 #define local_hex_format() (current_language->la_hex_format)
352
353 extern char *
354 local_hex_format_custom PARAMS ((char *)); /* language.c */
355
356 /* Return a string that contains a number formatted in the local
357 (language-specific) hexadecimal format. Result is static and is
358 overwritten by the next call. local_hex_string_custom takes printf
359 options like "08" or "l". */
360
361 extern char *
362 local_hex_string PARAMS ((int)); /* language.c */
363
364 extern char *
365 local_hex_string_custom PARAMS ((int, char *)); /* language.c */
366
367 \f
368 /* Host machine definition. This will be a symlink to one of the
369 xm-*.h files, built by the `configure' script. */
370
371 #include "xm.h"
372
373 /* If the xm.h file did not define the mode string used to open the
374 files, assume that binary files are opened the same way as text
375 files */
376 #ifndef FOPEN_RB
377 #include "fopen-same.h"
378 #endif
379
380 /*
381 * Allow things in gdb to be declared "const". If compiling ANSI, it
382 * just works. If compiling with gcc but non-ansi, redefine to __const__.
383 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
384 * objects be read-write rather than read-only.
385 */
386
387 #ifndef const
388 #ifndef __STDC__
389 # ifdef __GNUC__
390 # define const __const__
391 # else
392 # define const /*nothing*/
393 # endif /* GNUC */
394 #endif /* STDC */
395 #endif /* const */
396
397 #ifndef volatile
398 #ifndef __STDC__
399 # ifdef __GNUC__
400 # define volatile __volatile__
401 # else
402 # define volatile /*nothing*/
403 # endif /* GNUC */
404 #endif /* STDC */
405 #endif /* volatile */
406
407 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
408 declarations of functions that never return (exit for instance) as
409 "volatile void". For such compilers "NORETURN" can be defined away
410 to keep them happy */
411
412 #ifndef NORETURN
413 # ifdef __lucid
414 # define NORETURN /*nothing*/
415 # else
416 # define NORETURN volatile
417 # endif
418 #endif
419
420 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
421
422 #if !defined (UINT_MAX)
423 #define UINT_MAX 0xffffffff
424 #endif
425
426 #if !defined (LONG_MAX)
427 #define LONG_MAX 0x7fffffff
428 #endif
429
430 #if !defined (INT_MAX)
431 #define INT_MAX 0x7fffffff
432 #endif
433
434 #if !defined (INT_MIN)
435 /* Two's complement, 32 bit. */
436 #define INT_MIN -0x80000000
437 #endif
438
439 /* Number of bits in a char or unsigned char for the target machine.
440 Just like CHAR_BIT in <limits.h> but describes the target machine. */
441 #if !defined (TARGET_CHAR_BIT)
442 #define TARGET_CHAR_BIT 8
443 #endif
444
445 /* Number of bits in a short or unsigned short for the target machine. */
446 #if !defined (TARGET_SHORT_BIT)
447 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
448 #endif
449
450 /* Number of bits in an int or unsigned int for the target machine. */
451 #if !defined (TARGET_INT_BIT)
452 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
453 #endif
454
455 /* Number of bits in a long or unsigned long for the target machine. */
456 #if !defined (TARGET_LONG_BIT)
457 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
458 #endif
459
460 /* Number of bits in a long long or unsigned long long for the target machine. */
461 #if !defined (TARGET_LONG_LONG_BIT)
462 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
463 #endif
464
465 /* Number of bits in a float for the target machine. */
466 #if !defined (TARGET_FLOAT_BIT)
467 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
468 #endif
469
470 /* Number of bits in a double for the target machine. */
471 #if !defined (TARGET_DOUBLE_BIT)
472 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
473 #endif
474
475 /* Number of bits in a long double for the target machine. */
476 #if !defined (TARGET_LONG_DOUBLE_BIT)
477 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
478 #endif
479
480 /* Number of bits in a "complex" for the target machine. */
481 #if !defined (TARGET_COMPLEX_BIT)
482 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
483 #endif
484
485 /* Number of bits in a "double complex" for the target machine. */
486 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
487 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
488 #endif
489
490 /* Number of bits in a pointer for the target machine */
491 #if !defined (TARGET_PTR_BIT)
492 #define TARGET_PTR_BIT TARGET_INT_BIT
493 #endif
494
495 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
496 of arguments to a function, number in a value history, register
497 number, etc.) where the value must not be larger than can fit
498 in an int. */
499 #if !defined (longest_to_int)
500 #if defined (LONG_LONG)
501 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
502 ? (error ("Value out of range."),0) : (int) (x))
503 #else /* No LONG_LONG. */
504 /* Assume sizeof (int) == sizeof (long). */
505 #define longest_to_int(x) ((int) (x))
506 #endif /* No LONG_LONG. */
507 #endif /* No longest_to_int. */
508
509 /* This should not be a typedef, because "unsigned LONGEST" needs
510 to work. LONG_LONG is defined if the host has "long long". */
511
512 #ifndef LONGEST
513 # ifdef LONG_LONG
514 # define LONGEST long long
515 # else
516 # define LONGEST long
517 # endif
518 #endif
519
520 /* Assorted functions we can declare, now that const and volatile are
521 defined. */
522
523 extern char *
524 savestring PARAMS ((const char *, int));
525
526 extern char *
527 msavestring PARAMS ((void *, const char *, int));
528
529 extern char *
530 strsave PARAMS ((const char *));
531
532 extern char *
533 mstrsave PARAMS ((void *, const char *));
534
535 extern char *
536 concat PARAMS ((char *, ...));
537
538 extern PTR
539 xmalloc PARAMS ((long));
540
541 extern PTR
542 xrealloc PARAMS ((PTR, long));
543
544 extern PTR
545 xmmalloc PARAMS ((PTR, long));
546
547 extern PTR
548 xmrealloc PARAMS ((PTR, PTR, long));
549
550 extern PTR
551 mmalloc PARAMS ((PTR, long));
552
553 extern PTR
554 mrealloc PARAMS ((PTR, PTR, long));
555
556 extern void
557 mfree PARAMS ((PTR, PTR));
558
559 extern int
560 mmcheck PARAMS ((PTR, void (*) (void)));
561
562 extern int
563 mmtrace PARAMS ((void));
564
565 extern int
566 parse_escape PARAMS ((char **));
567
568 extern const char * const reg_names[];
569
570 extern NORETURN void /* Does not return to the caller. */
571 error ();
572
573 extern NORETURN void /* Does not return to the caller. */
574 fatal ();
575
576 extern NORETURN void /* Not specified as volatile in ... */
577 exit PARAMS ((int)); /* 4.10.4.3 */
578
579 extern NORETURN void /* Does not return to the caller. */
580 nomem PARAMS ((long));
581
582 extern NORETURN void /* Does not return to the caller. */
583 return_to_top_level PARAMS ((void));
584
585 extern void
586 warning_setup PARAMS ((void));
587
588 extern void
589 warning ();
590
591 /* Global functions from other, non-gdb GNU thingies (libiberty for
592 instance) */
593
594 extern char *
595 basename PARAMS ((char *));
596
597 extern char *
598 getenv PARAMS ((CONST char *));
599
600 extern char **
601 buildargv PARAMS ((char *));
602
603 extern void
604 freeargv PARAMS ((char **));
605
606 extern char *
607 strerrno PARAMS ((int));
608
609 extern char *
610 strsigno PARAMS ((int));
611
612 extern int
613 errno_max PARAMS ((void));
614
615 extern int
616 signo_max PARAMS ((void));
617
618 extern int
619 strtoerrno PARAMS ((char *));
620
621 extern int
622 strtosigno PARAMS ((char *));
623
624 extern char *
625 strsignal PARAMS ((int));
626
627 /* From other system libraries */
628
629 #ifndef PSIGNAL_IN_SIGNAL_H
630 extern void
631 psignal PARAMS ((unsigned, char *));
632 #endif
633
634 /* For now, we can't include <stdlib.h> because it conflicts with
635 "../include/getopt.h". (FIXME)
636
637 However, if a function is defined in the ANSI C standard and a prototype
638 for that function is defined and visible in any header file in an ANSI
639 conforming environment, then that prototype must match the definition in
640 the ANSI standard. So we can just duplicate them here without conflict,
641 since they must be the same in all conforming ANSI environments. If
642 these cause problems, then the environment is not ANSI conformant. */
643
644 #ifdef __STDC__
645 #include <stddef.h>
646 #endif
647
648 extern int
649 fclose PARAMS ((FILE *stream)); /* 4.9.5.1 */
650
651 extern void
652 perror PARAMS ((const char *)); /* 4.9.10.4 */
653
654 extern double
655 atof PARAMS ((const char *nptr)); /* 4.10.1.1 */
656
657 #ifndef MALLOC_INCOMPATIBLE
658
659 extern PTR
660 malloc PARAMS ((size_t size)); /* 4.10.3.3 */
661
662 extern PTR
663 realloc PARAMS ((void *ptr, size_t size)); /* 4.10.3.4 */
664
665 extern void
666 free PARAMS ((void *)); /* 4.10.3.2 */
667
668 #endif /* MALLOC_INCOMPATIBLE */
669
670 extern void
671 qsort PARAMS ((void *base, size_t nmemb, /* 4.10.5.2 */
672 size_t size,
673 int (*comp)(const void *, const void *)));
674
675 extern char *
676 strchr PARAMS ((const char *, int)); /* 4.11.5.2 */
677
678 extern char *
679 strrchr PARAMS ((const char *, int)); /* 4.11.5.5 */
680
681 extern char *
682 strstr PARAMS ((const char *, const char *)); /* 4.11.5.7 */
683
684 extern char *
685 strtok PARAMS ((char *, const char *)); /* 4.11.5.8 */
686
687 extern char *
688 strerror PARAMS ((int)); /* 4.11.6.2 */
689
690 /* Various possibilities for alloca. */
691 #ifndef alloca
692 # ifdef __GNUC__
693 # define alloca __builtin_alloca
694 # else
695 # ifdef sparc
696 # include <alloca.h>
697 # endif
698 # ifndef alloca /* May be macro, with args, in <alloca.h> */
699 extern char *alloca ();
700 # endif
701 # endif
702 #endif
703
704 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER should be defined to one of these. */
705
706 #if !defined (BIG_ENDIAN)
707 #define BIG_ENDIAN 4321
708 #endif
709
710 #if !defined (LITTLE_ENDIAN)
711 #define LITTLE_ENDIAN 1234
712 #endif
713
714 /* Target-system-dependent parameters for GDB.
715
716 The standard thing is to include defs.h. However, files that are
717 specific to a particular target can define TM_FILE_OVERRIDE before
718 including defs.h, then can include any particular tm-file they desire. */
719
720 /* Target machine definition. This will be a symlink to one of the
721 tm-*.h files, built by the `configure' script. */
722
723 #ifndef TM_FILE_OVERRIDE
724 #include "tm.h"
725 #endif
726
727 /* The bit byte-order has to do just with numbering of bits in
728 debugging symbols and such. Conceptually, it's quite separate
729 from byte/word byte order. */
730
731 #if !defined (BITS_BIG_ENDIAN)
732 #if TARGET_BYTE_ORDER == BIG_ENDIAN
733 #define BITS_BIG_ENDIAN 1
734 #endif /* Big endian. */
735
736 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
737 #define BITS_BIG_ENDIAN 0
738 #endif /* Little endian. */
739 #endif /* BITS_BIG_ENDIAN not defined. */
740
741 /* Swap LEN bytes at BUFFER between target and host byte-order. */
742 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
743 #define SWAP_TARGET_AND_HOST(buffer,len)
744 #else /* Target and host byte order differ. */
745 #define SWAP_TARGET_AND_HOST(buffer,len) \
746 { \
747 char tmp; \
748 char *p = (char *)(buffer); \
749 char *q = ((char *)(buffer)) + len - 1; \
750 for (; p < q; p++, q--) \
751 { \
752 tmp = *q; \
753 *q = *p; \
754 *p = tmp; \
755 } \
756 }
757 #endif /* Target and host byte order differ. */
758
759 /* On some machines there are bits in addresses which are not really
760 part of the address, but are used by the kernel, the hardware, etc.
761 for special purposes. ADDR_BITS_REMOVE takes out any such bits
762 so we get a "real" address such as one would find in a symbol
763 table. ADDR_BITS_SET sets those bits the way the system wants
764 them. */
765 #if !defined (ADDR_BITS_REMOVE)
766 #define ADDR_BITS_REMOVE(addr) (addr)
767 #define ADDR_BITS_SET(addr) (addr)
768 #endif /* No ADDR_BITS_REMOVE. */
769
770 /* From valops.c */
771
772 extern CORE_ADDR
773 push_bytes PARAMS ((CORE_ADDR, char *, int));
774
775 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
776 must avoid prototyping this function for now. FIXME. Should be:
777 extern CORE_ADDR
778 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
779 */
780 extern CORE_ADDR
781 push_word ();
782
783 #endif /* !defined (DEFS_H) */
This page took 0.045468 seconds and 4 git commands to generate.