Subversion Repositories or1k

/* *INDENT-OFF* */ /* ATTR_FORMAT confuses indent, avoid running it for now */

/* Basic, host-specific, and target-specific definitions for GDB.

   Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,

   1997, 1998, 1999, 2000, 2001, 2002

   Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify

   it under the terms of the GNU General Public License as published by

   the Free Software Foundation; either version 2 of the License, or

   (at your option) any later version.

   This program is distributed in the hope that it will be useful,

   but WITHOUT ANY WARRANTY; without even the implied warranty of

   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License

   along with this program; if not, write to the Free Software

   Foundation, Inc., 59 Temple Place - Suite 330,

   Boston, MA 02111-1307, USA.  */

#ifndef DEFS_H

#define DEFS_H

#include "config.h"             /* Generated by configure */

#include <stdio.h>

#include <errno.h>              /* System call error return status */

#include <limits.h>

#ifdef HAVE_STDDEF_H

#include <stddef.h>

#else

#include <sys/types.h>          /* for size_t */

#endif

#ifdef HAVE_UNISTD_H

#include <unistd.h>

#endif

#include "gdb_locale.h"

/* For ``enum target_signal''.  */

#include "gdb/signals.h"

/* Just in case they're not defined in stdio.h. */

#ifndef SEEK_SET

#define SEEK_SET 0

#endif

#ifndef SEEK_CUR

#define SEEK_CUR 1

#endif

/* First include ansidecl.h so we can use the various macro definitions

   here and in all subsequent file inclusions.  */

#include "ansidecl.h"

#include <stdarg.h>             /* for va_list */

#include "libiberty.h"

#include "progress.h"

/* For BFD64 and bfd_vma.  */

#include "bfd.h"

/* The target is partially multi-arched.  Both "tm.h" and the

   multi-arch vector provide definitions.  "tm.h" normally overrides

   the multi-arch vector (but there are a few exceptions).  */

#define GDB_MULTI_ARCH_PARTIAL 1

/* The target is partially multi-arched. Both the multi-arch vector

   and "tm.h" provide definitions. "tm.h" cannot override a definition

   provided by the multi-arch vector.  It is detected as a compilation

   error.

   This setting is only useful during a multi-arch conversion. */

#define GDB_MULTI_ARCH_TM 2

/* The target is pure multi-arch.  The MULTI-ARCH vector provides all

   definitions.  "tm.h" is linked to an empty file. */

#define GDB_MULTI_ARCH_PURE 3

/* An address in the program being debugged.  Host byte order.  Rather

   than duplicate all the logic in BFD which figures out what type

   this is (long, long long, etc.) and whether it needs to be 64

   bits (the host/target interactions are subtle), we just use

   bfd_vma.  */

typedef bfd_vma CORE_ADDR;

/* This is to make sure that LONGEST is at least as big as CORE_ADDR.  */

#ifndef LONGEST

#ifdef BFD64

#define LONGEST BFD_HOST_64_BIT

#define ULONGEST BFD_HOST_U_64_BIT

#else /* No BFD64 */

#ifdef CC_HAS_LONG_LONG

#define LONGEST long long

#define ULONGEST unsigned long long

#else

#ifdef BFD_HOST_64_BIT

/* BFD_HOST_64_BIT is defined for some hosts that don't have long long

   (e.g. i386-windows) so try it.  */

#define LONGEST BFD_HOST_64_BIT

#define ULONGEST BFD_HOST_U_64_BIT

#else

#define LONGEST long

#define ULONGEST unsigned long

#endif

#endif

#endif /* No BFD64 */

#endif /* ! LONGEST */

#ifndef min

#define min(a, b) ((a) < (b) ? (a) : (b))

#endif

#ifndef max

#define max(a, b) ((a) > (b) ? (a) : (b))

#endif

/* Macros to do string compares.

   NOTE: cagney/2000-03-14:

   While old code can continue to refer to these macros, new code is

   probably better off using strcmp() directly vis: ``strcmp() == 0''

   and ``strcmp() != 0''.

   This is because modern compilers can directly inline strcmp()

   making the original justification for these macros - avoid function

   call overhead by pre-testing the first characters

   (``*X==*Y?...:0'') - redundant.

   ``Even if [...] testing the first character does have a modest

   performance improvement, I'd rather that whenever a performance

   issue is found that we spend the effort on algorithmic

   optimizations than micro-optimizing.'' J.T. */

#define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)

#define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)

/* The character GNU C++ uses to build identifiers that must be unique from

   the program's identifiers (such as $this and $$vptr).  */

#define CPLUS_MARKER '$'        /* May be overridden to '.' for SysV */

/* Check if a character is one of the commonly used C++ marker characters.  */

extern int is_cplus_marker (int);

/* use tui interface if non-zero */

