1 /* Library function for scanning an archive file.
2 Copyright (C) 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
4 2011, 2012 Free Software Foundation, Inc.
5 This file is part of GNU Make.
7 GNU Make is free software; you can redistribute it and/or modify it under the
8 terms of the GNU General Public License as published by the Free Software
9 Foundation; either version 3 of the License, or (at your option) any later
12 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License along with
17 this program. If not, see <http://www.gnu.org/licenses/>. */
37 #include <lbr$routines.h>
40 static void *VMS_lib_idx
;
42 static char *VMS_saved_memname
;
44 static time_t VMS_member_date
;
46 static long int (*VMS_function
) ();
49 VMS_get_member_info (struct dsc$descriptor_s
*module
, unsigned long *rfa
)
56 static struct dsc$descriptor_s bufdesc
=
57 { 0, DSC$K_DTYPE_T
, DSC$K_CLASS_S
, NULL
};
62 bufdesc
.dsc$a_pointer
= filename
;
63 bufdesc
.dsc$w_length
= sizeof (filename
);
65 status
= lbr$
set_module (&VMS_lib_idx
, rfa
, &bufdesc
,
66 &bufdesc
.dsc$w_length
, 0);
69 error (NILF
, _("lbr$set_module() failed to extract module info, status = %d"),
72 lbr$
close (&VMS_lib_idx
);
77 mhd
= (struct mhddef
*) filename
;
80 /* John Fowler <jfowler@nyx.net> writes this is needed in his environment,
81 * but that decc$fix_time() isn't documented to work this way. Let me
82 * know if this causes problems in other VMS environments.
85 /* Modified by M. Gehre at 11-JAN-2008 because old formula is wrong:
86 * val = decc$fix_time (&mhd->mhd$l_datim) + timezone - daylight*3600;
87 * a) daylight specifies, if the timezone has daylight saving enabled, not
89 * b) what we need is the information, if daylight saving was active, if
90 * the library module was replaced. This information we get using the
96 /* Conversion from VMS time to C time */
97 val
= decc$
fix_time (&mhd
->mhd$l_datim
);
100 * Conversion from local time (stored in library) to GMT (needed for gmake)
101 * Note: The tm_gmtoff element is a VMS extension to the ANSI standard.
103 tmp
= localtime (&val
);
104 val
-= tmp
->tm_gmtoff
;
108 for (i
= 0; i
< module
->dsc$w_length
; i
++)
109 filename
[i
] = _tolower ((unsigned char)module
->dsc$a_pointer
[i
]);
113 VMS_member_date
= (time_t) -1;
116 (*VMS_function
) (-1, filename
, 0, 0, 0, 0, val
, 0, 0, 0,
121 VMS_member_date
= fnval
;
128 /* Takes three arguments ARCHIVE, FUNCTION and ARG.
130 Open the archive named ARCHIVE, find its members one by one,
131 and for each one call FUNCTION with the following arguments:
132 archive file descriptor for reading the data,
134 member name might be truncated flag,
135 member header position in file,
136 member data position in file,
141 member protection mode,
144 NOTE: on VMS systems, only name, date, and arg are meaningful!
146 The descriptor is poised to read the data of the member
147 when FUNCTION is called. It does not matter how much
150 If FUNCTION returns nonzero, we immediately return
151 what FUNCTION returned.
153 Returns -1 if archive does not exist,
154 Returns -2 if archive has invalid format.
155 Returns 0 if have scanned successfully. */
158 ar_scan (const char *archive
, ar_member_func_t function
, const void *arg
)
162 static struct dsc$descriptor_s libdesc
=
163 { 0, DSC$K_DTYPE_T
, DSC$K_CLASS_S
, NULL
};
165 unsigned long func
= LBR$C_READ
;
166 unsigned long type
= LBR$C_TYP_UNK
;
167 unsigned long index
= 1;
171 status
= lbr$
ini_control (&VMS_lib_idx
, &func
, &type
, 0);
175 error (NILF
, _("lbr$ini_control() failed with status = %d"), status
);
179 /* there is no such descriptor with "const char *dsc$a_pointer" */
180 libdesc
.dsc$a_pointer
= (char *)archive
;
181 libdesc
.dsc$w_length
= strlen (archive
);
183 status
= lbr$
open (&VMS_lib_idx
, &libdesc
, 0, 0, 0, 0, 0);
187 error (NILF
, _("unable to open library '%s' to lookup member '%s'"),
188 archive
, (char *)arg
);
192 VMS_saved_memname
= (char *)arg
;
194 /* For comparison, delete .obj from arg name. */
196 p
= strrchr (VMS_saved_memname
, '.');
200 VMS_function
= function
;
202 VMS_member_date
= (time_t) -1;
203 lbr$
get_index (&VMS_lib_idx
, &index
, VMS_get_member_info
, 0);
205 /* Undo the damage. */
209 lbr$
close (&VMS_lib_idx
);
211 return VMS_member_date
> 0 ? VMS_member_date
: 0;
216 /* SCO Unix's compiler defines both of these. */
221 /* On the sun386i and in System V rel 3, ar.h defines two different archive
222 formats depending upon whether you have defined PORTAR (normal) or PORT5AR
223 (System V Release 1). There is no default, one or the other must be defined
224 to have a nonzero value. */
226 #if (!defined (PORTAR) || PORTAR == 0) && (!defined (PORT5AR) || PORT5AR == 0)
229 /* According to Jim Sievert <jas1@rsvl.unisys.com>, for SCO XENIX defining
230 PORTAR to 1 gets the wrong archive format, and defining it to 0 gets the
238 /* On AIX, define these symbols to be sure to get both archive formats.
239 AIX 4.3 introduced the "big" archive format to support 64-bit object
240 files, so on AIX 4.3 systems we need to support both the "normal" and
241 "big" archive formats. An archive's format is indicated in the
242 "fl_magic" field of the "FL_HDR" structure. For a normal archive,
243 this field will be the string defined by the AIAMAG symbol. For a
244 "big" archive, it will be the string defined by the AIAMAGBIG symbol
245 (at least on AIX it works this way).
247 Note: we'll define these symbols regardless of which AIX version
248 we're compiling on, but this is okay since we'll use the new symbols
249 only if they're present. */
251 # define __AR_SMALL__
259 /* BeOS 5 doesn't have <ar.h> but has archives in the same format
260 * as many other Unices. This was taken from GNU binutils for BeOS.
262 # define ARMAG "!<arch>\n" /* String that begins an archive file. */
263 # define SARMAG 8 /* Size of that string. */
264 # define ARFMAG "`\n" /* String in ar_fmag at end of each header. */
267 char ar_name
[16]; /* Member file name, sometimes / terminated. */
268 char ar_date
[12]; /* File date, decimal seconds since Epoch. */
269 char ar_uid
[6], ar_gid
[6]; /* User and group IDs, in ASCII decimal. */
270 char ar_mode
[8]; /* File mode, in ASCII octal. */
271 char ar_size
[10]; /* File size, in ASCII decimal. */
272 char ar_fmag
[2]; /* Always contains ARFMAG. */
275 # define TOCHAR(_m) (_m)
277 /* These should allow us to read Windows (VC++) libraries (according to Frank
278 * Libbrecht <frankl@abzx.belgium.hp.com>)
280 # include <windows.h>
283 # define ARMAG IMAGE_ARCHIVE_START
284 # define SARMAG IMAGE_ARCHIVE_START_SIZE
285 # define ar_hdr _IMAGE_ARCHIVE_MEMBER_HEADER
286 # define ar_name Name
287 # define ar_mode Mode
288 # define ar_size Size
289 # define ar_date Date
290 # define ar_uid UserID
291 # define ar_gid GroupID
292 /* In Windows the member names have type BYTE so we must cast them. */
293 # define TOCHAR(_m) ((char *)(_m))
296 /* Cray's <ar.h> apparently defines this. */
298 # define AR_HDR_SIZE (sizeof (struct ar_hdr))
301 /* Takes three arguments ARCHIVE, FUNCTION and ARG.
303 Open the archive named ARCHIVE, find its members one by one,
304 and for each one call FUNCTION with the following arguments:
305 archive file descriptor for reading the data,
307 member name might be truncated flag,
308 member header position in file,
309 member data position in file,
314 member protection mode,
317 The descriptor is poised to read the data of the member
318 when FUNCTION is called. It does not matter how much
321 If FUNCTION returns nonzero, we immediately return
322 what FUNCTION returned.
324 Returns -1 if archive does not exist,
325 Returns -2 if archive has invalid format.
326 Returns 0 if have scanned successfully. */
329 ar_scan (const char *archive
, ar_member_func_t function
, const void *arg
)
335 FL_HDR_BIG fl_header_big
;
341 int desc
= open (archive
, O_RDONLY
, 0);
347 register int nread
= read (desc
, buf
, SARMAG
);
348 if (nread
!= SARMAG
|| memcmp (buf
, ARMAG
, SARMAG
))
357 register int nread
= read (desc
, &fl_header
, FL_HSZ
);
365 /* If this is a "big" archive, then set the flag and
366 re-read the header into the "big" structure. */
367 if (!memcmp (fl_header
.fl_magic
, AIAMAGBIG
, SAIAMAG
))
371 /* seek back to beginning of archive */
372 if (lseek (desc
, 0, 0) < 0)
378 /* re-read the header into the "big" structure */
379 nread
= read (desc
, &fl_header_big
, FL_HSZ_BIG
);
380 if (nread
!= FL_HSZ_BIG
)
388 /* Check to make sure this is a "normal" archive. */
389 if (memcmp (fl_header
.fl_magic
, AIAMAG
, SAIAMAG
))
400 unsigned short int buf
;
402 register int nread
= read(desc
, &buf
, sizeof (buf
));
403 if (nread
!= sizeof (buf
) || buf
!= ARMAG
)
412 /* Now find the members one by one. */
415 register long int member_offset
= SARMAG
;
418 long int member_offset
;
419 long int last_member_offset
;
424 sscanf (fl_header_big
.fl_fstmoff
, "%20ld", &member_offset
);
425 sscanf (fl_header_big
.fl_lstmoff
, "%20ld", &last_member_offset
);
430 sscanf (fl_header
.fl_fstmoff
, "%12ld", &member_offset
);
431 sscanf (fl_header
.fl_lstmoff
, "%12ld", &last_member_offset
);
434 if (member_offset
== 0)
442 register long int member_offset
= sizeof (int);
444 register long int member_offset
= sizeof (unsigned short int);
445 #endif /* Not Xenix. */
452 struct ar_hdr member_header
;
454 struct ar_hdr_big member_header_big
;
461 long int data_offset
;
463 char namebuf
[sizeof member_header
.ar_name
+ 1];
465 int is_namemap
; /* Nonzero if this entry maps long names. */
471 if (lseek (desc
, member_offset
, 0) < 0)
478 #define AR_MEMHDR_SZ(x) (sizeof(x) - sizeof (x._ar_name))
483 nread
= read (desc
, &member_header_big
,
484 AR_MEMHDR_SZ(member_header_big
) );
486 if (nread
!= AR_MEMHDR_SZ(member_header_big
))
492 sscanf (member_header_big
.ar_namlen
, "%4d", &name_len
);
493 nread
= read (desc
, name
, name_len
);
495 if (nread
!= name_len
)
503 sscanf (member_header_big
.ar_date
, "%12ld", &dateval
);
504 sscanf (member_header_big
.ar_uid
, "%12d", &uidval
);
505 sscanf (member_header_big
.ar_gid
, "%12d", &gidval
);
506 sscanf (member_header_big
.ar_mode
, "%12o", &eltmode
);
507 sscanf (member_header_big
.ar_size
, "%20ld", &eltsize
);
509 data_offset
= (member_offset
+ AR_MEMHDR_SZ(member_header_big
)
515 nread
= read (desc
, &member_header
,
516 AR_MEMHDR_SZ(member_header
) );
518 if (nread
!= AR_MEMHDR_SZ(member_header
))
524 sscanf (member_header
.ar_namlen
, "%4d", &name_len
);
525 nread
= read (desc
, name
, name_len
);
527 if (nread
!= name_len
)
535 sscanf (member_header
.ar_date
, "%12ld", &dateval
);
536 sscanf (member_header
.ar_uid
, "%12d", &uidval
);
537 sscanf (member_header
.ar_gid
, "%12d", &gidval
);
538 sscanf (member_header
.ar_mode
, "%12o", &eltmode
);
539 sscanf (member_header
.ar_size
, "%12ld", &eltsize
);
541 data_offset
= (member_offset
+ AR_MEMHDR_SZ(member_header
)
544 data_offset
+= data_offset
% 2;
547 (*function
) (desc
, name
, 0,
548 member_offset
, data_offset
, eltsize
,
549 dateval
, uidval
, gidval
,
552 #else /* Not AIAMAG. */
553 nread
= read (desc
, &member_header
, AR_HDR_SIZE
);
555 /* No data left means end of file; that is OK. */
558 if (nread
!= AR_HDR_SIZE
559 #if defined(ARFMAG) || defined(ARFZMAG)
562 memcmp (member_header
.ar_fmag
, ARFMAG
, 2)
568 memcmp (member_header
.ar_fmag
, ARFZMAG
, 2)
581 memcpy (name
, member_header
.ar_name
, sizeof member_header
.ar_name
);
583 register char *p
= name
+ sizeof member_header
.ar_name
;
586 while (p
> name
&& *--p
== ' ');
589 /* If the member name is "//" or "ARFILENAMES/" this may be
590 a list of file name mappings. The maximum file name
591 length supported by the standard archive format is 14
592 characters. This member will actually always be the
593 first or second entry in the archive, but we don't check
595 is_namemap
= (!strcmp (name
, "//")
596 || !strcmp (name
, "ARFILENAMES/"));
597 #endif /* Not AIAMAG. */
598 /* On some systems, there is a slash after each member name. */
603 /* If the member name starts with a space or a slash, this
604 is an index into the file name mappings (used by GNU ar).
605 Otherwise if the member name looks like #1/NUMBER the
606 real member name appears in the element data (used by
609 && (name
[0] == ' ' || name
[0] == '/')
612 name
= namemap
+ atoi (name
+ 1);
615 else if (name
[0] == '#'
619 int namesize
= atoi (name
+ 3);
621 name
= alloca (namesize
+ 1);
622 nread
= read (desc
, name
, namesize
);
623 if (nread
!= namesize
)
628 name
[namesize
] = '\0';
632 #endif /* Not AIAMAG. */
636 sscanf (TOCHAR (member_header
.ar_mode
), "%o", &eltmode
);
637 eltsize
= atol (TOCHAR (member_header
.ar_size
));
639 eltmode
= (unsigned short int) member_header
.ar_mode
;
640 eltsize
= member_header
.ar_size
;
641 #endif /* Not Xenix. */
644 (*function
) (desc
, name
, ! long_name
, member_offset
,
645 member_offset
+ AR_HDR_SIZE
, eltsize
,
647 atol (TOCHAR (member_header
.ar_date
)),
648 atoi (TOCHAR (member_header
.ar_uid
)),
649 atoi (TOCHAR (member_header
.ar_gid
)),
651 member_header
.ar_date
,
652 member_header
.ar_uid
,
653 member_header
.ar_gid
,
654 #endif /* Not Xenix. */
666 if (member_offset
== last_member_offset
)
667 /* End of the chain. */
672 sscanf (member_header_big
.ar_nxtmem
, "%20ld", &member_offset
);
675 sscanf (member_header
.ar_nxtmem
, "%12ld", &member_offset
);
677 if (lseek (desc
, member_offset
, 0) != member_offset
)
684 /* If this member maps archive names, we must read it in. The
685 name map will always precede any members whose names must
692 namemap
= alloca (eltsize
);
693 nread
= read (desc
, namemap
, eltsize
);
694 if (nread
!= eltsize
)
700 /* The names are separated by newlines. Some formats have
701 a trailing slash. Null terminate the strings for
703 limit
= namemap
+ eltsize
;
704 for (clear
= namemap
; clear
< limit
; clear
++)
709 if (clear
[-1] == '/')
717 member_offset
+= AR_HDR_SIZE
+ eltsize
;
718 if (member_offset
% 2 != 0)
729 /* Return nonzero iff NAME matches MEM.
730 If TRUNCATED is nonzero, MEM may be truncated to
731 sizeof (struct ar_hdr.ar_name) - 1. */
734 ar_name_equal (const char *name
, const char *mem
, int truncated
)
738 p
= strrchr (name
, '/');
746 /* TRUNCATED should never be set on this system. */
750 #if !defined (__hpux) && !defined (cray)
751 return strneq (name
, mem
, sizeof(hdr
.ar_name
) - 1);
753 return strneq (name
, mem
, sizeof(hdr
.ar_name
) - 2);
754 #endif /* !__hpux && !cray */
759 return !strcmp (name
, mem
);
765 ar_member_pos (int desc UNUSED
, const char *mem
, int truncated
,
766 long int hdrpos
, long int datapos UNUSED
, long int size UNUSED
,
767 long int date UNUSED
, int uid UNUSED
, int gid UNUSED
,
768 int mode UNUSED
, const void *name
)
770 if (!ar_name_equal (name
, mem
, truncated
))
775 /* Set date of member MEMNAME in archive ARNAME to current time.
776 Returns 0 if successful,
777 -1 if file ARNAME does not exist,
778 -2 if not a valid archive,
779 -3 if other random system call error (including file read-only),
780 1 if valid but member MEMNAME does not exist. */
783 ar_member_touch (const char *arname
, const char *memname
)
785 long int pos
= ar_scan (arname
, ar_member_pos
, memname
);
787 struct ar_hdr ar_hdr
;
797 fd
= open (arname
, O_RDWR
, 0666);
800 /* Read in this member's header */
801 if (lseek (fd
, pos
, 0) < 0)
803 if (AR_HDR_SIZE
!= read (fd
, &ar_hdr
, AR_HDR_SIZE
))
805 /* Write back the header, thus touching the archive file. */
806 if (lseek (fd
, pos
, 0) < 0)
808 if (AR_HDR_SIZE
!= write (fd
, &ar_hdr
, AR_HDR_SIZE
))
810 /* The file's mtime is the time we we want. */
811 EINTRLOOP (i
, fstat (fd
, &statbuf
));
814 #if defined(ARFMAG) || defined(ARFZMAG) || defined(AIAMAG) || defined(WINDOWS32)
815 /* Advance member's time to that time */
816 for (ui
= 0; ui
< sizeof ar_hdr
.ar_date
; ui
++)
817 ar_hdr
.ar_date
[ui
] = ' ';
818 sprintf (TOCHAR (ar_hdr
.ar_date
), "%ld", (long int) statbuf
.st_mtime
);
820 ar_hdr
.ar_date
[strlen(ar_hdr
.ar_date
)] = ' ';
823 ar_hdr
.ar_date
= statbuf
.st_mtime
;
825 /* Write back this member's header */
826 if (lseek (fd
, pos
, 0) < 0)
828 if (AR_HDR_SIZE
!= write (fd
, &ar_hdr
, AR_HDR_SIZE
))
844 describe_member (int desc
, const char *name
, int truncated
,
845 long int hdrpos
, long int datapos
, long int size
,
846 long int date
, int uid
, int gid
, int mode
, const void *arg
)
848 extern char *ctime ();
850 printf (_("Member '%s'%s: %ld bytes at %ld (%ld).\n"),
851 name
, truncated
? _(" (name might be truncated)") : "",
852 size
, hdrpos
, datapos
);
853 printf (_(" Date %s"), ctime (&date
));
854 printf (_(" uid = %d, gid = %d, mode = 0%o.\n"), uid
, gid
, mode
);
860 main (int argc
, char **argv
)
862 ar_scan (argv
[1], describe_member
, NULL
);
867 #endif /* NO_ARCHIVES. */