1/* vms.h -- Header file for VMS (Alpha and Vax) support.
2   Copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2005, 2006, 2007,
3   2008, 2009, 2010 Free Software Foundation, Inc.
4
5   Main header file.
6
7   Written by Klaus K"ampf (kkaempf@rmi.de)
8
9   This file is part of BFD, the Binary File Descriptor library.
10
11   This program is free software; you can redistribute it and/or modify
12   it under the terms of the GNU General Public License as published by
13   the Free Software Foundation; either version 3 of the License, or
14   (at your option) any later version.
15
16   This program is distributed in the hope that it will be useful,
17   but WITHOUT ANY WARRANTY; without even the implied warranty of
18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19   GNU General Public License for more details.
20
21   You should have received a copy of the GNU General Public License
22   along with this program; if not, write to the Free Software
23   Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
24   MA 02110-1301, USA.  */
25
26#undef vms
27#ifndef VMS_H
28#define VMS_H
29
30#include <time.h>
31
32/* Size of a VMS block on disk.  */
33
34#define VMS_BLOCK_SIZE  512
35
36/* Miscellaneous definitions.  */
37
38#define MAX_OUTREC_SIZE 4096
39#define MIN_OUTREC_LUFT 64
40
41/* File format.  */
42
43enum file_format_enum
44  {
45    /* Not yet known.  */
46    FF_UNKNOWN,
47
48    /* Unix format.  Each record is preceeded by the record length,
49       on 2 bytes.  */
50    FF_FOREIGN,
51
52    /* Native (=VMS) format.  The file only contains the content of the
53       records.  This may also appear on Unix, depending on which tool
54       was used to transfer files.  */
55    FF_NATIVE
56  };
57
58/* VMS records input buffer.  */
59
60struct vms_rec_rd
61{
62  /* Buffer and its size.  */
63  unsigned char *buf;
64  unsigned int buf_size;
65
66  /* Current record and its size.  */
67  unsigned char *rec;
68  unsigned int rec_size;
69
70  /* Input file format.  */
71  enum file_format_enum file_format;
72};
73
74/* VMS records output buffer.  */
75
76struct vms_rec_wr
77{
78  /* Output buffer.  */
79  unsigned char *buf;
80
81  /* Current length of the record.  */
82  unsigned short int size;
83
84  /* Sub-record start offset.  */
85  unsigned short int subrec_offset;
86
87  /* Some records must have a size that is a multiple of the alignment.
88     Mustn't be 0.  */
89  unsigned short int align;
90};
91
92struct evax_private_udata_struct
93{
94  asymbol *bsym;
95  asymbol *enbsym;
96  char *origname;
97  int lkindex;
98};
99
100/* vms-misc.c.  */
101
102#define VMS_DEBUG 1
103
104#if VMS_DEBUG
105extern void _bfd_vms_debug (int, char *, ...) ATTRIBUTE_PRINTF_2;
106extern void _bfd_hexdump   (int, unsigned char *, int, int);
107
108#define vms_debug _bfd_vms_debug
109#define vms_debug2(X) _bfd_vms_debug X
110#else
111#define vms_debug2(X)
112#endif
113
114extern char * vms_get_module_name (const char *, bfd_boolean);
115extern unsigned char *get_vms_time_string (void);
116extern time_t vms_time_to_time_t (unsigned int hi, unsigned int lo);
117extern time_t vms_rawtime_to_time_t (unsigned char *);
118extern void vms_time_t_to_vms_time (time_t ut, unsigned int *hi, unsigned int *lo);
119extern void vms_get_time (unsigned int *hi, unsigned int *lo);
120extern void vms_raw_get_time (unsigned char *buf);
121
122extern char * _bfd_vms_save_sized_string (unsigned char *, int);
123extern char * _bfd_vms_save_counted_string (unsigned char *);
124extern void   _bfd_vms_output_begin (struct vms_rec_wr *, int);
125extern void   _bfd_vms_output_alignment (struct vms_rec_wr *, int);
126extern void   _bfd_vms_output_begin_subrec (struct vms_rec_wr *, int);
127extern void   _bfd_vms_output_end_subrec (struct vms_rec_wr *);
128extern void   _bfd_vms_output_end (bfd *, struct vms_rec_wr *);
129extern int    _bfd_vms_output_check (struct vms_rec_wr *, int);
130extern void   _bfd_vms_output_byte (struct vms_rec_wr *, unsigned);
131extern void   _bfd_vms_output_short (struct vms_rec_wr *, unsigned);
132extern void   _bfd_vms_output_long (struct vms_rec_wr *, unsigned long);
133extern void   _bfd_vms_output_quad (struct vms_rec_wr *, bfd_vma);
134extern void   _bfd_vms_output_counted (struct vms_rec_wr *, const char *);
135extern void   _bfd_vms_output_dump (struct vms_rec_wr *, const unsigned char *, int);
136extern void   _bfd_vms_output_fill (struct vms_rec_wr *, int, int);
137extern int    _bfd_vms_convert_to_var_unix_filename (const char *);
138
139/* vms-alpha.c  */
140
141extern void bfd_vms_set_section_flags (bfd *, asection *, flagword, flagword);
142
143#endif /* VMS_H */
144