extern int tui_version;

/* enable xdb commands if set */

extern int xdb_commands;

/* enable dbx commands if set */

extern int dbx_commands;

extern int quit_flag;

extern int immediate_quit;

extern int sevenbit_strings;

extern void quit (void);

/* FIXME: cagney/2000-03-13: It has been suggested that the peformance

   benefits of having a ``QUIT'' macro rather than a function are

   marginal.  If the overhead of a QUIT function call is proving

   significant then its calling frequency should probably be reduced

   [kingdon].  A profile analyzing the current situtation is

   needed. */

#ifdef QUIT

/* do twice to force compiler warning */

#define QUIT_FIXME "FIXME"

#define QUIT_FIXME "ignoring redefinition of QUIT"

#else

#define QUIT { \

  if (quit_flag) quit (); \

  if (interactive_hook) interactive_hook (); \

  PROGRESS (1); \

}

#endif

/* Languages represented in the symbol table and elsewhere.

   This should probably be in language.h, but since enum's can't

   be forward declared to satisfy opaque references before their

   actual definition, needs to be here. */

enum language

  {

    language_unknown,           /* Language not known */

    language_auto,              /* Placeholder for automatic setting */

    language_c,                 /* C */

    language_cplus,             /* C++ */

    language_java,              /* Java */

    /* OBSOLETE language_chill, */      /* Chill */

    language_fortran,           /* Fortran */

    language_m2,                /* Modula-2 */

    language_asm,               /* Assembly language */

    language_scm,               /* Scheme / Guile */

    language_pascal             /* Pascal */

  };

enum precision_type

  {

    single_precision,

    double_precision,

    unspecified_precision

  };

/* A generic, not quite boolean, enumeration.  */

enum auto_boolean

{

  AUTO_BOOLEAN_TRUE,

  AUTO_BOOLEAN_FALSE,

  AUTO_BOOLEAN_AUTO

};

/* the cleanup list records things that have to be undone

   if an error happens (descriptors to be closed, memory to be freed, etc.)

   Each link in the chain records a function to call and an

   argument to give it.

   Use make_cleanup to add an element to the cleanup chain.

   Use do_cleanups to do all cleanup actions back to a given

   point in the chain.  Use discard_cleanups to remove cleanups

   from the chain back to a given point, not doing them.  */

struct cleanup

  {

    struct cleanup *next;

    void (*function) (PTR);

    PTR arg;

  };

/* The ability to declare that a function never returns is useful, but

   not really required to compile GDB successfully, so the NORETURN and

   ATTR_NORETURN macros normally expand into nothing.  */

/* If compiling with older versions of GCC, a function may be declared

   "volatile" to indicate that it does not return.  */

#ifndef NORETURN

#if defined(__GNUC__) \

     && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))

#define NORETURN volatile

#else

#define NORETURN                /* nothing */

#endif

#endif

/* GCC 2.5 and later versions define a function attribute "noreturn",

   which is the preferred way to declare that a function never returns.

   However GCC 2.7 appears to be the first version in which this fully

   works everywhere we use it. */

#ifndef ATTR_NORETURN

#if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))

#define ATTR_NORETURN __attribute__ ((noreturn))

#else

#define ATTR_NORETURN           /* nothing */

#endif

#endif

#ifndef ATTR_FORMAT

#if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))

#define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))

#else

#define ATTR_FORMAT(type, x, y) /* nothing */

#endif

#endif

/* Needed for various prototypes */

struct symtab;

struct breakpoint;

/* From blockframe.c */

extern int inside_entry_func (CORE_ADDR);

extern int inside_entry_file (CORE_ADDR addr);

extern int inside_main_func (CORE_ADDR pc);

/* OBSOLETE From ch-lang.c, for the moment. (FIXME) */

/* OBSOLETE extern char *chill_demangle (const char *); */

/* From utils.c */

extern void initialize_utils (void);

extern void notice_quit (void);

extern int strcmp_iw (const char *, const char *);

extern int subset_compare (char *, char *);

extern char *safe_strerror (int);

extern void init_malloc (void *);

extern void request_quit (int);

extern void do_cleanups (struct cleanup *);

extern void do_final_cleanups (struct cleanup *);

extern void do_my_cleanups (struct cleanup **, struct cleanup *);

extern void do_run_cleanups (struct cleanup *);

extern void do_exec_cleanups (struct cleanup *);

extern void do_exec_error_cleanups (struct cleanup *);

extern void discard_cleanups (struct cleanup *);

extern void discard_final_cleanups (struct cleanup *);

extern void discard_exec_error_cleanups (struct cleanup *);

extern void discard_my_cleanups (struct cleanup **, struct cleanup *);

