Add GNU Free Documentation License

[binutils.git] / bfd / vms.h

#undef vms
/* vms.h -- Header file for VMS (Alpha and Vax) support.
   Copyright 1996, 1997, 1998, 1999 Free Software Foundation, Inc.

   Written by Klaus K"ampf (kkaempf@rmi.de)

This file is part of BFD, the Binary File Descriptor library.

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 VMS_H
#define VMS_H


/* Constants starting with 'Exxx_' are for openVMS/Alpha (EVAX object language)  */

/* VMS Text, information and relocation record (TIR/ETIR) definitions.  */

#define TIR_S_C_STA_GBL         0
#define TIR_S_C_STA_SB          1
#define TIR_S_C_STA_SW          2
#define TIR_S_C_STA_LW          3
#define TIR_S_C_STA_PB          4
#define TIR_S_C_STA_PW          5
#define TIR_S_C_STA_PL          6
#define TIR_S_C_STA_UB          7
#define TIR_S_C_STA_UW          8
#define TIR_S_C_STA_BFI         9
#define TIR_S_C_STA_WFI         10
#define TIR_S_C_STA_LFI         11
#define TIR_S_C_STA_EPM         12
#define TIR_S_C_STA_CKARG       13
#define TIR_S_C_STA_WPB         14
#define TIR_S_C_STA_WPW         15
#define TIR_S_C_STA_WPL         16
#define TIR_S_C_STA_LSY         17
#define TIR_S_C_STA_LIT         18
#define TIR_S_C_STA_LEPM        19
#define TIR_S_C_MAXSTACOD       19
#define TIR_S_C_MINSTOCOD       20
#define TIR_S_C_STO_SB          20
#define TIR_S_C_STO_SW          21
#define TIR_S_C_STO_L           22
#define TIR_S_C_STO_LW          22
#define TIR_S_C_STO_BD          23
#define TIR_S_C_STO_WD          24
#define TIR_S_C_STO_LD          25
#define TIR_S_C_STO_LI          26
#define TIR_S_C_STO_PIDR        27
#define TIR_S_C_STO_PICR        28
#define TIR_S_C_STO_RSB         29
#define TIR_S_C_STO_RSW         30
#define TIR_S_C_STO_RL          31
#define TIR_S_C_STO_VPS         32
#define TIR_S_C_STO_USB         33
#define TIR_S_C_STO_USW         34
#define TIR_S_C_STO_RUB         35
#define TIR_S_C_STO_RUW         36
#define TIR_S_C_STO_B           37
#define TIR_S_C_STO_W           38
#define TIR_S_C_STO_RB          39
#define TIR_S_C_STO_RW          40
#define TIR_S_C_STO_RIVB        41
#define TIR_S_C_STO_PIRR        42
#define TIR_S_C_MAXSTOCOD       42
#define TIR_S_C_MINOPRCOD       50
#define TIR_S_C_OPR_NOP         50
#define TIR_S_C_OPR_ADD         51
#define TIR_S_C_OPR_SUB         52
#define TIR_S_C_OPR_MUL         53
#define TIR_S_C_OPR_DIV         54
#define TIR_S_C_OPR_AND         55
#define TIR_S_C_OPR_IOR         56
#define TIR_S_C_OPR_EOR         57
#define TIR_S_C_OPR_NEG         58
#define TIR_S_C_OPR_COM         59
#define TIR_S_C_OPR_INSV        60
#define TIR_S_C_OPR_ASH         61
#define TIR_S_C_OPR_USH         62
#define TIR_S_C_OPR_ROT         63
#define TIR_S_C_OPR_SEL         64
#define TIR_S_C_OPR_REDEF       65
#define TIR_S_C_OPR_DFLIT       66
#define TIR_S_C_MAXOPRCOD       66
#define TIR_S_C_MINCTLCOD       80
#define TIR_S_C_CTL_SETRB       80
#define TIR_S_C_CTL_AUGRB       81
#define TIR_S_C_CTL_DFLOC       82
#define TIR_S_C_CTL_STLOC       83
#define TIR_S_C_CTL_STKDL       84
#define TIR_S_C_MAXCTLCOD       84

