aboutsummaryrefslogtreecommitdiff
path: root/bfd/vms-misc.c
blob: 47e598559b181c763930feee88e53f951fc4f414 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
/* vms-misc.c -- BFD back-end for VMS/VAX (openVMS/VAX) and
   EVAX (openVMS/Alpha) files.
   Copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
   2007, 2008, 2009  Free Software Foundation, Inc.

   Miscellaneous functions.

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

   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 3 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., 51 Franklin Street - Fifth Floor, Boston,
   MA 02110-1301, USA.  */

#if __STDC__
#include <stdarg.h>
#endif

#include "sysdep.h"
#include "bfd.h"
#include "bfdlink.h"
#include "libbfd.h"

#include "vms.h"

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

static int hash_string PARAMS ((const char *));
static asymbol *new_symbol PARAMS ((bfd *, char *));
static void maybe_adjust_record_pointer_for_object PARAMS ((bfd *));
static int vms_get_remaining_object_record PARAMS ((bfd *, int ));
static int vms_get_remaining_image_record PARAMS ((bfd *, int ));

#if VMS_DEBUG
/* Debug functions.  */

/* Debug function for all vms extensions evaluates environment
   variable VMS_DEBUG for a numerical value on the first call all
   error levels below this value are printed:

   Levels:
   1	toplevel bfd calls (functions from the bfd vector)
   2	functions called by bfd calls
   ...
   9	almost everything

   Level is also indentation level. Indentation is performed
   if level > 0.  */

void
_bfd_vms_debug (int level, char *format, ...)
{
  static int min_level = -1;
  static FILE *output = NULL;
  char *eptr;
  va_list args;
  int abslvl = (level > 0) ? level : - level;

  if (min_level == -1)
    {
      if ((eptr = getenv ("VMS_DEBUG")) != NULL)
	{
	  min_level = atoi (eptr);
	  output = stderr;
	}
      else
	min_level = 0;
    }
  if (output == NULL)
    return;
  if (abslvl > min_level)
    return;

  while (--level>0)
    fprintf (output, " ");
  va_start (args, format);
  vfprintf (output, format, args);
  fflush (output);
  va_end (args);
}

/* A debug function
   hex dump 'size' bytes starting at 'ptr'.  */

void
_bfd_hexdump (int level,
	      unsigned char *ptr,
	      int size,
	      int offset)
{
  unsigned char *lptr = ptr;
  int count = 0;
  long start = offset;

  while (size-- > 0)
    {
      if ((count%16) == 0)
	vms_debug (level, "%08lx:", start);
      vms_debug (-level, " %02x", *ptr++);
      count++;
      start++;
      if (size == 0)
	{
	  while ((count%16) != 0)
	    {
	      vms_debug (-level, "   ");
	      count++;
	    }
	}
      if ((count%16) == 0)
	{
	  vms_debug (-level, " ");
	  while (lptr < ptr)
	    {
	      vms_debug (-level, "%c", (*lptr < 32)?'.':*lptr);
	      lptr++;
	    }
	  vms_debug (-level, "\n");
	}
    }
  if ((count%16) != 0)
    vms_debug (-level, "\n");
}
#endif

/* Hash functions

   These are needed when reading an object file.  */

/* Allocate new vms_hash_entry
   keep the symbol name and a pointer to the bfd symbol in the table.  */

struct bfd_hash_entry *
_bfd_vms_hash_newfunc (struct bfd_hash_entry *entry,
		       struct bfd_hash_table *table,
		       const char *string)
{
  vms_symbol_entry *ret;

#if VMS_DEBUG
  vms_debug (5, "_bfd_vms_hash_newfunc (%p, %p, %s)\n", entry, table, string);
#endif

  if (entry == NULL)
    {
      ret = (vms_symbol_entry *)
	      bfd_hash_allocate (table, sizeof (vms_symbol_entry));
      if (ret ==  NULL)
	{
	  bfd_set_error (bfd_error_no_memory);
	  return NULL;
	}
      entry = (struct bfd_hash_entry *) ret;
    }

  /* Call the allocation method of the base class.  */
  ret = (vms_symbol_entry *) bfd_hash_newfunc (entry, table, string);
#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_hash_newfunc ret %p\n", ret);
#endif

  ret->symbol = NULL;

  return (struct bfd_hash_entry *)ret;
}