/* NOTE: cagney/2000-03-04: This typedef is strictly for the

   make_cleanup function declarations below. Do not use this typedef

   as a cast when passing functions into the make_cleanup() code.

   Instead either use a bounce function or add a wrapper function.

   Calling a f(char*) function with f(void*) is non-portable. */

typedef void (make_cleanup_ftype) (void *);

extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);

extern struct cleanup *make_cleanup_freeargv (char **);

struct ui_file;

extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);

extern struct cleanup *make_cleanup_close (int fd);

extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);

extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);

extern struct cleanup *make_my_cleanup (struct cleanup **,

                                        make_cleanup_ftype *, void *);

extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);

extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);

extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);

extern struct cleanup *save_cleanups (void);

extern struct cleanup *save_final_cleanups (void);

extern struct cleanup *save_my_cleanups (struct cleanup **);

extern void restore_cleanups (struct cleanup *);

extern void restore_final_cleanups (struct cleanup *);

extern void restore_my_cleanups (struct cleanup **, struct cleanup *);

extern void free_current_contents (void *);

extern void null_cleanup (void *);

extern int myread (int, char *, int);

extern int query (const char *, ...) ATTR_FORMAT (printf, 1, 2);

extern void init_page_info (void);

extern CORE_ADDR host_pointer_to_address (void *ptr);

extern void *address_to_host_pointer (CORE_ADDR addr);

extern char *gdb_realpath (const char *);

extern char *xfullpath (const char *);

/* From demangle.c */

extern void set_demangling_style (char *);

/* From tm.h */

struct type;

typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);

extern use_struct_convention_fn generic_use_struct_convention;

/* Annotation stuff.  */

extern int annotation_level;    /* in stack.c */

extern void begin_line (void);

extern void wrap_here (char *);

extern void reinitialize_more_filter (void);

/* Normal results */

extern struct ui_file *gdb_stdout;

/* Serious error notifications */

extern struct ui_file *gdb_stderr;

/* Log/debug/trace messages that should bypass normal stdout/stderr

   filtering.  For momement, always call this stream using

   *_unfiltered. In the very near future that restriction shall be

   removed - either call shall be unfiltered. (cagney 1999-06-13). */

extern struct ui_file *gdb_stdlog;

/* Target output that should bypass normal stdout/stderr filtering.

   For momement, always call this stream using *_unfiltered. In the

   very near future that restriction shall be removed - either call

   shall be unfiltered. (cagney 1999-07-02). */

extern struct ui_file *gdb_stdtarg;

#if defined(TUI)

#include "tui.h"

#endif

#include "ui-file.h"

/* More generic printf like operations.  Filtered versions may return

   non-locally on error.  */

extern void fputs_filtered (const char *, struct ui_file *);

extern void fputs_unfiltered (const char *, struct ui_file *);

extern int fputc_filtered (int c, struct ui_file *);

extern int fputc_unfiltered (int c, struct ui_file *);

extern int putchar_filtered (int c);

extern int putchar_unfiltered (int c);

extern void puts_filtered (const char *);

extern void puts_unfiltered (const char *);

extern void puts_debug (char *prefix, char *string, char *suffix);

extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);

extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);

extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);

extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);

extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);

extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);

extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);

extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);

extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);

extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);

extern void print_spaces (int, struct ui_file *);

extern void print_spaces_filtered (int, struct ui_file *);

extern char *n_spaces (int);

extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);

extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);

extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);

/* Display the host ADDR on STREAM formatted as ``0x%x''. */

extern void gdb_print_host_address (void *addr, struct ui_file *stream);

/* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.

   paddr_nz() is like %lx.  paddr_u() is like %lu. paddr_width() is

   for ``%*''. */

extern int strlen_paddr (void);

extern char *paddr (CORE_ADDR addr);

extern char *paddr_nz (CORE_ADDR addr);

extern char *paddr_u (CORE_ADDR addr);

extern char *paddr_d (LONGEST addr);

extern char *phex (ULONGEST l, int sizeof_l);

extern char *phex_nz (ULONGEST l, int sizeof_l);

/* Like paddr() only print/scan raw CORE_ADDR.  The output from

   core_addr_to_string() can be passed direct to

   string_to_core_addr().  */

extern const char *core_addr_to_string (const CORE_ADDR addr);

extern const char *core_addr_to_string_nz (const CORE_ADDR addr);

extern CORE_ADDR string_to_core_addr (const char *my_string);

extern void fprintf_symbol_filtered (struct ui_file *, char *,

                                     enum language, int);

extern NORETURN void perror_with_name (const char *) ATTR_NORETURN;

extern void print_sys_errmsg (const char *, int);

/* From regex.c or libc.  BSD 4.4 declares this with the argument type as

   "const char *" in unistd.h, so we can't declare the argument

   as "char *".  */

extern char *re_comp (const char *);