#define ETIR_S_C_MINSTACOD 0            /* Minimum store code           */
#define ETIR_S_C_STA_GBL 0              /* Stack global symbol value    */
#define ETIR_S_C_STA_LW 1               /* Stack longword               */
#define ETIR_S_C_STA_QW 2               /* Stack quadword               */
#define ETIR_S_C_STA_PQ 3               /* Stack psect base plus quadword offset  */
#define ETIR_S_C_STA_LI 4               /* Stack literal                */
#define ETIR_S_C_STA_MOD 5              /* Stack module                 */
#define ETIR_S_C_STA_CKARG 6            /* Check Arguments              */
#define ETIR_S_C_MAXSTACOD 6            /* Maximum stack code           */
#define ETIR_S_C_MINSTOCOD 50           /* Minimum store code           */
#define ETIR_S_C_STO_B 50               /* Store byte                   */
#define ETIR_S_C_STO_W 51               /* Store word                   */
#define ETIR_S_C_STO_LW 52              /* Store longword               */
#define ETIR_S_C_STO_QW 53              /* Store quadword               */
#define ETIR_S_C_STO_IMMR 54            /* Store immediate Repeated     */
#define ETIR_S_C_STO_GBL 55             /* Store global                 */
#define ETIR_S_C_STO_CA 56              /* Store code address           */
#define ETIR_S_C_STO_RB 57              /* Store relative branch        */
#define ETIR_S_C_STO_AB 58              /* Store absolute branch        */
#define ETIR_S_C_STO_OFF 59             /* Store offset within psect    */
#define ETIR_S_C_STO_IMM 61             /* Store immediate              */
#define ETIR_S_C_STO_GBL_LW 62          /* Store global Longword        */
#define ETIR_S_C_STO_LP_PSB 63          /* STO_LP_PSB not valid in level 2 use STC_LP_PSB                       */
#define ETIR_S_C_STO_HINT_GBL 64        /* Store 14 bit HINT at global address */
#define ETIR_S_C_STO_HINT_PS 65         /* Store 14 bit HINT at psect + offset */
#define ETIR_S_C_MAXSTOCOD 65           /* Maximum store code           */
#define ETIR_S_C_MINOPRCOD 100          /* Minimum operate code         */
#define ETIR_S_C_OPR_NOP 100            /* No-op                        */
#define ETIR_S_C_OPR_ADD 101            /* Add                          */
#define ETIR_S_C_OPR_SUB 102            /* Subtract                     */
#define ETIR_S_C_OPR_MUL 103            /* Multiply                     */
#define ETIR_S_C_OPR_DIV 104            /* Divide                       */
#define ETIR_S_C_OPR_AND 105            /* Logical AND                  */
#define ETIR_S_C_OPR_IOR 106            /* Logical inclusive OR         */
#define ETIR_S_C_OPR_EOR 107            /* Logical exclusive OR         */
#define ETIR_S_C_OPR_NEG 108            /* Negate                       */
#define ETIR_S_C_OPR_COM 109            /* Complement                   */
#define ETIR_S_C_OPR_INSV 110           /* Insert bit field             */
#define ETIR_S_C_OPR_ASH 111            /* Arithmetic shift             */
#define ETIR_S_C_OPR_USH 112            /* Unsigned shift               */
#define ETIR_S_C_OPR_ROT 113            /* Rotate                       */
#define ETIR_S_C_OPR_SEL 114            /* Select one of three longwords on top of stack  */
#define ETIR_S_C_OPR_REDEF 115          /* Redefine this symbol after pass 2  */
#define ETIR_S_C_OPR_DFLIT 116          /* Define a literal             */
#define ETIR_S_C_MAXOPRCOD 116          /* Maximum operate code         */
#define ETIR_S_C_MINCTLCOD 150          /* Minimum control code         */
#define ETIR_S_C_CTL_SETRB 150          /* Set relocation base          */
#define ETIR_S_C_CTL_AUGRB 151          /* Augment relocation base      */
#define ETIR_S_C_CTL_DFLOC 152          /* Define debug location        */
#define ETIR_S_C_CTL_STLOC 153          /* Set debug location           */
#define ETIR_S_C_CTL_STKDL 154          /* Stack debug location         */
#define ETIR_S_C_MAXCTLCOD 154          /* Maximum control code         */
#define ETIR_S_C_MINSTCCOD 200          /* Minimum store-conditional code    */
#define ETIR_S_C_STC_LP 200             /* Store-conditional Linkage Pair    */
#define ETIR_S_C_STC_LP_PSB 201         /* Store-conditional Linkage Pair with Procedure Signature */
#define ETIR_S_C_STC_GBL 202            /* Store-conditional Address at global address */
#define ETIR_S_C_STC_GCA 203            /* Store-conditional Code Address at global address */
#define ETIR_S_C_STC_PS 204             /* Store-conditional Address at psect + offset */
#define ETIR_S_C_STC_NOP_GBL 205        /* Store-conditional NOP at address of global */
#define ETIR_S_C_STC_NOP_PS 206         /* Store-conditional NOP at pect + offset */
#define ETIR_S_C_STC_BSR_GBL 207        /* Store-conditional BSR at global address */
#define ETIR_S_C_STC_BSR_PS 208         /* Store-conditional BSR at pect + offset */
#define ETIR_S_C_STC_LDA_GBL 209        /* Store-conditional LDA at global address */
#define ETIR_S_C_STC_LDA_PS 210         /* Store-conditional LDA at psect + offset */
#define ETIR_S_C_STC_BOH_GBL 211        /* Store-conditional BSR or Hint at global address */
#define ETIR_S_C_STC_BOH_PS 212         /* Store-conditional BSR or Hint at pect + offset */
#define ETIR_S_C_STC_NBH_GBL 213        /* Store-conditional NOP,BSR or HINT at global address */
#define ETIR_S_C_STC_NBH_PS 214         /* Store-conditional NOP,BSR or HINT at psect + offset */
#define ETIR_S_C_MAXSTCCOD 214          /* Maximum store-conditional code    */