/* Object file input functions.  */

/* Return type and size from record header (buf) on Alpha.  */

void
_bfd_vms_get_header_values (bfd * abfd ATTRIBUTE_UNUSED,
			    unsigned char *buf,
			    int *type,
			    int *size)
{
  if (type)
    *type = bfd_getl16 (buf);

  if (size)
    *size = bfd_getl16 (buf+2);

#if VMS_DEBUG
  vms_debug (10, "_bfd_vms_get_header_values type %x, size %x\n",
	     type ? *type : 0, size ? *size : 0);
#endif
}

/* Get next record from object file to vms_buf.
   Set PRIV(buf_size) and return it

   This is a little tricky since it should be portable.

   The openVMS object file has 'variable length' which means that
   read() returns data in chunks of (hopefully) correct and expected
   size.  The linker (and other tools on VMS) depend on that. Unix
   doesn't know about 'formatted' files, so reading and writing such
   an object file in a Unix environment is not trivial.

   With the tool 'file' (available on all VMS FTP sites), one
   can view and change the attributes of a file.  Changing from
   'variable length' to 'fixed length, 512 bytes' reveals the
   record size at the first 2 bytes of every record.  The same
   may happen during the transfer of object files from VMS to Unix,
   at least with UCX, the DEC implementation of TCP/IP.

   The VMS format repeats the size at bytes 2 & 3 of every record.

   On the first call (file_format == FF_UNKNOWN) we check if
   the first and the third byte pair (!) of the record match.
   If they do it's an object file in an Unix environment or with
   wrong attributes (FF_FOREIGN), else we should be in a VMS
   environment where read() returns the record size (FF_NATIVE).

   Reading is always done in 2 steps:
    1. first just the record header is read and the size extracted,
    2. then the read buffer is adjusted and the remaining bytes are
       read in.

   All file I/O is done on even file positions.  */

#define VMS_OBJECT_ADJUSTMENT  2

static void
maybe_adjust_record_pointer_for_object (bfd *abfd)
{
  /* Set the file format once for all on the first invocation.  */
  if (PRIV (file_format) == FF_UNKNOWN)
    {
      if (PRIV (vms_rec)[0] == PRIV (vms_rec)[4]
	  && PRIV (vms_rec)[1] == PRIV (vms_rec)[5])
	PRIV (file_format) = FF_FOREIGN;
      else
	PRIV (file_format) = FF_NATIVE;
    }

  /* The adjustment is needed only in an Unix environment.  */
  if (PRIV (file_format) == FF_FOREIGN)
    PRIV (vms_rec) += VMS_OBJECT_ADJUSTMENT;
}

/* Get first record from file and return the file type.  */

