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