/* VMS Global symbol definition record (GSD/EGSD).  */

#define GSD_S_K_ENTRIES 1
#define GSD_S_C_ENTRIES 1
#define GSD_S_C_PSC     0
#define GSD_S_C_SYM     1
#define GSD_S_C_EPM     2
#define GSD_S_C_PRO     3
#define GSD_S_C_SYMW    4
#define GSD_S_C_EPMW    5
#define GSD_S_C_PROW    6
#define GSD_S_C_IDC     7
#define GSD_S_C_ENV     8
#define GSD_S_C_LSY     9
#define GSD_S_C_LEPM    10
#define GSD_S_C_LPRO    11
#define GSD_S_C_SPSC    12
#define GSD_S_C_SYMV    13
#define GSD_S_C_EPMV    14
#define GSD_S_C_PROV    15
#define GSD_S_C_MAXRECTYP       15

#define EGSD_S_K_ENTRIES 2      /* Offset to first entry in record      */
#define EGSD_S_C_ENTRIES 2      /* Offset to first entry in record      */
#define EGSD_S_C_PSC 0          /* Psect definition                     */
#define EGSD_S_C_SYM 1          /* Symbol specification                 */
#define EGSD_S_C_IDC 2          /* Random entity check                  */
#define EGSD_S_C_SPSC 5         /* Shareable image psect definition     */
#define EGSD_S_C_SYMV 6         /* Vectored (dual-valued) versions of SYM, */
#define EGSD_S_C_SYMM 7         /* Masked versions of SYM,              */
#define EGSD_S_C_SYMG 8         /* EGST - gst version of SYM            */
#define EGSD_S_C_MAXRECTYP 8    /* Maximum entry type defined           */

#define GPS_S_M_PIC     1
#define GPS_S_M_LIB     2
#define GPS_S_M_OVR     4
#define GPS_S_M_REL     8
#define GPS_S_M_GBL     16
#define GPS_S_M_SHR     32
#define GPS_S_M_EXE     64
#define GPS_S_M_RD      128
#define GPS_S_M_WRT     256
#define GPS_S_M_VEC     512
#define GPS_S_K_NAME    9
#define GPS_S_C_NAME    9

#define EGPS_S_V_PIC    0x0001
#define EGPS_S_V_LIB    0x0002
#define EGPS_S_V_OVR    0x0004
#define EGPS_S_V_REL    0x0008
#define EGPS_S_V_GBL    0x0010
#define EGPS_S_V_SHR    0x0020
#define EGPS_S_V_EXE    0x0040
#define EGPS_S_V_RD     0x0080
#define EGPS_S_V_WRT    0x0100
#define EGPS_S_V_VEC    0x0200
#define EGPS_S_V_NOMOD  0x0400
#define EGPS_S_V_COM    0x0800

#define GSY_S_M_WEAK    1
#define GSY_S_M_DEF     2
#define GSY_S_M_UNI     4
#define GSY_S_M_REL     8

