1 /* vms-misc.c -- Miscellaneous functions for VAX (openVMS/VAX) and
2 EVAX (openVMS/Alpha) files.
3 Copyright 1996, 1997, 1998, 1999 Free Software Foundation, Inc.
5 Written by Klaus K"ampf (kkaempf@rmi.de)
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
32 /*-----------------------------------------------------------------------------*/
36 /* debug function for all vms extensions
37 evaluates environment variable VMS_DEBUG for a
38 numerical value on the first call
39 all error levels below this value are printed
42 1 toplevel bfd calls (functions from the bfd vector)
43 2 functions called by bfd calls
47 level is also identation level. Indentation is performed
53 _bfd_vms_debug (int level
, char *format
, ...)
55 static int min_level
= -1;
56 static FILE *output
= NULL
;
59 int abslvl
= (level
> 0)?level
:-level
;
63 if ((eptr
= getenv("VMS_DEBUG")) != NULL
)
65 min_level
= atoi(eptr
);
73 if (abslvl
> min_level
)
77 fprintf (output
, " ");
78 va_start(args
, format
);
79 vfprintf (output
, format
, args
);
86 #else /* not __STDC__ */
89 _bfd_vms_debug (level
, format
, a1
, a2
, a3
, a4
, a5
, a6
)
92 long a1
; long a2
; long a3
;
93 long a4
; long a5
; long a6
;
95 static int min_level
= -1;
96 static FILE *output
= NULL
;
101 if ((eptr
= getenv("VMS_DEBUG")) != NULL
)
103 min_level
= atoi(eptr
);
111 if (level
> min_level
)
115 fprintf (output
, " ");
116 fprintf (output
, format
, a1
, a2
, a3
, a4
, a5
, a6
);
121 #endif /* __STDC__ */
124 hex dump 'size' bytes starting at 'ptr' */
127 _bfd_hexdump (level
, ptr
, size
, offset
)
133 unsigned char *lptr
= ptr
;
140 vms_debug (level
, "%08lx:", start
);
141 vms_debug (-level
, " %02x", *ptr
++);
146 while ((count
%16) != 0)
148 vms_debug (-level
, " ");
154 vms_debug (-level
, " ");
157 vms_debug (-level
, "%c", (*lptr
< 32)?'.':*lptr
);
160 vms_debug (-level
, "\n");
164 vms_debug (-level
, "\n");
173 These are needed when reading an object file. */
175 /* allocate new vms_hash_entry
176 keep the symbol name and a pointer to the bfd symbol in the table */
178 struct bfd_hash_entry
*
179 _bfd_vms_hash_newfunc (entry
, table
, string
)
180 struct bfd_hash_entry
*entry
;
181 struct bfd_hash_table
*table
;
184 vms_symbol_entry
*ret
;
187 vms_debug (5, "_bfd_vms_hash_newfunc(%p, %p, %s)\n", entry
, table
, string
);
190 if (entry
== (struct bfd_hash_entry
*)NULL
)
192 ret
= (vms_symbol_entry
*)
193 bfd_hash_allocate (table
, sizeof (vms_symbol_entry
));
194 if (ret
== (vms_symbol_entry
*) NULL
)
196 bfd_set_error (bfd_error_no_memory
);
197 return (struct bfd_hash_entry
*)NULL
;
199 entry
= (struct bfd_hash_entry
*) ret
;
202 /* Call the allocation method of the base class. */
204 ret
= (vms_symbol_entry
*) bfd_hash_newfunc (entry
, table
, string
);
206 vms_debug (6, "_bfd_vms_hash_newfunc ret %p\n", ret
);
209 ret
->symbol
= (asymbol
*)NULL
;
211 return (struct bfd_hash_entry
*)ret
;
215 /* object file input functions */
217 /* Return type and length from record header (buf) on Alpha. */
220 _bfd_vms_get_header_values (abfd
, buf
, type
, length
)
221 bfd
*abfd ATTRIBUTE_UNUSED
;
227 *type
= bfd_getl16 (buf
);
230 *length
= bfd_getl16 (buf
);
233 vms_debug (10, "_bfd_vms_get_header_values type %x, length %x\n", (type
?*type
:0), (length
?*length
:0));
239 /* Get next record from object file to vms_buf
240 set PRIV(buf_size) and return it
242 this is a little tricky since it should be portable.
244 the openVMS object file has 'variable length' which means that
245 read() returns data in chunks of (hopefully) correct and expected
246 size. The linker (and other tools on vms) depend on that. Unix doesn't
247 know about 'formatted' files, so reading and writing such an object
248 file in a unix environment is not trivial.
250 With the tool 'file' (available on all vms ftp sites), one
251 can view and change the attributes of a file. Changing from
252 'variable length' to 'fixed length, 512 bytes' reveals the
253 record length at the first 2 bytes of every record. The same
254 happens during the transfer of object files from vms to unix,
255 at least with ucx, dec's implementation of tcp/ip.
257 The vms format repeats the length at bytes 2 & 3 of every record.
259 On the first call (file_format == FF_UNKNOWN) we check if
260 the first and the third byte pair (!) of the record match.
261 If they do it's an object file in an unix environment or with
262 wrong attributes (FF_FOREIGN), else we should be in a vms
263 environment where read() returns the record size (FF_NATIVE).
265 reading is always done in 2 steps.
266 first just the record header is read and the length extracted
268 then the read buffer is adjusted and the remaining bytes are
271 all file i/o is always done on even file positions */
274 _bfd_vms_get_record (abfd
)
277 int test_len
, test_start
, remaining
;
278 unsigned char *vms_buf
;
281 vms_debug (8, "_bfd_vms_get_record\n");
284 /* minimum is 6 bytes on Alpha
285 (2 bytes length, 2 bytes record id, 2 bytes length repeated)
287 on VAX there's no length information in the record
288 so start with OBJ_S_C_MAXRECSIZ */
290 if (PRIV(buf_size
) == 0)
294 PRIV(vms_buf
) = (unsigned char *) malloc (OBJ_S_C_MAXRECSIZ
);
295 PRIV(buf_size
) = OBJ_S_C_MAXRECSIZ
;
296 PRIV(file_format
) = FF_VAX
;
299 PRIV(vms_buf
) = (unsigned char *) malloc (6);
302 vms_buf
= PRIV(vms_buf
);
306 bfd_set_error (bfd_error_no_memory
);
310 switch (PRIV(file_format
))
314 test_len
= 6; /* probe 6 bytes */
315 test_start
= 2; /* where the record starts */
330 /* skip odd alignment byte */
332 if (bfd_tell (abfd
) & 1)
334 if (bfd_read (PRIV(vms_buf
), 1, 1, abfd
) != 1)
336 bfd_set_error (bfd_error_file_truncated
);
341 /* read the record header on Alpha. */
344 && (bfd_read (PRIV(vms_buf
), 1, test_len
, abfd
)
345 != (bfd_size_type
) test_len
))
347 bfd_set_error (bfd_error_file_truncated
);
351 /* check file format on first call */
353 if (PRIV(file_format
) == FF_UNKNOWN
)
354 { /* record length repeats ? */
355 if ( (vms_buf
[0] == vms_buf
[4])
356 && (vms_buf
[1] == vms_buf
[5]))
358 PRIV(file_format
) = FF_FOREIGN
; /* Y: foreign environment */
363 PRIV(file_format
) = FF_NATIVE
; /* N: native environment */
370 PRIV(rec_length
) = bfd_read (vms_buf
, 1, PRIV(buf_size
), abfd
);
371 if (PRIV(rec_length
) <= 0)
373 bfd_set_error (bfd_error_file_truncated
);
376 PRIV(vms_rec
) = vms_buf
;
380 /* extract vms record length */
382 _bfd_vms_get_header_values (abfd
, vms_buf
+test_start
, NULL
,
385 if (PRIV(rec_length
) <= 0)
387 bfd_set_error (bfd_error_file_truncated
);
391 /* that's what the linker manual says */
393 if (PRIV(rec_length
) > EOBJ_S_C_MAXRECSIZ
)
395 bfd_set_error (bfd_error_file_truncated
);
399 /* adjust the buffer */
401 if (PRIV(rec_length
) > PRIV(buf_size
))
403 PRIV(vms_buf
) = (unsigned char *) realloc (vms_buf
, PRIV(rec_length
));
404 vms_buf
= PRIV(vms_buf
);
407 bfd_set_error (bfd_error_no_memory
);
410 PRIV(buf_size
) = PRIV(rec_length
);
413 /* read the remaining record */
415 remaining
= PRIV(rec_length
) - test_len
+ test_start
;
418 vms_debug (10, "bfd_read remaining %d\n", remaining
);
420 if (bfd_read (vms_buf
+ test_len
, 1, remaining
, abfd
) !=
421 (bfd_size_type
) remaining
)
423 bfd_set_error (bfd_error_file_truncated
);
426 PRIV(vms_rec
) = vms_buf
+ test_start
;
430 vms_debug (11, "bfd_read rec_length %d\n", PRIV(rec_length
));
433 return PRIV(rec_length
);
436 /* get next vms record from file
437 update vms_rec and rec_length to new (remaining) values */
440 _bfd_vms_next_record (abfd
)
444 vms_debug (8, "_bfd_vms_next_record (len %d, size %d)\n",
445 PRIV(rec_length
), PRIV(rec_size
));
448 if (PRIV(rec_length
) > 0)
450 PRIV(vms_rec
) += PRIV(rec_size
);
454 if (_bfd_vms_get_record (abfd
) <= 0)
463 PRIV(rec_type
) = *(PRIV(vms_rec
));
464 PRIV(rec_size
) = PRIV(rec_length
);
468 _bfd_vms_get_header_values (abfd
, PRIV(vms_rec
), &PRIV(rec_type
),
471 PRIV(rec_length
) -= PRIV(rec_size
);
474 vms_debug (8, "_bfd_vms_next_record: rec %p, size %d, length %d, type %d\n",
475 PRIV(vms_rec
), PRIV(rec_size
), PRIV(rec_length
),
479 return PRIV(rec_type
);
483 /* Copy sized string (string with fixed length) to new allocated area
484 size is string length (size of record) */
487 _bfd_vms_save_sized_string (str
, size
)
491 char *newstr
= bfd_malloc (size
+ 1);
495 strncpy (newstr
, (char *)str
, size
);
501 /* Copy counted string (string with length at first byte) to new allocated area
502 ptr points to length byte on entry */
505 _bfd_vms_save_counted_string (ptr
)
510 return _bfd_vms_save_sized_string (ptr
, len
);
514 /* stack routines for vms ETIR commands */
516 /* Push value and section index */
519 _bfd_vms_push (abfd
, val
, psect
)
524 static int last_psect
;
527 vms_debug (4, "<push %016lx(%d) at %d>\n", val
, psect
, PRIV(stackptr
));
533 PRIV(stack
[PRIV(stackptr
)]).value
= val
;
534 PRIV(stack
[PRIV(stackptr
)]).psect
= last_psect
;
536 if (PRIV(stackptr
) >= STACKSIZE
)
538 bfd_set_error (bfd_error_bad_value
);
539 (*_bfd_error_handler
) (_("Stack overflow (%d) in _bfd_vms_push"), PRIV(stackptr
));
545 /* Pop value and section index */
548 _bfd_vms_pop (abfd
, psect
)
554 if (PRIV(stackptr
) == 0)
556 bfd_set_error (bfd_error_bad_value
);
557 (*_bfd_error_handler
) (_("Stack underflow in _bfd_vms_pop"));
561 value
= PRIV(stack
[PRIV(stackptr
)]).value
;
562 if ((psect
!= NULL
) && (PRIV(stack
[PRIV(stackptr
)]).psect
>= 0))
563 *psect
= PRIV(stack
[PRIV(stackptr
)]).psect
;
566 vms_debug (4, "<pop %016lx(%d)>\n", value
, PRIV(stack
[PRIV(stackptr
)]).psect
);
573 /* object file output functions */
575 /* GAS tends to write sections in little chunks (bfd_set_section_contents)
576 which we can't use directly. So we save the little chunks in linked
577 lists (one per section) and write them later. */
579 /* Add a new vms_section structure to vms_section_table
580 - forward chaining - */
583 add_new_contents (abfd
, section
)
587 vms_section
*sptr
, *newptr
;
589 sptr
= PRIV(vms_section_table
)[section
->index
];
593 newptr
= (vms_section
*) bfd_malloc (sizeof (vms_section
));
594 if (newptr
== (vms_section
*) NULL
)
596 newptr
->contents
= (unsigned char *) bfd_alloc (abfd
, (int)section
->_raw_size
);
597 if (newptr
->contents
== (unsigned char *)NULL
)
600 newptr
->size
= section
->_raw_size
;
602 PRIV(vms_section_table
)[section
->index
] = newptr
;
606 /* Save section data & offset to an vms_section structure
607 vms_section_table[] holds the vms_section chain */
610 _bfd_save_vms_section (abfd
, section
, data
, offset
, count
)
619 if (section
->index
>= VMS_SECTION_COUNT
)
621 bfd_set_error (bfd_error_nonrepresentable_section
);
624 if (count
== (bfd_size_type
)0)
626 sptr
= add_new_contents (abfd
, section
);
629 memcpy (sptr
->contents
+ offset
, data
, (size_t) count
);
634 /* Get vms_section pointer to saved contents for section # index */
637 _bfd_get_vms_section (abfd
, index
)
641 if (index
>= VMS_SECTION_COUNT
)
643 bfd_set_error (bfd_error_nonrepresentable_section
);
646 return PRIV(vms_section_table
)[index
];
650 /* Object output routines */
652 /* Begin new record or record header
653 write 2 bytes rectype
654 write 2 bytes record length (filled in at flush)
655 write 2 bytes header type (ommitted if rechead == -1) */
658 _bfd_vms_output_begin (abfd
, rectype
, rechead
)
664 vms_debug (6, "_bfd_vms_output_begin(type %d, head %d)\n", rectype
,
668 _bfd_vms_output_short (abfd
,rectype
);
670 /* save current output position to fill in lenght later */
672 if (PRIV(push_level
) > 0)
673 PRIV(length_pos
) = PRIV(output_size
);
676 vms_debug (6, "_bfd_vms_output_begin: length_pos = %d\n",
680 _bfd_vms_output_short (abfd
,0); /* placeholder for length */
683 _bfd_vms_output_short (abfd
,rechead
);
688 /* Set record/subrecord alignment */
691 _bfd_vms_output_alignment (abfd
, alignto
)
696 vms_debug (6, "_bfd_vms_output_alignment(%d)\n", alignto
);
699 PRIV(output_alignment
) = alignto
;
703 /* Prepare for subrecord fields */
706 _bfd_vms_output_push (abfd
)
710 vms_debug (6, "vms_output_push(pushed_size = %d)\n", PRIV(output_size
));
714 PRIV(pushed_size
) = PRIV(output_size
);
718 /* End of subrecord fields */
721 _bfd_vms_output_pop (abfd
)
725 vms_debug (6, "vms_output_pop(pushed_size = %d)\n", PRIV(pushed_size
));
728 _bfd_vms_output_flush (abfd
);
729 PRIV(length_pos
) = 2;
732 vms_debug (6, "vms_output_pop: length_pos = %d\n", PRIV(length_pos
));
735 PRIV(pushed_size
) = 0;
740 /* Flush unwritten output, ends current record */
743 _bfd_vms_output_flush (abfd
)
746 int real_size
= PRIV(output_size
);
751 vms_debug (6, "_bfd_vms_output_flush(real_size = %d, pushed_size %d at lenpos %d)\n",
752 real_size
, PRIV(pushed_size
), PRIV(length_pos
));
755 if (PRIV(push_level
) > 0)
756 length
= real_size
- PRIV(pushed_size
);
762 aligncount
= (PRIV(output_alignment
)
763 - (length
% PRIV(output_alignment
))) % PRIV(output_alignment
);
766 vms_debug (6, "align: adding %d bytes\n", aligncount
);
769 while (aligncount
-- > 0)
771 PRIV(output_buf
)[real_size
++] = 0;
773 /* this is why I *love* vms: inconsistency :-}
774 alignment is added to the subrecord length
775 but not to the record length */
776 if (PRIV(push_level
) > 0)
781 /* put length to buffer */
782 PRIV(output_size
) = PRIV(length_pos
);
783 _bfd_vms_output_short (abfd
, (unsigned int)length
);
785 if (PRIV(push_level
) == 0)
788 /* write length first, see FF_FOREIGN in the input routines */
789 fwrite (PRIV(output_buf
)+2, 2, 1, (FILE *)abfd
->iostream
);
791 fwrite (PRIV(output_buf
), real_size
, 1, (FILE *)abfd
->iostream
);
793 PRIV(output_size
) = 0;
797 PRIV(output_size
) = real_size
;
798 PRIV(pushed_size
) = PRIV(output_size
);
804 /* End record output */
807 _bfd_vms_output_end (abfd
)
811 vms_debug (6, "_bfd_vms_output_end\n");
814 _bfd_vms_output_flush (abfd
);
819 /* check remaining buffer size
821 return what's left. */
824 _bfd_vms_output_check (abfd
, size
)
829 vms_debug (6, "_bfd_vms_output_check(%d)\n", size
);
832 return (MAX_OUTREC_SIZE
- (PRIV(output_size
) + size
+ MIN_OUTREC_LUFT
));
835 /* Output byte (8 bit) value */
838 _bfd_vms_output_byte (abfd
, value
)
843 vms_debug (6, "_bfd_vms_output_byte(%02x)\n", value
);
846 bfd_put_8 (abfd
, value
& 0xff, PRIV(output_buf
) + PRIV(output_size
));
847 PRIV(output_size
) += 1;
851 /* Output short (16 bit) value */
854 _bfd_vms_output_short (abfd
, value
)
859 vms_debug (6, "_bfd_vms_output_short (%04x)\n", value
);
862 bfd_put_16 (abfd
, value
& 0xffff, PRIV(output_buf
) + PRIV(output_size
));
863 PRIV(output_size
) += 2;
867 /* Output long (32 bit) value */
870 _bfd_vms_output_long (abfd
, value
)
875 vms_debug (6, "_bfd_vms_output_long (%08lx)\n", value
);
878 bfd_put_32 (abfd
, value
, PRIV(output_buf
) + PRIV(output_size
));
879 PRIV(output_size
) += 4;
883 /* Output quad (64 bit) value */
886 _bfd_vms_output_quad (abfd
, value
)
891 vms_debug (6, "_bfd_vms_output_quad(%016lx)\n", value
);
894 bfd_put_64(abfd
, value
, PRIV(output_buf
) + PRIV(output_size
));
895 PRIV(output_size
) += 8;
899 /* Output c-string as counted string */
902 _bfd_vms_output_counted (abfd
, value
)
909 vms_debug (6, "_bfd_vms_output_counted(%s)\n", value
);
912 len
= strlen (value
);
915 (*_bfd_error_handler
) (_("_bfd_vms_output_counted called with zero bytes"));
920 (*_bfd_error_handler
) (_("_bfd_vms_output_counted called with too many bytes"));
923 _bfd_vms_output_byte (abfd
, len
& 0xff);
924 _bfd_vms_output_dump (abfd
, (unsigned char *)value
, len
);
927 /* Output character area */
930 _bfd_vms_output_dump (abfd
, data
, length
)
936 vms_debug (6, "_bfd_vms_output_dump(%d)\n", length
);
942 memcpy (PRIV(output_buf
) + PRIV(output_size
), data
, length
);
943 PRIV(output_size
) += length
;
948 /* Output count bytes of value */
951 _bfd_vms_output_fill (abfd
, value
, count
)
957 vms_debug (6, "_bfd_vms_output_fill(val %02x times %d)\n", value
, count
);
962 memset (PRIV(output_buf
) + PRIV(output_size
), value
, count
);
963 PRIV(output_size
) += count
;
968 /* this hash routine borrowed from GNU-EMACS, and strengthened slightly ERY*/
974 register const unsigned char *p
= (unsigned char *) ptr
;
975 register const unsigned char *end
= p
+ strlen (ptr
);
976 register unsigned char c
;
977 register int hash
= 0;
982 hash
= ((hash
<< 3) + (hash
<< 15) + (hash
>> 28) + c
);
987 /* Generate a length-hashed VMS symbol name (limited to maxlen chars). */
990 _bfd_vms_length_hash_symbol (abfd
, in
, maxlen
)
998 const char *old_name
;
1000 static char outbuf
[EOBJ_S_C_SYMSIZ
+1];
1004 vms_debug(4, "_bfd_vms_length_hash_symbol \"%s\"\n", in
);
1007 if (maxlen
> EOBJ_S_C_SYMSIZ
)
1008 maxlen
= EOBJ_S_C_SYMSIZ
;
1010 new_name
= out
; /* save this for later. */
1012 /* We may need to truncate the symbol, save the hash for later. */
1014 in_len
= strlen (in
);
1016 result
= (in_len
> maxlen
) ? hash_string (in
) : 0;
1020 /* Do the length checking. */
1022 if (in_len
<= maxlen
)
1028 if (PRIV(flag_hash_long_names
))
1034 strncpy (out
, in
, i
);
1038 if ((in_len
> maxlen
)
1039 && PRIV(flag_hash_long_names
))
1040 sprintf (out
, "_%08lx", result
);
1045 vms_debug(4, "--> [%d]\"%s\"\n", strlen (outbuf
), outbuf
);
1049 && PRIV(flag_hash_long_names
)
1050 && PRIV(flag_show_after_trunc
))
1051 printf (_("Symbol %s replaced by %s\n"), old_name
, new_name
);
1056 /* Allocate and initialize a new symbol. */
1059 new_symbol (abfd
, name
)
1066 _bfd_vms_debug (7, "new_symbol %s\n", name
);
1069 symbol
= _bfd_vms_make_empty_symbol (abfd
);
1072 symbol
->name
= name
;
1073 symbol
->section
= bfd_make_section (abfd
, BFD_UND_SECTION_NAME
);
1078 /* Allocate and enter a new private symbol. */
1081 _bfd_vms_enter_symbol (abfd
, name
)
1085 vms_symbol_entry
*entry
;
1088 _bfd_vms_debug (6, "_bfd_vms_enter_symbol %s\n", name
);
1091 entry
= (vms_symbol_entry
*)
1092 bfd_hash_lookup (PRIV(vms_symbol_table
), name
, false, false);
1096 _bfd_vms_debug (8, "creating hash entry for %s\n", name
);
1098 entry
= (vms_symbol_entry
*)bfd_hash_lookup (PRIV(vms_symbol_table
), name
, true, false);
1102 symbol
= new_symbol (abfd
, name
);
1105 entry
->symbol
= symbol
;
1106 PRIV(gsd_sym_count
)++;
1113 (*_bfd_error_handler
) (_("failed to enter %s"), name
);
1118 _bfd_vms_debug (8, "found hash entry for %s\n", name
);
1123 _bfd_vms_debug (7, "-> entry %p, entry->symbol %p\n", entry
, entry
->symbol
);