xref: /netbsd/usr.sbin/makefs/makefs.h (revision 9f7f9098)
1 /*	$nEtBSD: makefs.h,v 1.38 2022/04/09 10:05:35 riastradh Exp $	*/
2 
3 /*
4  * Copyright (c) 2001 Wasabi Systems, Inc.
5  * All rights reserved.
6  *
7  * Written by Luke Mewburn for Wasabi Systems, Inc.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *      This product includes software developed for the NetBSD Project by
20  *      Wasabi Systems, Inc.
21  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22  *    or promote products derived from this software without specific prior
23  *    written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef	_MAKEFS_H
39 #define	_MAKEFS_H
40 
41 #if HAVE_NBTOOL_CONFIG_H
42 #include "nbtool_config.h"
43 #else
44 #define HAVE_STRUCT_STAT_ST_FLAGS 1
45 #define HAVE_STRUCT_STAT_ST_GEN 1
46 #define HAVE_STRUCT_STAT_ST_MTIMENSEC 1
47 #define HAVE_STRUCT_STATVFS_F_IOSIZE 1
48 #define HAVE_STRUCT_STAT_BIRTHTIME 1
49 #define HAVE_FSTATVFS 1
50 #endif
51 
52 #include <sys/stat.h>
53 #include <err.h>
54 
55 /*
56  * fsnode -
57  *	a component of the tree; contains a filename, a pointer to
58  *	fsinode, optional symlink name, and tree pointers
59  *
60  * fsinode -
61  *	equivalent to an inode, containing target file system inode number,
62  *	refcount (nlink), and stat buffer
63  *
64  * A tree of fsnodes looks like this:
65  *
66  *	name	"."		"bin"		"netbsd"
67  *	type	S_IFDIR		S_IFDIR		S_IFREG
68  *	next 	  >		  >		NULL
69  *	parent	NULL		NULL		NULL
70  *	child	NULL		  v
71  *
72  *	name			"."		"ls"
73  *	type			S_IFDIR		S_IFREG
74  *	next			  >		NULL
75  *	parent			  ^		^ (to "bin")
76  *	child			NULL		NULL
77  *
78  * Notes:
79  *	-   first always points to first entry, at current level, which
80  *	    must be "." when the tree has been built; during build it may
81  *	    not be if "." hasn't yet been found by readdir(2).
82  */
83 
84 enum fi_flags {
85 	FI_SIZED =	1<<0,		/* inode sized */
86 	FI_ALLOCATED =	1<<1,		/* fsinode->ino allocated */
87 	FI_WRITTEN =	1<<2,		/* inode written */
88 };
89 
90 typedef struct {
91 	uint32_t	 ino;		/* inode number used on target fs */
92 	uint32_t	 nlink;		/* number of links to this entry */
93 	enum fi_flags	 flags;		/* flags used by fs specific code */
94 	struct stat	 st;		/* stat entry */
95 	void		*fsuse;		/* for storing FS dependent info */
96 } fsinode;
97 
98 typedef struct _fsnode {
99 	struct _fsnode	*parent;	/* parent (NULL if root) */
100 	struct _fsnode	*child;		/* child (if type == S_IFDIR) */
101 	struct _fsnode	*next;		/* next */
102 	struct _fsnode	*first;		/* first node of current level (".") */
103 	uint32_t	 type;		/* type of entry */
104 	fsinode		*inode;		/* actual inode data */
105 	char		*symlink;	/* symlink target */
106 	const char	*root;		/* root path */
107 	char		*path;		/* directory name */
108 	char		*name;		/* file name */
109 	int		flags;		/* misc flags */
110 } fsnode;
111 
112 #define	FSNODE_F_HASSPEC	0x01	/* fsnode has a spec entry */
113 
114 /*
115  * option_t - contains option name, description, pointer to location to store
116  * result, and range checks for the result. Used to simplify fs specific
117  * option setting
118  */
119 typedef enum {
120 	OPT_STRARRAY,
121 	OPT_STRPTR,
122 	OPT_STRBUF,
123 	OPT_BOOL,
124 	OPT_INT8,
125 	OPT_INT16,
126 	OPT_INT32,
127 	OPT_INT64
128 } opttype_t;
129 
130 typedef struct {
131 	char		letter;		/* option letter NUL for none */
132 	const char	*name;		/* option name */
133 	void		*value;		/* where to stuff the value */
134 	opttype_t	type;		/* type of entry */
135 	long long	minimum;	/* minimum for value */
136 	long long	maximum;	/* maximum for value */
137 	const char	*desc;		/* option description */
138 } option_t;
139 
140 /*
141  * fsinfo_t - contains various settings and parameters pertaining to
142  * the image, including current settings, global options, and fs
143  * specific options
144  */
145 typedef struct makefs_fsinfo {
146 		/* current settings */
147 	off_t	size;		/* total size */
148 	off_t	inodes;		/* number of inodes */
149 	uint32_t curinode;	/* current inode */
150 
151 		/* image settings */
152 	int	fd;		/* file descriptor of image */
153 	void	*superblock;	/* superblock */
154 	int	onlyspec;	/* only add entries in specfile */
155 
156 
157 		/* global options */
158 	off_t	minsize;	/* minimum size image should be */
159 	off_t	maxsize;	/* maximum size image can be */
160 	off_t	freefiles;	/* free file entries to leave */
161 	off_t	freeblocks;	/* free blocks to leave */
162 	off_t	offset;		/* offset from start of file */
163 	int	freefilepc;	/* free file % */
164 	int	freeblockpc;	/* free block % */
165 	int	needswap;	/* non-zero if byte swapping needed */
166 	int	sectorsize;	/* sector size */
167 	int	sparse;		/* sparse image, don't fill it with zeros */
168 	int	replace;	/* replace files when merging */
169 	int	follow;		/* follow symlinks */
170 
171 	void	*fs_specific;	/* File system specific additions. */
172 	option_t *fs_options;	/* File system specific options */
173 } fsinfo_t;
174 
175 
176 
177 
178 void		apply_specfile(const char *, const char *, fsnode *, int);
179 void		dump_fsnodes(fsnode *);
180 const char *	inode_type(mode_t);
181 int		set_option(const option_t *, const char *, char *, size_t);
182 int		set_option_var(const option_t *, const char *, const char *,
183     char *, size_t);
184 fsnode *	walk_dir(const char *, const char *, fsnode *, fsnode *, int,
185     int);
186 void		free_fsnodes(fsnode *);
187 option_t *	copy_opts(const option_t *);
188 
189 #define DECLARE_FUN(fs)							\
190 void		fs ## _prep_opts(fsinfo_t *);				\
191 int		fs ## _parse_opts(const char *, fsinfo_t *);		\
192 void		fs ## _cleanup_opts(fsinfo_t *);			\
193 void		fs ## _makefs(const char *, const char *, fsnode *, fsinfo_t *)
194 
195 DECLARE_FUN(ffs);
196 DECLARE_FUN(cd9660);
197 DECLARE_FUN(chfs);
198 DECLARE_FUN(v7fs);
199 DECLARE_FUN(msdos);
200 DECLARE_FUN(udf);
201 
202 extern	u_int		debug;
203 extern	struct timespec	start_time;
204 extern	struct stat stampst;
205 
206 /*
207  * If -x is specified, we want to exclude nodes which do not appear
208  * in the spec file.
209  */
210 #define	FSNODE_EXCLUDE_P(opts, fsnode)	\
211 	((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0)
212 
213 #define	DEBUG_TIME			0x00000001
214 		/* debug bits 1..3 unused at this time */
215 #define	DEBUG_WALK_DIR			0x00000010
216 #define	DEBUG_WALK_DIR_NODE		0x00000020
217 #define	DEBUG_WALK_DIR_LINKCHECK	0x00000040
218 #define	DEBUG_DUMP_FSNODES		0x00000080
219 #define	DEBUG_DUMP_FSNODES_VERBOSE	0x00000100
220 #define	DEBUG_FS_PARSE_OPTS		0x00000200
221 #define	DEBUG_FS_MAKEFS			0x00000400
222 #define	DEBUG_FS_VALIDATE		0x00000800
223 #define	DEBUG_FS_CREATE_IMAGE		0x00001000
224 #define	DEBUG_FS_SIZE_DIR		0x00002000
225 #define	DEBUG_FS_SIZE_DIR_NODE		0x00004000
226 #define	DEBUG_FS_SIZE_DIR_ADD_DIRENT	0x00008000
227 #define	DEBUG_FS_POPULATE		0x00010000
228 #define	DEBUG_FS_POPULATE_DIRBUF	0x00020000
229 #define	DEBUG_FS_POPULATE_NODE		0x00040000
230 #define	DEBUG_FS_WRITE_FILE		0x00080000
231 #define	DEBUG_FS_WRITE_FILE_BLOCK	0x00100000
232 #define	DEBUG_FS_MAKE_DIRBUF		0x00200000
233 #define	DEBUG_FS_WRITE_INODE		0x00400000
234 #define	DEBUG_BUF_BREAD			0x00800000
235 #define	DEBUG_BUF_BWRITE		0x01000000
236 #define	DEBUG_BUF_GETBLK		0x02000000
237 #define	DEBUG_APPLY_SPECFILE		0x04000000
238 #define	DEBUG_APPLY_SPECENTRY		0x08000000
239 #define	DEBUG_APPLY_SPECONLY		0x10000000
240 
241 
242 #define	TIMER_START(x)				\
243 	if (debug & DEBUG_TIME)			\
244 		gettimeofday(&(x), NULL)
245 
246 #define	TIMER_RESULTS(x,d)				\
247 	if (debug & DEBUG_TIME) {			\
248 		struct timeval end, td;			\
249 		gettimeofday(&end, NULL);		\
250 		timersub(&end, &(x), &td);		\
251 		printf("%s took %lld.%06ld seconds\n",	\
252 		    (d), (long long)td.tv_sec,		\
253 		    (long)td.tv_usec);			\
254 	}
255 
256 
257 #ifndef	DEFAULT_FSTYPE
258 #define	DEFAULT_FSTYPE	"ffs"
259 #endif
260 
261 
262 /*
263  *	ffs specific settings
264  *	---------------------
265  */
266 
267 #define	FFS_EI		/* for opposite endian support in ffs headers */
268 
269 
270 #endif	/* _MAKEFS_H */
271