1 /* vms-misc.c -- BFD back-end for VMS/VAX (openVMS/VAX) and
2 EVAX (openVMS/Alpha) files.
3 Copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 Miscellaneous functions.
8 Written by Klaus K"ampf (kkaempf@rmi.de)
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
23 MA 02110-1301, USA. */
33 #include "safe-ctype.h"
36 #if defined(__GNUC__) && !defined(globalref)
37 #define globalref extern
42 #define RME$C_SETRFM 0x00000001
51 /* Debug functions. */
53 /* Debug function for all vms extensions evaluates environment
54 variable VMS_DEBUG for a numerical value on the first call all
55 error levels below this value are printed:
58 1 toplevel bfd calls (functions from the bfd vector)
59 2 functions called by bfd calls
63 Level is also indentation level. Indentation is performed
67 _bfd_vms_debug (int level
, char *format
, ...)
69 static int min_level
= -1;
70 static FILE *output
= NULL
;
73 int abslvl
= (level
> 0) ? level
: - level
;
77 if ((eptr
= getenv ("VMS_DEBUG")) != NULL
)
79 min_level
= atoi (eptr
);
87 if (abslvl
> min_level
)
91 fprintf (output
, " ");
92 va_start (args
, format
);
93 vfprintf (output
, format
, args
);
99 hex dump 'size' bytes starting at 'ptr'. */
102 _bfd_hexdump (int level
, unsigned char *ptr
, int size
, int offset
)
104 unsigned char *lptr
= ptr
;
110 if ((count
% 16) == 0)
111 vms_debug (level
, "%08lx:", start
);
112 vms_debug (-level
, " %02x", *ptr
++);
117 while ((count
% 16) != 0)
119 vms_debug (-level
, " ");
123 if ((count
% 16) == 0)
125 vms_debug (-level
, " ");
128 vms_debug (-level
, "%c", (*lptr
< 32) ? '.' : *lptr
);
131 vms_debug (-level
, "\n");
134 if ((count
% 16) != 0)
135 vms_debug (-level
, "\n");
140 /* Copy sized string (string with fixed size) to new allocated area
141 size is string size (size of record) */
144 _bfd_vms_save_sized_string (unsigned char *str
, int size
)
146 char *newstr
= bfd_malloc ((bfd_size_type
) size
+ 1);
150 memcpy (newstr
, (char *) str
, (size_t) size
);
156 /* Copy counted string (string with size at first byte) to new allocated area
157 ptr points to size byte on entry */
160 _bfd_vms_save_counted_string (unsigned char *ptr
)
164 return _bfd_vms_save_sized_string (ptr
, len
);
167 /* Object output routines. */
170 Write 2 bytes rectype and 2 bytes record length. */
173 _bfd_vms_output_begin (struct vms_rec_wr
*recwr
, int rectype
)
175 vms_debug2 ((6, "_bfd_vms_output_begin (type %d)\n", rectype
));
177 /* Record must have been closed. */
178 BFD_ASSERT (recwr
->size
== 0);
180 _bfd_vms_output_short (recwr
, (unsigned int) rectype
);
182 /* Placeholder for length. */
183 _bfd_vms_output_short (recwr
, 0);
186 /* Begin new sub-record.
187 Write 2 bytes rectype, and 2 bytes record length. */
190 _bfd_vms_output_begin_subrec (struct vms_rec_wr
*recwr
, int rectype
)
192 vms_debug2 ((6, "_bfd_vms_output_begin_subrec (type %d)\n", rectype
));
194 /* Subrecord must have been closed. */
195 BFD_ASSERT (recwr
->subrec_offset
== 0);
197 /* Save start of subrecord offset. */
198 recwr
->subrec_offset
= recwr
->size
;
200 /* Subrecord type. */
201 _bfd_vms_output_short (recwr
, (unsigned int) rectype
);
203 /* Placeholder for length. */
204 _bfd_vms_output_short (recwr
, 0);
207 /* Set record/subrecord alignment. */
210 _bfd_vms_output_alignment (struct vms_rec_wr
*recwr
, int alignto
)
212 vms_debug2 ((6, "_bfd_vms_output_alignment (%d)\n", alignto
));
213 recwr
->align
= alignto
;
216 /* Align the size of the current record (whose length is LENGTH).
217 Warning: this obviously changes the record (and the possible subrecord)
221 _bfd_vms_output_align (struct vms_rec_wr
*recwr
, unsigned int length
)
223 unsigned int real_size
= recwr
->size
;
224 unsigned int aligncount
;
226 /* Pad with 0 if alignment is required. */
227 aligncount
= (recwr
->align
- (length
% recwr
->align
)) % recwr
->align
;
228 vms_debug2 ((6, "align: adding %d bytes\n", aligncount
));
229 while (aligncount
-- > 0)
230 recwr
->buf
[real_size
++] = 0;
232 recwr
->size
= real_size
;
235 /* Ends current sub-record. Set length field. */
238 _bfd_vms_output_end_subrec (struct vms_rec_wr
*recwr
)
240 int real_size
= recwr
->size
;
243 /* Subrecord must be open. */
244 BFD_ASSERT (recwr
->subrec_offset
!= 0);
246 length
= real_size
- recwr
->subrec_offset
;
251 _bfd_vms_output_align (recwr
, length
);
253 /* Put length to buffer. */
254 bfd_putl16 ((bfd_vma
) (recwr
->size
- recwr
->subrec_offset
),
255 recwr
->buf
+ recwr
->subrec_offset
+ 2);
257 /* Close the subrecord. */
258 recwr
->subrec_offset
= 0;
261 /* Ends current record (and write it). */
264 _bfd_vms_output_end (bfd
*abfd
, struct vms_rec_wr
*recwr
)
266 vms_debug2 ((6, "_bfd_vms_output_end (size %u)\n", recwr
->size
));
268 /* Subrecord must have been closed. */
269 BFD_ASSERT (recwr
->subrec_offset
== 0);
271 if (recwr
->size
== 0)
274 _bfd_vms_output_align (recwr
, recwr
->size
);
276 /* Write the length word. */
277 bfd_putl16 ((bfd_vma
) recwr
->size
, recwr
->buf
+ 2);
279 /* File is open in undefined (UDF) format on VMS, but ultimately will be
280 converted to variable length (VAR) format. VAR format has a length
281 word first which must be explicitly output in UDF format. */
282 /* So, first the length word. */
283 bfd_bwrite (recwr
->buf
+ 2, 2, abfd
);
287 recwr
->buf
[recwr
->size
++] = 0;
289 /* Then the record. */
290 bfd_bwrite (recwr
->buf
, (size_t) recwr
->size
, abfd
);
295 /* Check remaining buffer size. Return what's left. */
298 _bfd_vms_output_check (struct vms_rec_wr
*recwr
, int size
)
300 vms_debug2 ((6, "_bfd_vms_output_check (%d)\n", size
));
302 return (MAX_OUTREC_SIZE
- (recwr
->size
+ size
+ MIN_OUTREC_LUFT
));
305 /* Output byte (8 bit) value. */
308 _bfd_vms_output_byte (struct vms_rec_wr
*recwr
, unsigned int value
)
310 vms_debug2 ((6, "_bfd_vms_output_byte (%02x)\n", value
));
312 *(recwr
->buf
+ recwr
->size
) = value
;
316 /* Output short (16 bit) value. */
319 _bfd_vms_output_short (struct vms_rec_wr
*recwr
, unsigned int value
)
321 vms_debug2 ((6, "_bfd_vms_output_short (%04x)\n", value
));
323 bfd_putl16 ((bfd_vma
) value
& 0xffff, recwr
->buf
+ recwr
->size
);
327 /* Output long (32 bit) value. */
330 _bfd_vms_output_long (struct vms_rec_wr
*recwr
, unsigned long value
)
332 vms_debug2 ((6, "_bfd_vms_output_long (%08lx)\n", value
));
334 bfd_putl32 ((bfd_vma
) value
, recwr
->buf
+ recwr
->size
);
338 /* Output quad (64 bit) value. */
341 _bfd_vms_output_quad (struct vms_rec_wr
*recwr
, bfd_vma value
)
343 vms_debug2 ((6, "_bfd_vms_output_quad (%08lx)\n", (unsigned long)value
));
345 bfd_putl64 (value
, recwr
->buf
+ recwr
->size
);
349 /* Output c-string as counted string. */
352 _bfd_vms_output_counted (struct vms_rec_wr
*recwr
, char *value
)
356 vms_debug2 ((6, "_bfd_vms_output_counted (%s)\n", value
));
358 len
= strlen (value
);
361 (*_bfd_error_handler
) (_("_bfd_vms_output_counted called with zero bytes"));
366 (*_bfd_error_handler
) (_("_bfd_vms_output_counted called with too many bytes"));
369 _bfd_vms_output_byte (recwr
, (unsigned int) len
& 0xff);
370 _bfd_vms_output_dump (recwr
, (unsigned char *) value
, len
);
373 /* Output character area. */
376 _bfd_vms_output_dump (struct vms_rec_wr
*recwr
, unsigned char *data
, int len
)
378 vms_debug2 ((6, "_bfd_vms_output_dump (%d)\n", len
));
383 memcpy (recwr
->buf
+ recwr
->size
, data
, (size_t) len
);
387 /* Output count bytes of value. */
390 _bfd_vms_output_fill (struct vms_rec_wr
*recwr
, int value
, int count
)
392 vms_debug2 ((6, "_bfd_vms_output_fill (val %02x times %d)\n", value
, count
));
396 memset (recwr
->buf
+ recwr
->size
, value
, (size_t) count
);
397 recwr
->size
+= count
;
401 /* Convert the file to variable record length format. This is done
402 using undocumented system call sys$modify().
406 _bfd_vms_convert_to_var (char * vms_filename
)
408 struct FAB fab
= cc$rms_fab
;
410 fab
.fab$l_fna
= vms_filename
;
411 fab
.fab$b_fns
= strlen (vms_filename
);
412 fab
.fab$b_fac
= FAB$M_PUT
;
413 fab
.fab$l_fop
= FAB$M_ESC
;
414 fab
.fab$l_ctx
= RME$C_SETRFM
;
418 fab
.fab$b_rfm
= FAB$C_VAR
;
425 vms_convert_to_var_1 (char *filename
, int type
)
427 if (type
!= DECC$K_FILE
)
429 vms_convert_to_var (filename
);
433 /* Convert the file to variable record length format. This is done
434 using undocumented system call sys$modify().
435 Unix filename version. */
438 vms_convert_to_var_unix_filename (const char *unix_filename
)
440 if (decc$
to_vms (unix_filename
, &vms_convert_to_var_1
, 0, 1) != 1)
446 /* Manufacture a VMS like time on a unix based system.
447 stolen from obj-vms.c. */
450 get_vms_time_string (void)
452 static unsigned char tbuf
[18];
458 pnt
= ctime (&timeb
);
464 sprintf ((char *) tbuf
, "%2s-%3s-%s %s",
465 pnt
+ 8, pnt
+ 4, pnt
+ 20, pnt
+ 11);
472 Descriptor
.Size
= 17;
473 Descriptor
.Ptr
= tbuf
;
474 SYS$
ASCTIM (0, &Descriptor
, 0, 0);
477 vms_debug2 ((6, "vmstimestring:'%s'\n", tbuf
));
482 /* Create module name from filename (ie, extract the basename and convert it
483 in upper cases). Works on both VMS and UNIX pathes.
484 The result has to be free(). */
487 vms_get_module_name (const char *filename
, bfd_boolean upcase
)
492 /* Strip VMS path. */
493 fout
= strrchr (filename
, ']');
495 fout
= strchr (filename
, ':');
501 /* Strip UNIX path. */
502 fptr
= strrchr (fout
, '/');
506 fname
= strdup (fout
);
509 fptr
= strrchr (fname
, '.');
513 /* Convert to upper case and truncate at 31 characters.
514 (VMS object file format restricts module name length to 31). */
516 for (fptr
= fname
; *fptr
!= 0; fptr
++)
518 if (*fptr
== ';' || (fptr
- fname
) >= 31)
524 *fptr
= TOUPPER (*fptr
);
529 /* Convert a raw VMS time to a unix time. */
532 vms_time_to_time_t (unsigned int hi
, unsigned int lo
)
534 const unsigned int off
= 3506716800U;
535 const unsigned int factor
= 10000000;
540 /* First convert to seconds. */
544 for (i
= 0; i
< 4; i
++)
546 tmp
= (tmp
<< 8) | (lo
>> 24);
549 rlo
= (rlo
<< 8) | (tmp
/ factor
);
554 /* Return 0 in case of overflow. */
555 if (lo
> off
&& hi
> 1)
561 /* Convert a raw (stored in a buffer) VMS time to a unix time. */
564 vms_rawtime_to_time_t (unsigned char *buf
)
566 unsigned int hi
= bfd_getl32 (buf
+ 4);
567 unsigned int lo
= bfd_getl32 (buf
+ 0);
569 return vms_time_to_time_t (hi
, lo
);