makefs.h revision 1.34
1 /* $NetBSD: makefs.h,v 1.34 2013/02/03 06:16:53 christos 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 const char *root; /* root path */ 106 char *path; /* directory name */ 107 char *name; /* file name */ 108 int flags; /* misc flags */ 109 } fsnode; 110 111 #define FSNODE_F_HASSPEC 0x01 /* fsnode has a spec entry */ 112 113 /* 114 * option_t - contains option name, description, pointer to location to store 115 * result, and range checks for the result. Used to simplify fs specific 116 * option setting 117 */ 118 typedef enum { 119 OPT_STRARRAY, 120 OPT_STRPTR, 121 OPT_STRBUF, 122 OPT_BOOL, 123 OPT_INT8, 124 OPT_INT16, 125 OPT_INT32, 126 OPT_INT64 127 } opttype_t; 128 129 typedef struct { 130 char letter; /* option letter NUL for none */ 131 const char *name; /* option name */ 132 void *value; /* where to stuff the value */ 133 opttype_t type; /* type of entry */ 134 long long minimum; /* minimum for value */ 135 long long maximum; /* maximum for value */ 136 const char *desc; /* option description */ 137 } option_t; 138 139 /* 140 * fsinfo_t - contains various settings and parameters pertaining to 141 * the image, including current settings, global options, and fs 142 * specific options 143 */ 144 typedef struct makefs_fsinfo { 145 /* current settings */ 146 off_t size; /* total size */ 147 off_t inodes; /* number of inodes */ 148 uint32_t curinode; /* current inode */ 149 150 /* image settings */ 151 int fd; /* file descriptor of image */ 152 void *superblock; /* superblock */ 153 int onlyspec; /* only add entries in specfile */ 154 155 156 /* global options */ 157 off_t minsize; /* minimum size image should be */ 158 off_t maxsize; /* maximum size image can be */ 159 off_t freefiles; /* free file entries to leave */ 160 off_t freeblocks; /* free blocks to leave */ 161 off_t offset; /* offset from start of file */ 162 int freefilepc; /* free file % */ 163 int freeblockpc; /* free block % */ 164 int needswap; /* non-zero if byte swapping needed */ 165 int sectorsize; /* sector size */ 166 int sparse; /* sparse image, don't fill it with zeros */ 167 int replace; /* replace files when merging */ 168 169 void *fs_specific; /* File system specific additions. */ 170 option_t *fs_options; /* File system specific options */ 171 } fsinfo_t; 172 173 174 175 176 void apply_specfile(const char *, const char *, fsnode *, int); 177 void dump_fsnodes(fsnode *); 178 const char * inode_type(mode_t); 179 int set_option(const option_t *, const char *, char *, size_t); 180 int set_option_var(const option_t *, const char *, const char *, 181 char *, size_t); 182 fsnode * walk_dir(const char *, const char *, fsnode *, fsnode *, int); 183 void free_fsnodes(fsnode *); 184 option_t * copy_opts(const option_t *); 185 186 #define DECLARE_FUN(fs) \ 187 void fs ## _prep_opts(fsinfo_t *); \ 188 int fs ## _parse_opts(const char *, fsinfo_t *); \ 189 void fs ## _cleanup_opts(fsinfo_t *); \ 190 void fs ## _makefs(const char *, const char *, fsnode *, fsinfo_t *) 191 192 DECLARE_FUN(ffs); 193 DECLARE_FUN(cd9660); 194 DECLARE_FUN(chfs); 195 DECLARE_FUN(v7fs); 196 DECLARE_FUN(msdos); 197 198 extern u_int debug; 199 extern struct timespec start_time; 200 201 /* 202 * If -x is specified, we want to exclude nodes which do not appear 203 * in the spec file. 204 */ 205 #define FSNODE_EXCLUDE_P(opts, fsnode) \ 206 ((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0) 207 208 #define DEBUG_TIME 0x00000001 209 /* debug bits 1..3 unused at this time */ 210 #define DEBUG_WALK_DIR 0x00000010 211 #define DEBUG_WALK_DIR_NODE 0x00000020 212 #define DEBUG_WALK_DIR_LINKCHECK 0x00000040 213 #define DEBUG_DUMP_FSNODES 0x00000080 214 #define DEBUG_DUMP_FSNODES_VERBOSE 0x00000100 215 #define DEBUG_FS_PARSE_OPTS 0x00000200 216 #define DEBUG_FS_MAKEFS 0x00000400 217 #define DEBUG_FS_VALIDATE 0x00000800 218 #define DEBUG_FS_CREATE_IMAGE 0x00001000 219 #define DEBUG_FS_SIZE_DIR 0x00002000 220 #define DEBUG_FS_SIZE_DIR_NODE 0x00004000 221 #define DEBUG_FS_SIZE_DIR_ADD_DIRENT 0x00008000 222 #define DEBUG_FS_POPULATE 0x00010000 223 #define DEBUG_FS_POPULATE_DIRBUF 0x00020000 224 #define DEBUG_FS_POPULATE_NODE 0x00040000 225 #define DEBUG_FS_WRITE_FILE 0x00080000 226 #define DEBUG_FS_WRITE_FILE_BLOCK 0x00100000 227 #define DEBUG_FS_MAKE_DIRBUF 0x00200000 228 #define DEBUG_FS_WRITE_INODE 0x00400000 229 #define DEBUG_BUF_BREAD 0x00800000 230 #define DEBUG_BUF_BWRITE 0x01000000 231 #define DEBUG_BUF_GETBLK 0x02000000 232 #define DEBUG_APPLY_SPECFILE 0x04000000 233 #define DEBUG_APPLY_SPECENTRY 0x08000000 234 #define DEBUG_APPLY_SPECONLY 0x10000000 235 236 237 #define TIMER_START(x) \ 238 if (debug & DEBUG_TIME) \ 239 gettimeofday(&(x), NULL) 240 241 #define TIMER_RESULTS(x,d) \ 242 if (debug & DEBUG_TIME) { \ 243 struct timeval end, td; \ 244 gettimeofday(&end, NULL); \ 245 timersub(&end, &(x), &td); \ 246 printf("%s took %lld.%06ld seconds\n", \ 247 (d), (long long)td.tv_sec, \ 248 (long)td.tv_usec); \ 249 } 250 251 252 #ifndef DEFAULT_FSTYPE 253 #define DEFAULT_FSTYPE "ffs" 254 #endif 255 256 257 /* 258 * ffs specific settings 259 * --------------------- 260 */ 261 262 #define FFS_EI /* for opposite endian support in ffs headers */ 263 264 265 #endif /* _MAKEFS_H */ 266
Indexes created Fri Sep 26 20:09:58 GMT 2025