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