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