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