makefs.h revision 1.7 1 /* $NetBSD: makefs.h,v 1.7 2002/01/31 22:44:03 tv 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 * - if dup is not NULL, it points to an fsent that this is a
82 * duplicate of; only relevant for non directories with > 1 link
83 */
84
85 enum fi_flags {
86 FI_SIZED = 1<<0, /* inode sized */
87 FI_ALLOCATED = 1<<1, /* fsinode->ino allocated */
88 FI_WRITTEN = 1<<2, /* inode written */
89 };
90
91 typedef struct {
92 uint32_t ino; /* inode number used on target fs */
93 uint32_t nlink; /* number of links to this entry */
94 enum fi_flags flags; /* flags used by fs specific code */
95 struct stat st; /* stat entry */
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 char *name; /* file name */
107 } fsnode;
108
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
125
126 /* global options */
127 off_t minsize; /* minimum size image should be */
128 off_t maxsize; /* maximum size image can be */
129 off_t freefiles; /* free file entries to leave */
130 int freefilepc; /* free file % */
131 off_t freeblocks; /* free blocks to leave */
132 int freeblockpc; /* free block % */
133 int needswap; /* non-zero if byte swapping needed */
134 int sectorsize; /* sector size */
135
136 /* ffs specific options */
137 int bsize; /* block size */
138 int fsize; /* fragment size */
139 int cpg; /* cylinders per group */
140 int cpgflg; /* cpg was specified by user */
141 int density; /* bytes per inode */
142 int ntracks; /* number of tracks */
143 int nsectors; /* number of sectors */
144 int rpm; /* rpm */
145 int minfree; /* free space threshold */
146 int optimization; /* optimization (space or time) */
147 int maxcontig; /* max contiguous blocks to allocate */
148 int rotdelay; /* rotational delay between blocks */
149 int maxbpg; /* maximum blocks per file in a cyl group */
150 int nrpos; /* # of distinguished rotational positions */
151 int avgfilesize; /* expected average file size */
152 int avgfpdir; /* expected # of files per directory */
153 /* XXX: support `old' file systems ? */
154 } fsinfo_t;
155
156
157 /*
158 * option_t - contains option name, description, pointer to location to store
159 * result, and range checks for the result. Used to simplify fs specific
160 * option setting
161 */
162 typedef struct {
163 const char *name; /* option name */
164 int *value; /* where to stuff the value */
165 int minimum; /* minimum for value */
166 int maximum; /* maximum for value */
167 const char *desc; /* option description */
168 } option_t;
169
170
171 void apply_specfile(const char *, const char *, fsnode *);
172 void dump_fsnodes(const char *, fsnode *);
173 const char * inode_type(mode_t);
174 int set_option(option_t *, const char *, const char *);
175 fsnode * walk_dir(const char *, fsnode *);
176
177 int ffs_parse_opts(const char *, fsinfo_t *);
178 void ffs_makefs(const char *, const char *, fsnode *, fsinfo_t *);
179
180
181
182 extern uint debug;
183 extern struct timespec start_time;
184
185 #define DEBUG_TIME 0x00000001
186 /* debug bits 1..3 unused at this time */
187 #define DEBUG_WALK_DIR 0x00000010
188 #define DEBUG_WALK_DIR_NODE 0x00000020
189 #define DEBUG_WALK_DIR_LINKCHECK 0x00000040
190 #define DEBUG_DUMP_FSNODES 0x00000080
191 #define DEBUG_DUMP_FSNODES_VERBOSE 0x00000100
192 #define DEBUG_FS_PARSE_OPTS 0x00000200
193 #define DEBUG_FS_MAKEFS 0x00000400
194 #define DEBUG_FS_VALIDATE 0x00000800
195 #define DEBUG_FS_CREATE_IMAGE 0x00001000
196 #define DEBUG_FS_SIZE_DIR 0x00002000
197 #define DEBUG_FS_SIZE_DIR_NODE 0x00004000
198 #define DEBUG_FS_SIZE_DIR_ADD_DIRENT 0x00008000
199 #define DEBUG_FS_POPULATE 0x00010000
200 #define DEBUG_FS_POPULATE_DIRBUF 0x00020000
201 #define DEBUG_FS_POPULATE_NODE 0x00040000
202 #define DEBUG_FS_WRITE_FILE 0x00080000
203 #define DEBUG_FS_WRITE_FILE_BLOCK 0x00100000
204 #define DEBUG_FS_MAKE_DIRBUF 0x00200000
205 #define DEBUG_FS_WRITE_INODE 0x00400000
206 #define DEBUG_BUF_BREAD 0x00800000
207 #define DEBUG_BUF_BWRITE 0x01000000
208 #define DEBUG_BUF_GETBLK 0x02000000
209 #define DEBUG_APPLY_SPECFILE 0x04000000
210 #define DEBUG_APPLY_SPECENTRY 0x08000000
211
212
213 #define TIMER_START(x) \
214 if (debug & DEBUG_TIME) \
215 gettimeofday(&(x), NULL)
216
217 #define TIMER_RESULTS(x,d) \
218 if (debug & DEBUG_TIME) { \
219 struct timeval end, td; \
220 gettimeofday(&end, NULL); \
221 timersub(&end, &(x), &td); \
222 printf("%s took %ld.%06ld seconds\n", \
223 (d), td.tv_sec, td.tv_usec); \
224 }
225
226
227 #ifndef DEFAULT_FSTYPE
228 #define DEFAULT_FSTYPE "ffs"
229 #endif
230
231
232 /*
233 * ffs specific settings
234 * ---------------------
235 */
236
237 #define FFS_EI /* for opposite endian support in ffs headers */
238
239
240 #endif /* _MAKEFS_H */
241