#define EGSY_S_V_WEAK   0x0001
#define EGSY_S_V_DEF    0x0002
#define EGSY_S_V_UNI    0x0004
#define EGSY_S_V_REL    0x0008
#define EGSY_S_V_COMM   0x0010
#define EGSY_S_V_VECEP  0x0020
#define EGSY_S_V_NORM   0x0040

#define LSY_S_M_DEF     2
#define LSY_S_M_REL     8

#define ENV_S_M_DEF     1
#define ENV_S_M_NESTED  2

/*
 *      Debugger symbol definitions:  These are done by hand, as no
 *                                      machine-readable version seems
 *                                      to be available.
 */
#define DST_S_C_C                 7     /* Language == "C"      */
#define DST_S_C_CXX              15     /* Language == "C++"    */
#define DST_S_C_VERSION         153
#define DST_S_C_SOURCE          155     /* Source file          */
#define DST_S_C_PROLOG          162
#define DST_S_C_BLKBEG          176     /* Beginning of block   */
#define DST_S_C_BLKEND          177     /* End of block */
#define DST_S_C_ENTRY           181
#define DST_S_C_PSECT           184
#define DST_S_C_LINE_NUM        185     /* Line Number          */
#define DST_S_C_LBLORLIT        186
#define DST_S_C_LABEL           187
#define DST_S_C_MODBEG          188     /* Beginning of module  */
#define DST_S_C_MODEND          189     /* End of module        */
#define DST_S_C_RTNBEG          190     /* Beginning of routine */
#define DST_S_C_RTNEND          191     /* End of routine       */
#define DST_S_C_DELTA_PC_W      1       /* Incr PC      */
#define DST_S_C_INCR_LINUM      2       /* Incr Line #  */
#define DST_S_C_INCR_LINUM_W    3       /* Incr Line #  */
#define DST_S_C_SET_LINUM_INCR  4
#define DST_S_C_SET_LINUM_INCR_W 5
#define DST_S_C_RESET_LINUM_INCR 6
#define DST_S_C_BEG_STMT_MODE   7
#define DST_S_C_END_STMT_MODE   8
#define DST_S_C_SET_LINE_NUM    9       /* Set Line #   */
#define DST_S_C_SET_PC          10
#define DST_S_C_SET_PC_W        11
#define DST_S_C_SET_PC_L        12
#define DST_S_C_SET_STMTNUM     13
#define DST_S_C_TERM            14      /* End of lines */
#define DST_S_C_TERM_W          15      /* End of lines */
#define DST_S_C_SET_ABS_PC      16      /* Set PC       */
#define DST_S_C_DELTA_PC_L      17      /* Incr PC      */
#define DST_S_C_INCR_LINUM_L    18      /* Incr Line #  */
#define DST_S_C_SET_LINUM_B     19      /* Set Line #   */
#define DST_S_C_SET_LINUM_L     20      /* Set Line #   */
#define DST_S_C_TERM_L          21      /* End of lines */
/* these are used with DST_S_C_SOURCE */
#define DST_S_C_SRC_DECLFILE     1      /* Declare source file */
#define DST_S_C_SRC_SETFILE      2      /* Set source file */
#define DST_S_C_SRC_SETREC_L     3      /* Set record, longword value */
#define DST_S_C_SRC_SETREC_W     4      /* Set record, word value */
#define DST_S_C_SRC_DEFLINES_W  10      /* # of line, word counter */
#define DST_S_C_SRC_DEFLINES_B  11      /* # of line, byte counter */
#define DST_S_C_SRC_FORMFEED    16      /* ^L counts as a record */
/* the following are the codes for the various data types.  Anything not on
 * the list is included under 'advanced_type'
 */
#define DBG_S_C_UCHAR           0x02
#define DBG_S_C_USINT           0x03
#define DBG_S_C_ULINT           0x04
#define DBG_S_C_UQUAD           0x05
#define DBG_S_C_SCHAR           0x06
#define DBG_S_C_SSINT           0x07
#define DBG_S_C_SLINT           0x08
#define DBG_S_C_SQUAD           0x09
#define DBG_S_C_REAL4           0x0a
#define DBG_S_C_REAL8           0x0b            /* D_float double */
#define DBG_S_C_COMPLX4         0x0c            /* 2xF_float complex float */
#define DBG_S_C_COMPLX8         0x0d            /* 2xD_float complex double */
#define DBG_S_C_REAL8_G         0x1b            /* G_float double */
#define DBG_S_C_COMPLX8_G       0x1d            /* 2xG_float complex double */
#define DBG_S_C_FUNCTION_ADDR   0x17
#define DBG_S_C_ADVANCED_TYPE   0xa3
/*  Some of these are just for future reference.  [pr]
 */
