Home | History | Annotate | Line # | Download | only in makefs
makefs.h revision 1.11
      1 /*	$NetBSD: makefs.h,v 1.11 2003/04/02 10:39:49 fvdl 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_CONFIG_H
     42 #include "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_STATFS_F_IOSIZE 1
     48 #define HAVE_STRUCT_STAT_BIRTHTIME 1
     49 #endif
     50 
     51 #include <sys/stat.h>
     52 #include <err.h>
     53 
     54 /*
     55  * fsnode -
     56  *	a component of the tree; contains a filename, a pointer to
     57  *	fsinode, optional symlink name, and tree pointers
     58  *
     59  * fsinode -
     60  *	equivalent to an inode, containing target file system inode number,
     61  *	refcount (nlink), and stat buffer
     62  *
     63  * A tree of fsnodes looks like this:
     64  *
     65  *	name	"."		"bin"		"netbsd"
     66  *	type	S_IFDIR		S_IFDIR		S_IFREG
     67  *	next 	  >		  >		NULL
     68  *	parent	NULL		NULL		NULL
     69  *	child	NULL		  v
     70  *
     71  *	name			"."		"ls"
     72  *	type			S_IFDIR		S_IFREG
     73  *	next			  >		NULL
     74  *	parent			  ^		^ (to "bin")
     75  *	child			NULL		NULL
     76  *
     77  * Notes:
     78  *	-   first always points to first entry, at current level, which
     79  *	    must be "." when the tree has been built; during build it may
     80  *	    not be if "." hasn't yet been found by readdir(2).
     81  */
     82 
     83 enum fi_flags {
     84 	FI_SIZED =	1<<0,		/* inode sized */
     85 	FI_ALLOCATED =	1<<1,		/* fsinode->ino allocated */
     86 	FI_WRITTEN =	1<<2,		/* inode written */
     87 };
     88 
     89 typedef struct {
     90 	uint32_t	 ino;		/* inode number used on target fs */
     91 	uint32_t	 nlink;		/* number of links to this entry */
     92 	enum fi_flags	 flags;		/* flags used by fs specific code */
     93 	struct stat	 st;		/* stat entry */
     94 } fsinode;
     95 
     96 typedef struct _fsnode {
     97 	struct _fsnode	*parent;	/* parent (NULL if root) */
     98 	struct _fsnode	*child;		/* child (if type == S_IFDIR) */
     99 	struct _fsnode	*next;		/* next */
    100 	struct _fsnode	*first;		/* first node of current level (".") */
    101 	uint32_t	 type;		/* type of entry */
    102 	fsinode		*inode;		/* actual inode data */
    103 	char		*symlink;	/* symlink target */
    104 	char		*name;		/* file name */
    105 	int		flags;		/* misc flags */
    106 } fsnode;
    107 
    108 #define	FSNODE_F_HASSPEC	0x01	/* fsnode has a spec entry */
    109 
    110 /*
    111  * fsinfo_t - contains various settings and parameters pertaining to
    112  * the image, including current settings, global options, and fs
    113  * specific options
    114  */
    115 typedef struct {
    116 		/* current settings */
    117 	off_t	size;		/* total size */
    118 	off_t	inodes;		/* number of inodes */
    119 	uint32_t curinode;	/* current inode */
    120 
    121 		/* image settings */
    122 	int	fd;		/* file descriptor of image */
    123 	void	*superblock;	/* superblock */
    124 	int	onlyspec;	/* only add entries in specfile */
    125 
    126 
    127 		/* global options */
    128 	off_t	minsize;	/* minimum size image should be */
    129 	off_t	maxsize;	/* maximum size image can be */
    130 	off_t	freefiles;	/* free file entries to leave */
    131 	int	freefilepc;	/* free file % */
    132 	off_t	freeblocks;	/* free blocks to leave */
    133 	int	freeblockpc;	/* free block % */
    134 	int	needswap;	/* non-zero if byte swapping needed */
    135 	int	sectorsize;	/* sector size */
    136 
    137 		/* ffs specific options */
    138 	int	bsize;		/* block size */
    139 	int	fsize;		/* fragment size */
    140 	int	cpg;		/* cylinders per group */
    141 	int	cpgflg;		/* cpg was specified by user */
    142 	int	density;	/* bytes per inode */
    143 	int	ntracks;	/* number of tracks */
    144 	int	nsectors;	/* number of sectors */
    145 	int	rpm;		/* rpm */
    146 	int	minfree;	/* free space threshold */
    147 	int	optimization;	/* optimization (space or time) */
    148 	int	maxcontig;	/* max contiguous blocks to allocate */
    149 	int	rotdelay;	/* rotational delay between blocks */
    150 	int	maxbpg;		/* maximum blocks per file in a cyl group */
    151 	int	nrpos;		/* # of distinguished rotational positions */
    152 	int	avgfilesize;	/* expected average file size */
    153 	int	avgfpdir;	/* expected # of files per directory */
    154 	int	version;	/* filesystem version (1 = FFS, 2 = UFS2) */
    155 	int	maxbsize;	/* maximum extent size */
    156 	int	maxblkspercg;	/* max # of blocks per cylinder group */
    157 			/* XXX: support `old' file systems ? */
    158 } fsinfo_t;
    159 
    160 
    161 /*
    162  * option_t - contains option name, description, pointer to location to store
    163  * result, and range checks for the result. Used to simplify fs specific
    164  * option setting
    165  */
    166 typedef struct {
    167 	const char	*name;		/* option name */
    168 	int		*value;		/* where to stuff the value */
    169 	int		minimum;	/* minimum for value */
    170 	int		maximum;	/* maximum for value */
    171 	const char	*desc;		/* option description */
    172 } option_t;
    173 
    174 
    175 void		apply_specfile(const char *, const char *, fsnode *);
    176 void		dump_fsnodes(const char *, fsnode *);
    177 const char *	inode_type(mode_t);
    178 int		set_option(option_t *, const char *, const char *);
    179 fsnode *	walk_dir(const char *, fsnode *);
    180 
    181 int		ffs_parse_opts(const char *, fsinfo_t *);
    182 void		ffs_makefs(const char *, const char *, fsnode *, fsinfo_t *);
    183 
    184 
    185 
    186 extern	uint		debug;
    187 extern	struct timespec	start_time;
    188 
    189 /*
    190  * If -x is specified, we want to exclude nodes which do not appear
    191  * in the spec file.
    192  */
    193 #define	FSNODE_EXCLUDE_P(opts, fsnode)	\
    194 	((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0)
    195 
    196 #define	DEBUG_TIME			0x00000001
    197 		/* debug bits 1..3 unused at this time */
    198 #define	DEBUG_WALK_DIR			0x00000010
    199 #define	DEBUG_WALK_DIR_NODE		0x00000020
    200 #define	DEBUG_WALK_DIR_LINKCHECK	0x00000040
    201 #define	DEBUG_DUMP_FSNODES		0x00000080
    202 #define	DEBUG_DUMP_FSNODES_VERBOSE	0x00000100
    203 #define	DEBUG_FS_PARSE_OPTS		0x00000200
    204 #define	DEBUG_FS_MAKEFS			0x00000400
    205 #define	DEBUG_FS_VALIDATE		0x00000800
    206 #define	DEBUG_FS_CREATE_IMAGE		0x00001000
    207 #define	DEBUG_FS_SIZE_DIR		0x00002000
    208 #define	DEBUG_FS_SIZE_DIR_NODE		0x00004000
    209 #define	DEBUG_FS_SIZE_DIR_ADD_DIRENT	0x00008000
    210 #define	DEBUG_FS_POPULATE		0x00010000
    211 #define	DEBUG_FS_POPULATE_DIRBUF	0x00020000
    212 #define	DEBUG_FS_POPULATE_NODE		0x00040000
    213 #define	DEBUG_FS_WRITE_FILE		0x00080000
    214 #define	DEBUG_FS_WRITE_FILE_BLOCK	0x00100000
    215 #define	DEBUG_FS_MAKE_DIRBUF		0x00200000
    216 #define	DEBUG_FS_WRITE_INODE		0x00400000
    217 #define	DEBUG_BUF_BREAD			0x00800000
    218 #define	DEBUG_BUF_BWRITE		0x01000000
    219 #define	DEBUG_BUF_GETBLK		0x02000000
    220 #define	DEBUG_APPLY_SPECFILE		0x04000000
    221 #define	DEBUG_APPLY_SPECENTRY		0x08000000
    222 
    223 
    224 #define	TIMER_START(x)				\
    225 	if (debug & DEBUG_TIME)			\
    226 		gettimeofday(&(x), NULL)
    227 
    228 #define	TIMER_RESULTS(x,d)				\
    229 	if (debug & DEBUG_TIME) {			\
    230 		struct timeval end, td;			\
    231 		gettimeofday(&end, NULL);		\
    232 		timersub(&end, &(x), &td);		\
    233 		printf("%s took %ld.%06ld seconds\n",	\
    234 		    (d), td.tv_sec, td.tv_usec);	\
    235 	}
    236 
    237 
    238 #ifndef	DEFAULT_FSTYPE
    239 #define	DEFAULT_FSTYPE	"ffs"
    240 #endif
    241 
    242 
    243 /*
    244  *	ffs specific settings
    245  *	---------------------
    246  */
    247 
    248 #define	FFS_EI		/* for opposite endian support in ffs headers */
    249 
    250 
    251 #endif	/* _MAKEFS_H */
    252