int
_bfd_vms_get_first_record (bfd *abfd)
{
  unsigned int test_len;

#if VMS_DEBUG
  vms_debug (8, "_bfd_vms_get_first_record\n");
#endif

  if (PRIV (is_vax))
    test_len = 0;
  else
    /* Minimum is 6 bytes for objects (2 bytes size, 2 bytes record id,
       2 bytes size repeated) and 12 bytes for images (4 bytes major id,
       4 bytes minor id, 4 bytes length).  */
    test_len = 12;

  /* Size the main buffer.  */
  if (PRIV (buf_size) == 0)
    {
      /* On VAX there's no size information in the record, so
	 start with OBJ_S_C_MAXRECSIZ.  */
      bfd_size_type amt = (test_len ? test_len : OBJ_S_C_MAXRECSIZ);
      PRIV (vms_buf) = (unsigned char *) bfd_malloc (amt);
      PRIV (buf_size) = amt;
    }

  /* Initialize the record pointer.  */
  PRIV (vms_rec) = PRIV (vms_buf);

  /* We only support modules on VAX.  */
  if (PRIV (is_vax))
    {
      if (vms_get_remaining_object_record (abfd, test_len) <= 0)
	return FT_UNKNOWN;

#if VMS_DEBUG
      vms_debug (2, "file type is VAX module\n");
#endif

      return FT_MODULE;
    }

  if (bfd_bread (PRIV (vms_buf), test_len, abfd) != test_len)
    {
      bfd_set_error (bfd_error_file_truncated);
      return FT_UNKNOWN;
    }

  /* Is it an image?  */
  if ((bfd_getl32 (PRIV (vms_rec)) == EIHD_S_K_MAJORID)
      && (bfd_getl32 (PRIV (vms_rec) + 4) == EIHD_S_K_MINORID))
    {
      if (vms_get_remaining_image_record (abfd, test_len) <= 0)
	return FT_UNKNOWN;

#if VMS_DEBUG
      vms_debug (2, "file type is image\n");
#endif

      return FT_IMAGE;
    }

  /* Assume it's a module and adjust record pointer if necessary.  */
  maybe_adjust_record_pointer_for_object (abfd);

  /* But is it really a module?  */
  if (bfd_getl16 (PRIV (vms_rec)) <= EOBJ_S_C_MAXRECTYP
      && bfd_getl16 (PRIV (vms_rec) + 2) <= EOBJ_S_C_MAXRECSIZ)
    {
      if (vms_get_remaining_object_record (abfd, test_len) <= 0)
	return FT_UNKNOWN;

#if VMS_DEBUG
      vms_debug (2, "file type is module\n");
#endif

      return FT_MODULE;
    }

#if VMS_DEBUG
  vms_debug (2, "file type is unknown\n");
#endif

  return FT_UNKNOWN;
}

/* Implement step #1 of the object record reading procedure.
   Return the record type or -1 on failure.  */

int
_bfd_vms_get_object_record (bfd *abfd)
{
  unsigned int test_len;
  int type;

#if VMS_DEBUG
  vms_debug (8, "_bfd_vms_get_obj_record\n");
#endif

  if (PRIV (is_vax))
    test_len = 0;
  else
    {
      int off = 0;

      /* See _bfd_vms_get_first_record.  */
      test_len = 6;

      /* Skip odd alignment byte.  */
      if (bfd_tell (abfd) & 1)
	{
	  if (bfd_bread (PRIV (vms_buf), 1, abfd) != 1)
	    {
	      bfd_set_error (bfd_error_file_truncated);
	      return -1;
	    }
          /* Alignment byte may be present or not.  This is not easy to
             detect but all object record types are not 0 (on Alpha VMS).
             We also hope that pad byte is 0.  */
          if (PRIV (vms_buf)[0])
            off = 1;
	}

      /* Read the record header  */
      if (bfd_bread (PRIV (vms_buf) + off, test_len - off, abfd)
          != test_len - off)
	{
	  bfd_set_error (bfd_error_file_truncated);
	  return -1;
	}

      /* Reset the record pointer.  */
      PRIV (vms_rec) = PRIV (vms_buf);
      maybe_adjust_record_pointer_for_object (abfd);
    }

  if (vms_get_remaining_object_record (abfd, test_len) <= 0)
    return -1;

  if (PRIV (is_vax))
    type = PRIV (vms_rec) [0];
  else
    type = bfd_getl16 (PRIV (vms_rec));

#if VMS_DEBUG
  vms_debug (8, "_bfd_vms_get_obj_record: rec %p, size %d, type %d\n",
	      PRIV (vms_rec), PRIV (rec_size), type);
#endif

  return type;
}

/* Implement step #2 of the object record reading procedure.
   Return the size of the record or 0 on failure.  */