#define DBG_S_C_UBITA           0x01    /* unsigned, aligned bit field */
#define DBG_S_C_UBITU           0x22    /* unsigned, unaligned bit field */
#define DBG_S_C_SBITA           0x29    /* signed, aligned bit field */
#define DBG_S_C_SBITU           0x2a    /* signed, unaligned bit field */
#define DBG_S_C_CSTRING         0x2e    /* asciz ('\0' terminated) string */
#define DBG_S_C_WCHAR           0x38    /* wchar_t */
/*  These are descriptor class codes.
 */
#define DSC_K_CLASS_S           0x01    /* static (fixed length) */
#define DSC_K_CLASS_D           0x02    /* dynamic string (not via malloc!) */
#define DSC_K_CLASS_A           0x04    /* array */
#define DSC_K_CLASS_UBS         0x0d    /* unaligned bit string */
/*  These are the codes that are used to generate the definitions of struct
 *  union and enum records
 */
#define DBG_S_C_ENUM_ITEM               0xa4
#define DBG_S_C_ENUM_START              0xa5
#define DBG_S_C_ENUM_END                0xa6
#define DBG_S_C_STRUCT_ITEM             DST_K_VFLAGS_BITOFFS    /* 0xff */
#define DBG_S_C_STRUCT_START            0xab
#define DBG_S_C_STRUCT_END              0xac
#define DST_K_TYPSPEC                   0xaf            /* type specification */
/* These codes are used in the generation of the symbol definition records
 */
#define DST_K_VFLAGS_NOVAL              0x80    /* struct definition only */
#define DST_K_VFLAGS_DSC                0xfa    /* descriptor used */
#define DST_K_VFLAGS_TVS                0xfb    /* trailing value specified */
#define DST_K_VS_FOLLOWS                0xfd    /* value spec follows */
#define DST_K_VFLAGS_BITOFFS            0xff    /* value contains bit offset */
#define DST_K_VALKIND_LITERAL   0
#define DST_K_VALKIND_ADDR      1
#define DST_K_VALKIND_DESC      2
#define DST_K_VALKIND_REG       3
#define DST_K_REG_VAX_AP        0x0c    /* R12 */
#define DST_K_REG_VAX_FP        0x0d    /* R13 */
#define DST_K_REG_VAX_SP        0x0e    /* R14 */
#define DST_V_VALKIND           0       /* offset of valkind field */
#define DST_V_INDIRECT          2       /* offset to indirect bit */
#define DST_V_DISP              3       /* offset to displacement bit */
#define DST_V_REGNUM            4       /* offset to register number */
#define DST_M_INDIRECT          (1<<DST_V_INDIRECT)
#define DST_M_DISP              (1<<DST_V_DISP)
#define DBG_C_FUNCTION_PARAM    /* 0xc9 */      \
        (DST_K_VALKIND_ADDR|DST_M_DISP|(DST_K_REG_VAX_AP<<DST_V_REGNUM))
#define DBG_C_LOCAL_SYM         /* 0xd9 */      \
        (DST_K_VALKIND_ADDR|DST_M_DISP|(DST_K_REG_VAX_FP<<DST_V_REGNUM))
/* Kinds of value specifications
 */
#define DST_K_VS_ALLOC_SPLIT    3       /* split lifetime */
/* Kinds of type specifications
 */
#define DST_K_TS_ATOM           0x01    /* atomic type specification */
#define DST_K_TS_DSC            0x02    /* descriptor type spec */
#define DST_K_TS_IND            0x03    /* indirect type specification */
#define DST_K_TS_TPTR           0x04    /* typed pointer type spec */
#define DST_K_TS_PTR            0x05    /* pointer type spec */
#define DST_K_TS_ARRAY          0x07    /* array type spec */
#define DST_K_TS_NOV_LENG       0x0e    /* novel length type spec */
/*  These are the codes that are used in the suffix records to determine the
 *  actual data type
 */