/* From symfile.c */

extern void symbol_file_command (char *, int);

/* Remote targets may wish to use this as their load function.  */

extern void generic_load (char *name, int from_tty);

/* Summarise a download */

extern void print_transfer_performance (struct ui_file *stream,

                                        unsigned long data_count,

                                        unsigned long write_count,

                                        unsigned long time_count);

/* From top.c */

typedef void initialize_file_ftype (void);

extern char *skip_quoted (char *);

extern char *gdb_readline (char *);

extern char *gdb_readline_wrapper (char *);

extern char *command_line_input (char *, int, char *);

extern void print_prompt (void);

extern int input_from_terminal_p (void);

extern int info_verbose;

/* From printcmd.c */

extern void set_next_address (CORE_ADDR);

extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,

                                    char *);

extern int build_address_symbolic (CORE_ADDR addr,

                                   int do_demangle,

                                   char **name,

                                   int *offset,

                                   char **filename,

                                   int *line,

                                   int *unmapped);

extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);

extern void print_address (CORE_ADDR, struct ui_file *);

/* From source.c */

extern int openp (const char *, int, const char *, int, int, char **);

extern int source_full_path_of (char *, char **);

extern void mod_path (char *, char **);

extern void directory_command (char *, int);

extern void init_source_path (void);

extern char *symtab_to_filename (struct symtab *);

/* From exec.c */

extern void exec_set_section_offsets (bfd_signed_vma text_off,

                                      bfd_signed_vma data_off,

                                      bfd_signed_vma bss_off);

/* Take over the 'find_mapped_memory' vector from exec.c. */

extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,

                                                            unsigned long,

                                                            int, int, int,

                                                            void *),

                                                   void *));

/* Possible lvalue types.  Like enum language, this should be in

   value.h, but needs to be here for the same reason. */

enum lval_type

  {

    /* Not an lval. */

    not_lval,

    /* In memory.  Could be a saved register.  */

    lval_memory,

    /* In a register.  */

    lval_register,

    /* In a gdb internal variable.  */

    lval_internalvar,

    /* Part of a gdb internal variable (structure field).  */

    lval_internalvar_component,

    /* In a register series in a frame not the current one, which may have been

       partially saved or saved in different places (otherwise would be

       lval_register or lval_memory).  */

    lval_reg_frame_relative

  };

struct frame_info;

/* From readline (but not in any readline .h files).  */

extern char *tilde_expand (char *);

/* Control types for commands */

enum misc_command_type

  {

    ok_command,

    end_command,

    else_command,

    nop_command

  };

enum command_control_type

  {

    simple_control,

    break_control,

    continue_control,

    while_control,

    if_control,

    invalid_control

  };

/* Structure for saved commands lines

   (for breakpoints, defined commands, etc).  */

struct command_line

  {

    struct command_line *next;

    char *line;

    enum command_control_type control_type;

    int body_count;

    struct command_line **body_list;

  };

extern struct command_line *read_command_lines (char *, int);

extern void free_command_lines (struct command_line **);

/* To continue the execution commands when running gdb asynchronously.

   A continuation structure contains a pointer to a function to be called

   to finish the command, once the target has stopped. Such mechanism is

   used bt the finish and until commands, and in the remote protocol

   when opening an extended-remote connection. */

struct continuation_arg

  {

    struct continuation_arg *next;

    union continuation_data {

      void *pointer;

      int   integer;

      long  longint;

    } data;

  };

struct continuation

  {

    void (*continuation_hook) (struct continuation_arg *);

    struct continuation_arg *arg_list;

    struct continuation *next;

  };

/* In infrun.c. */

extern struct continuation *cmd_continuation;

/* Used only by the step_1 function. */

extern struct continuation *intermediate_continuation;

/* From utils.c */

extern void add_continuation (void (*)(struct continuation_arg *),

                              struct continuation_arg *);

extern void do_all_continuations (void);

extern void discard_all_continuations (void);

extern void add_intermediate_continuation (void (*)(struct continuation_arg *),

                              struct continuation_arg *);

extern void do_all_intermediate_continuations (void);

extern void discard_all_intermediate_continuations (void);

/* String containing the current directory (what getwd would return).  */

extern char *current_directory;

/* Default radixes for input and output.  Only some values supported.  */

extern unsigned input_radix;

extern unsigned output_radix;

/* Possibilities for prettyprint parameters to routines which print

   things.  Like enum language, this should be in value.h, but needs

   to be here for the same reason.  FIXME:  If we can eliminate this

   as an arg to LA_VAL_PRINT, then we can probably move it back to

   value.h. */

enum val_prettyprint

  {

    Val_no_prettyprint = 0,

    Val_prettyprint,

    /* Use the default setting which the user has specified.  */

    Val_pretty_default

  };