static int
vms_get_remaining_object_record (bfd *abfd, int read_so_far)
{
#if VMS_DEBUG
  vms_debug (8, "vms_get_remaining_obj_record\n");
#endif

  if (PRIV (is_vax))
    {
      if (read_so_far != 0)
        abort ();

      PRIV (rec_size) = bfd_bread (PRIV (vms_buf), PRIV (buf_size), abfd);

      if (PRIV (rec_size) <= 0)
	{
	  bfd_set_error (bfd_error_file_truncated);
	  return 0;
	}

      /* Reset the record pointer.  */
      PRIV (vms_rec) = PRIV (vms_buf);
    }
  else
    {
      unsigned int to_read;

      /* Extract record size.  */
      PRIV (rec_size) = bfd_getl16 (PRIV (vms_rec) + 2);

      if (PRIV (rec_size) <= 0)
	{
	  bfd_set_error (bfd_error_file_truncated);
	  return 0;
	}

      /* That's what the linker manual says.  */
      if (PRIV (rec_size) > EOBJ_S_C_MAXRECSIZ)
	{
	  bfd_set_error (bfd_error_file_truncated);
	  return 0;
	}

      /* Take into account object adjustment.  */
      to_read = PRIV (rec_size);
      if (PRIV (file_format) == FF_FOREIGN)
	to_read += VMS_OBJECT_ADJUSTMENT;

      /* Adjust the buffer.  */
      if (to_read > PRIV (buf_size))
	{
	  PRIV (vms_buf)
	    = (unsigned char *) bfd_realloc (PRIV (vms_buf), to_read);
	  if (PRIV (vms_buf) == NULL)
	    return 0;
	  PRIV (buf_size) = to_read;
	}

      /* Read the remaining record.  */
      to_read -= read_so_far;

#if VMS_DEBUG
      vms_debug (8, "vms_get_remaining_obj_record: to_read %d\n", to_read);
#endif

      if (bfd_bread (PRIV (vms_buf) + read_so_far, to_read, abfd) != to_read)
	{
	  bfd_set_error (bfd_error_file_truncated);
	  return 0;
	}

      /* Reset the record pointer.  */
      PRIV (vms_rec) = PRIV (vms_buf);
      maybe_adjust_record_pointer_for_object (abfd);
    }

#if VMS_DEBUG
  vms_debug (8, "vms_get_remaining_obj_record: size %d\n", PRIV (rec_size));
#endif

  return PRIV (rec_size);
}

/* Implement step #2 of the record reading procedure for images.
   Return the size of the record or 0 on failure.  */

static int
vms_get_remaining_image_record (bfd *abfd, int read_so_far)
{
  unsigned int to_read;
  int remaining;

  /* Extract record size.  */
  PRIV (rec_size) = bfd_getl32 (PRIV (vms_rec) + EIHD_S_L_SIZE);

  if (PRIV (rec_size) > PRIV (buf_size))
    {
      PRIV (vms_buf) = bfd_realloc (PRIV (vms_buf), PRIV (rec_size));

      if (PRIV (vms_buf) == NULL)
	{
	  bfd_set_error (bfd_error_no_memory);
	  return 0;
	}

      PRIV (buf_size) = PRIV (rec_size);
    }

  /* Read the remaining record.  */
  remaining = PRIV (rec_size) - read_so_far;
  to_read = MIN (VMS_BLOCK_SIZE - read_so_far, remaining);

  while (remaining > 0)
    {
      if (bfd_bread (PRIV (vms_buf) + read_so_far, to_read, abfd) != to_read)
	{
	  bfd_set_error (bfd_error_file_truncated);
	  return 0;
	}

      read_so_far += to_read;
      remaining -= to_read;

      /* Eat trailing 0xff's.  */
      if (remaining > 0)
	while (PRIV (vms_buf) [read_so_far - 1] == 0xff)
	  read_so_far--;

      to_read = MIN (VMS_BLOCK_SIZE, remaining);
    }

  /* Reset the record pointer.  */
  PRIV (vms_rec) = PRIV (vms_buf);

  return PRIV (rec_size);
}

/* Copy sized string (string with fixed size) to new allocated area
   size is string size (size of record)  */

char *
_bfd_vms_save_sized_string (unsigned char *str, int size)
{
  char *newstr = bfd_malloc ((bfd_size_type) size + 1);

  if (newstr == NULL)
    return NULL;
  strncpy (newstr, (char *) str, (size_t) size);
  newstr[size] = 0;

  return newstr;
}

/* Copy counted string (string with size at first byte) to new allocated area
   ptr points to size byte on entry  */

char *
_bfd_vms_save_counted_string (unsigned char *ptr)
{
  int len = *ptr++;

  return _bfd_vms_save_sized_string (ptr, len);
}

/* Stack routines for vms ETIR commands.  */

/* Push value and section index.  */