#define DBG_S_C_BASIC                   DST_K_TS_ATOM
#define DBG_S_C_BASIC_ARRAY             DST_K_TS_DSC
#define DBG_S_C_STRUCT                  DST_K_TS_IND
#define DBG_S_C_POINTER                 DST_K_TS_TPTR
#define DBG_S_C_VOID                    DST_K_TS_PTR
#define DBG_S_C_COMPLEX_ARRAY           DST_K_TS_ARRAY

/* VMS Module header record (EMH) definitions.  */

#define MHD_S_C_MHD 0
#define MHD_S_C_LNM 1
#define MHD_S_C_SRC 2
#define MHD_S_C_TTL 3
#define MHD_S_C_CPR 4
#define MHD_S_C_MTC 5
#define MHD_S_C_GTX 6
#define MHD_S_C_MAXHDRTYP 6

#define EMH_S_C_MHD 0           /* Main header record           */
#define EMH_S_C_LNM 1           /* Language name and version    */
#define EMH_S_C_SRC 2           /* Source file specification    */
#define EMH_S_C_TTL 3           /* Title text of module         */
#define EMH_S_C_CPR 4           /* Copyright notice             */
#define EMH_S_C_MTC 5           /* Maintenance status           */
#define EMH_S_C_GTX 6           /* General text                 */
#define EMH_S_C_MAXHDRTYP 6     /* Maximum allowable type       */

/* vms.c.  */

extern asymbol *_bfd_vms_make_empty_symbol PARAMS ((bfd *abfd));

/* vms-gsd.c.  */

extern int _bfd_vms_slurp_gsd PARAMS ((bfd *abfd, int objtype));
extern int _bfd_vms_write_gsd PARAMS ((bfd *abfd, int objtype));

/* vms-mhd.c.  */

extern int _bfd_vms_slurp_hdr PARAMS ((bfd *abfd, int objtype));
extern int _bfd_vms_write_hdr PARAMS ((bfd *abfd, int objtype));
extern int _bfd_vms_slurp_eom PARAMS ((bfd *abfd, int objtype));
extern int _bfd_vms_write_eom PARAMS ((bfd *abfd, int objtype));

/* vms-tir.c.  */

extern int _bfd_vms_slurp_tir PARAMS ((bfd *abfd, int objtype));
extern int _bfd_vms_slurp_dbg PARAMS ((bfd *abfd, int objtype));
extern int _bfd_vms_slurp_tbt PARAMS ((bfd *abfd, int objtype));
extern int _bfd_vms_slurp_lnk PARAMS ((bfd *abfd, int objtype));

extern int _bfd_vms_write_tir PARAMS ((bfd *abfd, int objtype));
extern int _bfd_vms_write_tbt PARAMS ((bfd *abfd, int objtype));
extern int _bfd_vms_write_dbg PARAMS ((bfd *abfd, int objtype));

/* The r_type field in a reloc is one of the following values.  */
#define ALPHA_R_IGNORE          0
#define ALPHA_R_REFQUAD         1
#define ALPHA_R_BRADDR          2
#define ALPHA_R_HINT            3
#define ALPHA_R_SREL16          4
#define ALPHA_R_SREL32          5
#define ALPHA_R_SREL64          6
#define ALPHA_R_OP_PUSH         7
#define ALPHA_R_OP_STORE        8
#define ALPHA_R_OP_PSUB         9
#define ALPHA_R_OP_PRSHIFT      10
#define ALPHA_R_LINKAGE         11
#define ALPHA_R_REFLONG         12
#define ALPHA_R_CODEADDR        13

/* Object language definitions.  */

