xref: /freebsd/usr.bin/ar/ar.h (revision cab6a39d7b343596a5823e65c0f7b426551ec22d)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2007 Kai Wang
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #define	BSDAR_VERSION	"1.1.0"
32 
33 /*
34  * ar(1) options.
35  */
36 #define AR_A	0x0001		/* position-after */
37 #define AR_B	0x0002		/* position-before */
38 #define AR_C	0x0004		/* creating new archive */
39 #define AR_CC	0x0008		/* do not overwrite when extracting */
40 #define AR_J	0x0010		/* bzip2 compression */
41 #define AR_O	0x0020		/* preserve original mtime when extracting */
42 #define AR_S	0x0040		/* write archive symbol table */
43 #define AR_SS	0x0080		/* do not write archive symbol table */
44 #define AR_TR	0x0100		/* only keep first 15 chars for member name */
45 #define AR_U	0x0200		/* only extract or update newer members.*/
46 #define AR_V	0x0400		/* verbose mode */
47 #define AR_Z	0x0800		/* gzip compression */
48 #define AR_D	0x1000		/* insert dummy mode, mtime, uid and gid */
49 
50 #define DEF_BLKSZ 10240		/* default block size */
51 
52 /*
53  * Convenient wrapper for general libarchive error handling.
54  */
55 #define	AC(CALL) do {							\
56 	if ((CALL))							\
57 		bsdar_errc(bsdar, archive_errno(a), "%s",		\
58 		    archive_error_string(a));				\
59 } while (0)
60 
61 /*
62  * In-memory representation of archive member(object).
63  */
64 struct ar_obj {
65 	char		 *name;		/* member name */
66 	void		 *maddr;	/* mmap start address */
67 	uid_t		  uid;		/* user id */
68 	gid_t		  gid;		/* group id */
69 	mode_t		  md;		/* octal file permissions */
70 	size_t		  size;		/* member size */
71 	time_t		  mtime;	/* modification time */
72 	int		  fd;		/* file descriptor */
73 	dev_t		  dev;		/* inode's device */
74 	ino_t		  ino;		/* inode's number */
75 
76 	TAILQ_ENTRY(ar_obj) objs;
77 };
78 
79 /*
80  * Structure encapsulates the "global" data for "ar" program.
81  */
82 struct bsdar {
83 	const char	 *filename;	/* archive name. */
84 	const char	 *addlib;	/* target of ADDLIB. */
85 	const char	 *posarg;	/* position arg for modifiers -a, -b. */
86 	char		  mode;		/* program mode */
87 	int		  options;	/* command line options */
88 
89 	const char	 *progname;	/* program name */
90 	int		  argc;
91 	char		**argv;
92 
93 	/*
94 	 * Fields for the archive string table.
95 	 */
96 	char		 *as;		/* buffer for archive string table. */
97 	size_t		  as_sz;	/* current size of as table. */
98 	size_t		  as_cap;	/* capacity of as table buffer. */
99 
100 	/*
101 	 * Fields for the archive symbol table.
102 	 */
103 	uint64_t	  s_cnt;	/* current number of symbols. */
104 	uint64_t	 *s_so;		/* symbol offset table. */
105 	uint64_t	  s_so_max;     /* maximum symbol offset. */
106 	size_t		  s_so_cap;	/* capacity of so table buffer. */
107 
108 	char		 *s_sn;		/* symbol name table */
109 	size_t		  s_sn_cap;	/* capacity of sn table buffer. */
110 	size_t		  s_sn_sz;	/* current size of sn table. */
111 	/* Current member's offset (relative to the end of pseudo members.) */
112 	off_t		  rela_off;
113 
114 	TAILQ_HEAD(, ar_obj) v_obj;	/* object(member) list */
115 };
116 
117 void	ar_mode_script(struct bsdar *ar);
118 int	ar_read_archive(struct bsdar *ar, int mode);
119 int	ar_write_archive(struct bsdar *ar, int mode);
120 void	bsdar_errc(struct bsdar *, int _code, const char *fmt, ...) __dead2;
121 void	bsdar_warnc(struct bsdar *, int _code, const char *fmt, ...);
122