void
_bfd_vms_push (bfd * abfd, uquad val, int psect)
{
  static int last_psect;

#if VMS_DEBUG
  vms_debug (4, "<push %016lx (%d) at %d>\n", val, psect, PRIV (stackptr));
#endif

  if (psect >= 0)
    last_psect = psect;

  PRIV (stack[PRIV (stackptr)]).value = val;
  PRIV (stack[PRIV (stackptr)]).psect = last_psect;
  PRIV (stackptr)++;
  if (PRIV (stackptr) >= STACKSIZE)
    {
      bfd_set_error (bfd_error_bad_value);
      (*_bfd_error_handler) (_("Stack overflow (%d) in _bfd_vms_push"), PRIV (stackptr));
      exit (1);
    }
}

/* Pop value and section index.  */

uquad
_bfd_vms_pop (bfd * abfd, int *psect)
{
  uquad value;

  if (PRIV (stackptr) == 0)
    {
      bfd_set_error (bfd_error_bad_value);
      (*_bfd_error_handler) (_("Stack underflow in _bfd_vms_pop"));
      exit (1);
    }
  PRIV (stackptr)--;
  value = PRIV (stack[PRIV (stackptr)]).value;
  if ((psect != NULL) && (PRIV (stack[PRIV (stackptr)]).psect >= 0))
    *psect = PRIV (stack[PRIV (stackptr)]).psect;

#if VMS_DEBUG
  vms_debug (4, "<pop %016lx(%d)>\n", value, PRIV (stack[PRIV (stackptr)]).psect);
#endif

  return value;
}

/* Object output routines.   */

/* Begin new record or record header
   write 2 bytes rectype
   write 2 bytes record length (filled in at flush)
   write 2 bytes header type (ommitted if rechead == -1).  */

void
_bfd_vms_output_begin (bfd * abfd, int rectype, int rechead)
{
#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_begin (type %d, head %d)\n", rectype,
	      rechead);
#endif

  _bfd_vms_output_short (abfd, (unsigned int) rectype);

  /* Save current output position to fill in length later.   */

  if (PRIV (push_level) > 0)
    PRIV (length_pos) = PRIV (output_size);

#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_begin: length_pos = %d\n",
	      PRIV (length_pos));
#endif

  /* Placeholder for length.  */
  _bfd_vms_output_short (abfd, 0);

  if (rechead != -1)
    _bfd_vms_output_short (abfd, (unsigned int) rechead);
}

/* Set record/subrecord alignment.   */

void
_bfd_vms_output_alignment (bfd * abfd, int alignto)
{
#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_alignment (%d)\n", alignto);
#endif

  PRIV (output_alignment) = alignto;
}

/* Prepare for subrecord fields.  */

void
_bfd_vms_output_push (bfd * abfd)
{
#if VMS_DEBUG
  vms_debug (6, "vms_output_push (pushed_size = %d)\n", PRIV (output_size));
#endif

  PRIV (push_level)++;
  PRIV (pushed_size) = PRIV (output_size);
}

/* End of subrecord fields.   */

void
_bfd_vms_output_pop (bfd * abfd)
{
#if VMS_DEBUG
  vms_debug (6, "vms_output_pop (pushed_size = %d)\n", PRIV (pushed_size));
#endif

  _bfd_vms_output_flush (abfd);
  PRIV (length_pos) = 2;

#if VMS_DEBUG
  vms_debug (6, "vms_output_pop: length_pos = %d\n", PRIV (length_pos));
#endif

  PRIV (pushed_size) = 0;
  PRIV (push_level)--;
}

/* Flush unwritten output, ends current record.  */

void
_bfd_vms_output_flush (bfd * abfd)
{
  int real_size = PRIV (output_size);
  int aligncount;
  int length;

#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_flush (real_size = %d, pushed_size %d at lenpos %d)\n",
	      real_size, PRIV (pushed_size), PRIV (length_pos));
#endif

  if (PRIV (push_level) > 0)
    length = real_size - PRIV (pushed_size);
  else
    length = real_size;

  if (length == 0)
    return;
  aligncount = (PRIV (output_alignment)
		- (length % PRIV (output_alignment))) % PRIV (output_alignment);