#define OBJ_S_C_HDR 0           /*VAX module header record              */
#define OBJ_S_C_GSD 1           /*VAX global symbol definition record   */
#define OBJ_S_C_TIR 2           /*VAX text information record           */
#define OBJ_S_C_EOM 3           /*VAX end of module record              */
#define OBJ_S_C_DBG 4           /*VAX Debugger information record       */
#define OBJ_S_C_TBT 5           /*VAX Traceback information record      */
#define OBJ_S_C_LNK 6           /*VAX linker options record             */
#define OBJ_S_C_EOMW 7          /*VAX end of module word-psect record   */
#define OBJ_S_C_MAXRECTYP 7     /*VAX Last assigned record type         */
#define EOBJ_S_C_EMH 8          /*EVAX module header record             */
#define EOBJ_S_C_EEOM 9         /*EVAX end of module record             */
#define EOBJ_S_C_EGSD 10        /*EVAX global symbol definition record  */
#define EOBJ_S_C_ETIR 11        /*EVAX text information record          */
#define EOBJ_S_C_EDBG 12        /*EVAX Debugger information record      */
#define EOBJ_S_C_ETBT 13        /*EVAX Traceback information record     */
#define EOBJ_S_C_MAXRECTYP 13   /*EVAX Last assigned record type        */
#define OBJ_S_K_SUBTYP 1
#define OBJ_S_C_SUBTYP 1
#define EOBJ_S_K_SUBTYP 4
#define EOBJ_S_C_SUBTYP 4
#define OBJ_S_C_MAXRECSIZ 2048  /*Maximum legal record size         */
#define EOBJ_S_C_MAXRECSIZ 8192 /*Maximum legal record size         */
#define OBJ_S_C_STRLVL 0        /*Structure level                   */
#define EOBJ_S_C_STRLVL 2       /*Structure level                   */
#define OBJ_S_C_SYMSIZ 31       /*Maximum symbol length         */
#define EOBJ_S_C_SYMSIZ 64      /*Maximum symbol length         */
#define EOBJ_S_C_SECSIZ 31      /*Maximum section name length           */
#define OBJ_S_C_STOREPLIM -1    /*Maximum repeat count on store commands  */
#define EOBJ_S_C_STOREPLIM -1   /*Maximum repeat count on store commands  */
#define OBJ_S_C_PSCALILIM 9     /*Maximum p-sect alignment          */
#define EOBJ_S_C_PSCALILIM 16   /*Maximum p-sect alignment          */

#define EVAX_OFFSET     256     /*type offset for EVAX codes in switch  */
/* Miscellaneous definitions.  */

#if __GNUC__
typedef unsigned long long uquad;
#else
typedef unsigned long uquad;
#endif

#define MAX_OUTREC_SIZE 4096
#define MIN_OUTREC_LUFT 64

typedef struct _vms_section {
  unsigned char *contents;
  bfd_vma offset;
  bfd_size_type size;
  struct _vms_section *next;
} vms_section;

extern boolean _bfd_save_vms_section
  PARAMS ((bfd *abfd, asection *section, PTR data, file_ptr offset,
           bfd_size_type count));
extern vms_section *_bfd_get_vms_section PARAMS ((bfd *abfd, int index));

typedef struct _vms_reloc {
  struct _vms_reloc *next;
  arelent *reloc;
  asection *section;
} vms_reloc;

/* vms module header  */

struct hdr_struc {
  int hdr_b_strlvl;
  long hdr_l_arch1;
  long hdr_l_arch2;
  long hdr_l_recsiz;
  char *hdr_t_name;
  char *hdr_t_version;
  char *hdr_t_date;
  char *hdr_c_lnm;
  char *hdr_c_src;
  char *hdr_c_ttl;
};


/* vms end of module  */

struct eom_struc {
  long eom_l_total_lps;
  unsigned char eom_b_comcod;
  boolean eom_has_transfer;
  unsigned char eom_b_tfrflg;
  long eom_l_psindx;
  long eom_l_tfradr;
};

enum file_format_enum { FF_UNKNOWN, FF_FOREIGN, FF_NATIVE, FF_VAX };

typedef struct vms_symbol_struct {
  struct bfd_hash_entry bfd_hash;
  asymbol *symbol;
} vms_symbol_entry;

/* stack value for push/pop commands  */

struct stack_struct {
  uquad value;
  int psect;
};
#define STACKSIZE 8192

/* location stack definitions for CTL_DFLOC, CTL_STLOC, and CTL_STKDL  */

struct location_struct {
  unsigned long value;
  int psect;
};
#define LOCATION_SAVE_SIZE 32

#define VMS_SECTION_COUNT 1024

struct vms_private_data_struct {
  int is_vax;
  boolean fixup_done;                   /* Flag to indicate if all
                                           section pointers and PRIV(sections)
                                           are set up correctly  */
  unsigned char *vms_buf;               /* buffer to record  */
  int buf_size;                         /* max size of buffer  */
  unsigned char *vms_rec;               /* actual record ptr  */
  int rec_length;                       /* remaining record length  */
  int rec_size;                         /* actual record size  */
  int rec_type;                         /* actual record type  */
  enum file_format_enum file_format;

