makefs.h revision 1.3 1 /* $NetBSD: makefs.h,v 1.3 2001/11/25 11:22:09 lukem 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 #include <sys/stat.h>
39
40
41 /*
42 * fsnode - a component of the tree which contains information about the
43 * file system.
44 *
45 * A tree of these looks like this:
46 *
47 * name "." "bin" "netbsd"
48 * type S_IFDIR S_IFDIR S_IFREG
49 * next > > NULL
50 * parent NULL NULL NULL
51 * child NULL v
52 *
53 * name "." "ls"
54 * type S_IFDIR S_IFREG
55 * next > NULL
56 * parent ^ ^ (to "bin")
57 * child NULL NULL
58 *
59 * Notes:
60 * - first always points to first entry, at current level, which
61 * must be "." when the tree has been built; during build it may
62 * not be if "." hasn't yet been found by readdir(2).
63 *
64 * - if dup is not NULL, it points to an fsnode that this is a
65 * duplicate of; only relevant for non directories with > 1 link
66 */
67 typedef struct _fsnode {
68 struct _fsnode *parent; /* parent (NULL if root) */
69 struct _fsnode *child; /* child (if type == S_IFDIR) */
70 struct _fsnode *next; /* next */
71 struct _fsnode *first; /* first node of current level (".") */
72 struct stat statbuf; /* stat entry */
73 char *symlink; /* symlink target */
74 char *name; /* file name */
75 struct _fsnode *dup; /* entry this is a duplicate of
76 (when statbuf.st_nlink > 1) */
77 uint32_t nlink; /* number of links to this entry */
78 uint32_t type; /* type of entry */
79 uint32_t ino; /* inode number used on target fs */
80 } fsnode;
81
82
83 /*
84 * fsinfo_t - contains various settings and parameters pertaining to
85 * the image, including current settings, global options, and fs
86 * specific options
87 */
88 typedef struct {
89 /* current settings */
90 off_t size; /* total size */
91 off_t inodes; /* number of inodes */
92 uint32_t curinode; /* current inode */
93
94 /* image settings */
95 int fd; /* file descriptor of image */
96 void *superblock; /* superblock */
97
98
99 /* global options */
100 off_t minsize; /* minimum size image should be */
101 off_t maxsize; /* maximum size image can be */
102 off_t freefiles; /* free file entries to leave */
103 int freefilepc; /* free file % */
104 off_t freeblocks; /* free blocks to leave */
105 int freeblockpc; /* free block % */
106 int needswap; /* non-zero if byte swapping needed */
107 int sectorsize; /* sector size */
108
109 /* ffs specific options */
110 int bsize; /* block size */
111 int fsize; /* fragment size */
112 int cpg; /* cylinders per group */
113 int density; /* bytes per inode */
114 int ntracks; /* number of tracks */
115 int nsectors; /* number of sectors */
116 int rpm; /* rpm */
117 int minfree; /* free space threshold */
118 int optimization; /* optimization (space or time) */
119 int maxcontig; /* max contiguous blocks to allocate */
120 int rotdelay; /* rotational delay between blocks */
121 int maxbpg; /* maximum blocks per file in a cyl group */
122 int nrpos; /* # of distinguished rotational positions */
123 int avgfilesize; /* expected average file size */
124 int avgfpdir; /* expected # of files per directory */
125 /* XXX: support `old' file systems ? */
126 } fsinfo_t;
127
128
129 /*
130 * option_t - contains option name, description, pointer to location to store
131 * result, and range checks for the result. Used to simplify fs specific
132 * option setting
133 */
134 typedef struct {
135 const char *name; /* option name */
136 int *value; /* where to stuff the value */
137 int minimum; /* minimum for value */
138 int maximum; /* maximum for value */
139 const char *desc; /* option description */
140 } option_t;
141
142
143 void apply_specfile(const char *, const char *, fsnode *);
144 void dump_fsnodes(const char *, fsnode *);
145 const char * inode_type(mode_t);
146 int set_option(option_t *, const char *, const char *);
147 fsnode * walk_dir(const char *, fsnode *);
148
149 int ffs_parse_opts(const char *, fsinfo_t *);
150 void ffs_makefs(const char *, const char *, fsnode *, fsinfo_t *);
151
152
153
154 extern u_int debug;
155 extern struct timespec start_time;
156
157 #define DEBUG_TIME 0x00000001
158 /* debug bits 1..3 unused at this time */
159 #define DEBUG_WALK_DIR 0x00000010
160 #define DEBUG_WALK_DIR_NODE 0x00000020
161 #define DEBUG_WALK_DIR_LINKCHECK 0x00000040
162 #define DEBUG_DUMP_FSNODES 0x00000080
163 #define DEBUG_DUMP_FSNODES_VERBOSE 0x00000100
164 #define DEBUG_FS_PARSE_OPTS 0x00000200
165 #define DEBUG_FS_MAKEFS 0x00000400
166 #define DEBUG_FS_VALIDATE 0x00000800
167 #define DEBUG_FS_CREATE_IMAGE 0x00001000
168 #define DEBUG_FS_SIZE_DIR 0x00002000
169 #define DEBUG_FS_SIZE_DIR_NODE 0x00004000
170 #define DEBUG_FS_SIZE_DIR_ADD_DIRENT 0x00008000
171 #define DEBUG_FS_POPULATE 0x00010000
172 #define DEBUG_FS_POPULATE_DIRBUF 0x00020000
173 #define DEBUG_FS_POPULATE_NODE 0x00040000
174 #define DEBUG_FS_WRITE_FILE 0x00080000
175 #define DEBUG_FS_WRITE_FILE_BLOCK 0x00100000
176 #define DEBUG_FS_MAKE_DIRBUF 0x00200000
177 #define DEBUG_FS_WRITE_INODE 0x00400000
178 #define DEBUG_BUF_BREAD 0x00800000
179 #define DEBUG_BUF_BWRITE 0x01000000
180 #define DEBUG_BUF_GETBLK 0x02000000
181 #define DEBUG_APPLY_SPECFILE 0x04000000
182 #define DEBUG_APPLY_SPECENTRY 0x08000000
183
184
185 #define TIMER_START(x) \
186 if (debug & DEBUG_TIME) \
187 gettimeofday(&(x), NULL)
188
189 #define TIMER_RESULTS(x,d) \
190 if (debug & DEBUG_TIME) { \
191 struct timeval end, td; \
192 gettimeofday(&end, NULL); \
193 timersub(&end, &(x), &td); \
194 printf("%s took %ld.%06ld seconds\n", \
195 (d), td.tv_sec, td.tv_usec); \
196 }
197
198
199 #ifndef DEFAULT_FSTYPE
200 #define DEFAULT_FSTYPE "ffs"
201 #endif
202