#if VMS_DEBUG
  vms_debug (6, "align: adding %d bytes\n", aligncount);
#endif

  while (aligncount-- > 0)
    {
      PRIV (output_buf)[real_size++] = 0;
      length++;
    }

  /* Put length to buffer.  */
  PRIV (output_size) = PRIV (length_pos);
  _bfd_vms_output_short (abfd, (unsigned int) length);

  if (PRIV (push_level) == 0)
    {
      /* File is open in undefined (UDF) format on VMS, but ultimately will be
	 converted to variable length (VAR) format.  VAR format has a length
	 word first which must be explicitly output in UDF format.  */
      bfd_bwrite (PRIV (output_buf) + 2, 2, abfd);
      bfd_bwrite (PRIV (output_buf), (size_t) real_size, abfd);
      PRIV (output_size) = 0;
    }
  else
    {
      PRIV (output_size) = real_size;
      PRIV (pushed_size) = PRIV (output_size);
    }
}

/* End record output.   */

void
_bfd_vms_output_end (bfd * abfd)
{
#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_end\n");
#endif

  _bfd_vms_output_flush (abfd);
}

/* Check remaining buffer size

   Return what's left.  */

int
_bfd_vms_output_check (bfd * abfd, int size)
{
#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_check (%d)\n", size);
#endif

  return (MAX_OUTREC_SIZE - (PRIV (output_size) + size + MIN_OUTREC_LUFT));
}

/* Output byte (8 bit) value.  */

void
_bfd_vms_output_byte (bfd * abfd, unsigned int value)
{
#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_byte (%02x)\n", value);
#endif

  bfd_put_8 (abfd, value & 0xff, PRIV (output_buf) + PRIV (output_size));
  PRIV (output_size) += 1;
}

/* Output short (16 bit) value.  */

void
_bfd_vms_output_short (bfd * abfd, unsigned int value)
{
#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_short (%04x)\n", value);
#endif

  bfd_put_16 (abfd, (bfd_vma) value & 0xffff,
	      PRIV (output_buf) + PRIV (output_size));
  PRIV (output_size) += 2;
}

/* Output long (32 bit) value.  */

void
_bfd_vms_output_long (bfd * abfd, unsigned long value)
{
#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_long (%08lx)\n", value);
#endif

  bfd_put_32 (abfd, (bfd_vma) value, PRIV (output_buf) + PRIV (output_size));
  PRIV (output_size) += 4;
}

/* Output quad (64 bit) value.  */

void
_bfd_vms_output_quad (bfd * abfd, uquad value)
{
#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_quad (%016lx)\n", value);
#endif

  bfd_put_64(abfd, value, PRIV (output_buf) + PRIV (output_size));
  PRIV (output_size) += 8;
}

/* Output c-string as counted string.  */

void
_bfd_vms_output_counted (bfd * abfd, char *value)
{
  int len;

#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_counted (%s)\n", value);
#endif

  len = strlen (value);
  if (len == 0)
    {
      (*_bfd_error_handler) (_("_bfd_vms_output_counted called with zero bytes"));
      return;
    }
  if (len > 255)
    {
      (*_bfd_error_handler) (_("_bfd_vms_output_counted called with too many bytes"));
      return;
    }
  _bfd_vms_output_byte (abfd, (unsigned int) len & 0xff);
  _bfd_vms_output_dump (abfd, (unsigned char *) value, len);
}

/* Output character area.  */

void
_bfd_vms_output_dump (bfd * abfd,
		      unsigned char *data,
		      int length)
{
#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_dump (%d)\n", length);
#endif

  if (length == 0)
    return;

  memcpy (PRIV (output_buf) + PRIV (output_size), data, (size_t) length);
  PRIV (output_size) += length;
}

/* Output count bytes of value.  */

void
_bfd_vms_output_fill (bfd * abfd,
		      int value,
		      int count)
{
#if VMS_DEBUG
  vms_debug (6, "_bfd_vms_output_fill (val %02x times %d)\n", value, count);
#endif

  if (count == 0)
    return;
  memset (PRIV (output_buf) + PRIV (output_size), value, (size_t) count);
  PRIV (output_size) += count;
}