  struct hdr_struc hdr_data;            /* data from HDR/EMH record  */
  struct eom_struc eom_data;            /* data from EOM/EEOM record  */
  unsigned int section_count;           /* # of sections in following array  */
  asection **sections;                  /* array of GSD/EGSD sections  */
  int gsd_sym_count;                    /* # of GSD/EGSD symbols  */
  asymbol **symbols;                    /* vector of GSD/EGSD symbols  */
  struct proc_value *procedure;

  struct stack_struct *stack;
  int stackptr;

  vms_section *vms_section_table[VMS_SECTION_COUNT];

  struct bfd_hash_table *vms_symbol_table;
  struct symbol_cache_entry **symcache;
  int symnum;

  struct location_struct *location_stack;

  asection *image_section;              /* section for image_ptr  */
  unsigned char *image_ptr;             /* a pointer to section->contents */

  unsigned char pdsc[8];                /* procedure descriptor */

  /* Output routine storage  */

  unsigned char *output_buf;            /* output data  */
  int push_level;
  int pushed_size;
  int length_pos;
  int output_size;
  int output_alignment;

  /* linkage index counter
   used by conditional store commands (ETIR_S_C_STC_)  */

  int vms_linkage_index;

  /* see tc-alpha.c of gas for a description.  */
  int flag_hash_long_names;     /* -+, hash instead of truncate */
  int flag_show_after_trunc;    /* -H, show hashing/truncation */
};

#define PRIV(name)      ((struct vms_private_data_struct *)abfd->tdata.any)->name

#define SECTION_NAME_TEMPLATE "__SEC__%d"

#if VMS_DEBUG
extern void _bfd_vms_debug PARAMS((int level, char *format, ...));
extern void _bfd_hexdump
  PARAMS ((int level, unsigned char *ptr, int size, int offset));

#define vms_debug _bfd_vms_debug
#endif

extern struct bfd_hash_entry *_bfd_vms_hash_newfunc
  PARAMS ((struct bfd_hash_entry *entry, struct bfd_hash_table *table,
           const char *string));
extern void _bfd_vms_get_header_values
  PARAMS ((bfd *abfd, unsigned char *buf, int *type, int *length));
extern int _bfd_vms_get_record PARAMS ((bfd *abfd));
extern int _bfd_vms_next_record PARAMS ((bfd *abfd));

extern char *_bfd_vms_save_sized_string PARAMS ((unsigned char *str, int size));
extern char *_bfd_vms_save_counted_string PARAMS ((unsigned char *ptr));
extern void _bfd_vms_push PARAMS ((bfd *abfd, uquad val, int psect));
extern uquad _bfd_vms_pop PARAMS ((bfd *abfd, int *psect));

extern boolean _bfd_save_vms_section
  PARAMS ((bfd *abfd, asection *section, PTR data, file_ptr offset,
           bfd_size_type count));
extern void _bfd_vms_output_begin
  PARAMS ((bfd *abfd, int rectype, int rechead));
extern void _bfd_vms_output_alignment PARAMS ((bfd *abfd, int alignto));
extern void _bfd_vms_output_push PARAMS ((bfd *abfd));
extern void _bfd_vms_output_pop PARAMS ((bfd *abfd));
extern void _bfd_vms_output_flush PARAMS ((bfd *abfd));
extern void _bfd_vms_output_end PARAMS ((bfd *abfd));
extern int _bfd_vms_output_check PARAMS ((bfd *abfd, int size));
extern void _bfd_vms_output_byte PARAMS ((bfd *abfd, unsigned int value));
extern void _bfd_vms_output_short PARAMS ((bfd *abfd, unsigned int value));
extern void _bfd_vms_output_long PARAMS ((bfd *abfd, unsigned long value));
extern void _bfd_vms_output_quad PARAMS ((bfd *abfd, uquad value));
extern void _bfd_vms_output_counted PARAMS ((bfd *abfd, char *value));
extern void _bfd_vms_output_dump PARAMS ((bfd *abfd, unsigned char *data,
                                           int length));
extern void _bfd_vms_output_fill PARAMS ((bfd *abfd, int value, int length));
extern char *_bfd_vms_length_hash_symbol PARAMS ((bfd *abfd, const char *in, int maxlen));

extern vms_symbol_entry *_bfd_vms_enter_symbol PARAMS ((bfd *abfd, char *name));

#endif /* VMS_H */