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