/* This hash routine borrowed from GNU-EMACS, and strengthened slightly.  ERY.  */

static int
hash_string (const char *ptr)
{
  const unsigned char *p = (unsigned char *) ptr;
  const unsigned char *end = p + strlen (ptr);
  unsigned char c;
  int hash = 0;

  while (p != end)
    {
      c = *p++;
      hash = ((hash << 3) + (hash << 15) + (hash >> 28) + c);
    }
  return hash;
}

/* Generate a length-hashed VMS symbol name (limited to maxlen chars).  */

char *
_bfd_vms_length_hash_symbol (bfd * abfd, const char *in, int maxlen)
{
  unsigned long result;
  int in_len;
  char *new_name;
  const char *old_name;
  int i;
  static char outbuf[EOBJ_S_C_SYMSIZ+1];
  char *out = outbuf;

#if VMS_DEBUG
  vms_debug (4, "_bfd_vms_length_hash_symbol \"%s\"\n", in);
#endif

  if (maxlen > EOBJ_S_C_SYMSIZ)
    maxlen = EOBJ_S_C_SYMSIZ;

  /* Save this for later.  */
  new_name = out;

  /* We may need to truncate the symbol, save the hash for later.  */
  in_len = strlen (in);

  result = (in_len > maxlen) ? hash_string (in) : 0;

  old_name = in;

  /* Do the length checking.  */
  if (in_len <= maxlen)
    i = in_len;
  else
    {
      if (PRIV (flag_hash_long_names))
	i = maxlen-9;
      else
	i = maxlen;
    }

  strncpy (out, in, (size_t) i);
  in += i;
  out += i;

  if ((in_len > maxlen)
      && PRIV (flag_hash_long_names))
    sprintf (out, "_%08lx", result);
  else
    *out = 0;

#if VMS_DEBUG
  vms_debug (4, "--> [%d]\"%s\"\n", strlen (outbuf), outbuf);
#endif

  if (in_len > maxlen
	&& PRIV (flag_hash_long_names)
	&& PRIV (flag_show_after_trunc))
    printf (_("Symbol %s replaced by %s\n"), old_name, new_name);

  return outbuf;
}

/* Allocate and initialize a new symbol.  */

static asymbol *
new_symbol (bfd * abfd, char *name)
{
  asymbol *symbol;

#if VMS_DEBUG
  _bfd_vms_debug (7,  "new_symbol %s\n", name);
#endif

  symbol = bfd_make_empty_symbol (abfd);
  if (symbol == 0)
    return symbol;
  symbol->name = name;
  symbol->section = (asection *)(unsigned long)-1;

  return symbol;
}

/* Allocate and enter a new private symbol.  */

vms_symbol_entry *
_bfd_vms_enter_symbol (bfd * abfd, char *name)
{
  vms_symbol_entry *entry;

#if VMS_DEBUG
  _bfd_vms_debug (6,  "_bfd_vms_enter_symbol %s\n", name);
#endif

  entry = (vms_symbol_entry *)
	  bfd_hash_lookup (PRIV (vms_symbol_table), name, FALSE, FALSE);
  if (entry == 0)
    {
#if VMS_DEBUG
      _bfd_vms_debug (8,  "creating hash entry for %s\n", name);
#endif
      entry = (vms_symbol_entry *) bfd_hash_lookup (PRIV (vms_symbol_table),
						    name, TRUE, FALSE);
      if (entry != 0)
	{
	  asymbol *symbol;
	  symbol = new_symbol (abfd, name);
	  if (symbol != 0)
	    {
	      entry->symbol = symbol;
	      PRIV (gsd_sym_count)++;
	      abfd->symcount++;
	    }
	  else
	    entry = 0;
	}
      else
	(*_bfd_error_handler) (_("failed to enter %s"), name);
    }
  else
    {
#if VMS_DEBUG
      _bfd_vms_debug (8,  "found hash entry for %s\n", name);
#endif
    }

#if VMS_DEBUG
  _bfd_vms_debug (7, "-> entry %p, entry->symbol %p\n", entry, entry->symbol);
#endif
  return entry;
}