1 /* $NetBSD: makefs.h,v 1.20 2008/12/28 21:51:46 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 * $FreeBSD$ 38 */ 39 40 #ifndef _MAKEFS_H 41 #define _MAKEFS_H 42 43 #include <sys/stat.h> 44 #include <err.h> 45 46 /* 47 * fsnode - 48 * a component of the tree; contains a filename, a pointer to 49 * fsinode, optional symlink name, and tree pointers 50 * 51 * fsinode - 52 * equivalent to an inode, containing target file system inode number, 53 * refcount (nlink), and stat buffer 54 * 55 * A tree of fsnodes looks like this: 56 * 57 * name "." "bin" "netbsd" 58 * type S_IFDIR S_IFDIR S_IFREG 59 * next > > NULL 60 * parent NULL NULL NULL 61 * child NULL v 62 * 63 * name "." "ls" 64 * type S_IFDIR S_IFREG 65 * next > NULL 66 * parent ^ ^ (to "bin") 67 * child NULL NULL 68 * 69 * Notes: 70 * - first always points to first entry, at current level, which 71 * must be "." when the tree has been built; during build it may 72 * not be if "." hasn't yet been found by readdir(2). 73 */ 74 75 enum fi_flags { 76 FI_SIZED = 1<<0, /* inode sized */ 77 FI_ALLOCATED = 1<<1, /* fsinode->ino allocated */ 78 FI_WRITTEN = 1<<2, /* inode written */ 79 }; 80 81 typedef struct { 82 uint32_t ino; /* inode number used on target fs */ 83 uint32_t nlink; /* number of links to this entry */ 84 enum fi_flags flags; /* flags used by fs specific code */ 85 struct stat st; /* stat entry */ 86 } fsinode; 87 88 typedef struct _fsnode { 89 struct _fsnode *parent; /* parent (NULL if root) */ 90 struct _fsnode *child; /* child (if type == S_IFDIR) */ 91 struct _fsnode *next; /* next */ 92 struct _fsnode *first; /* first node of current level (".") */ 93 uint32_t type; /* type of entry */ 94 fsinode *inode; /* actual inode data */ 95 char *symlink; /* symlink target */ 96 char *contents; /* file to provide contents */ 97 const char *root; /* root path */ 98 char *path; /* directory name */ 99 char *name; /* file name */ 100 int flags; /* misc flags */ 101 } fsnode; 102 103 #define FSNODE_F_HASSPEC 0x01 /* fsnode has a spec entry */ 104 #define FSNODE_F_OPTIONAL 0x02 /* fsnode is optional */ 105 106 /* 107 * option_t - contains option name, description, pointer to location to store 108 * result, and range checks for the result. Used to simplify fs specific 109 * option setting 110 */ 111 typedef enum { 112 OPT_STRARRAY, 113 OPT_STRPTR, 114 OPT_STRBUF, 115 OPT_BOOL, 116 OPT_INT8, 117 OPT_INT16, 118 OPT_INT32, 119 OPT_INT64 120 } opttype_t; 121 122 typedef struct { 123 char letter; /* option letter NUL for none */ 124 const char *name; /* option name */ 125 void *value; /* where to stuff the value */ 126 opttype_t type; /* type of entry */ 127 long long minimum; /* minimum for value */ 128 long long maximum; /* maximum for value */ 129 const char *desc; /* option description */ 130 } option_t; 131 132 /* 133 * fsinfo_t - contains various settings and parameters pertaining to 134 * the image, including current settings, global options, and fs 135 * specific options 136 */ 137 typedef struct makefs_fsinfo { 138 /* current settings */ 139 off_t size; /* total size */ 140 off_t inodes; /* number of inodes */ 141 uint32_t curinode; /* current inode */ 142 143 /* image settings */ 144 int fd; /* file descriptor of image */ 145 void *superblock; /* superblock */ 146 int onlyspec; /* only add entries in specfile */ 147 148 149 /* global options */ 150 off_t minsize; /* minimum size image should be */ 151 off_t maxsize; /* maximum size image can be */ 152 off_t freefiles; /* free file entries to leave */ 153 off_t freeblocks; /* free blocks to leave */ 154 off_t offset; /* offset from start of file */ 155 off_t roundup; /* round image size up to this value */ 156 int freefilepc; /* free file % */ 157 int freeblockpc; /* free block % */ 158 int needswap; /* non-zero if byte swapping needed */ 159 int sectorsize; /* sector size */ 160 int sparse; /* sparse image, don't fill it with zeros */ 161 162 void *fs_specific; /* File system specific additions. */ 163 option_t *fs_options; /* File system specific options */ 164 } fsinfo_t; 165 166 167 void apply_specfile(const char *, const char *, fsnode *, int); 168 void dump_fsnodes(fsnode *); 169 const char * inode_type(mode_t); 170 fsnode * read_mtree(const char *, fsnode *); 171 int set_option(const option_t *, const char *, char *, size_t); 172 int set_option_var(const option_t *, const char *, const char *, 173 char *, size_t); 174 fsnode * walk_dir(const char *, const char *, fsnode *, fsnode *); 175 void free_fsnodes(fsnode *); 176 option_t * copy_opts(const option_t *); 177 178 #define DECLARE_FUN(fs) \ 179 void fs ## _prep_opts(fsinfo_t *); \ 180 int fs ## _parse_opts(const char *, fsinfo_t *); \ 181 void fs ## _cleanup_opts(fsinfo_t *); \ 182 void fs ## _makefs(const char *, const char *, fsnode *, fsinfo_t *) 183 184 DECLARE_FUN(ffs); 185 DECLARE_FUN(cd9660); 186 187 extern u_int debug; 188 extern int dupsok; 189 extern struct timespec start_time; 190 extern struct stat stampst; 191 192 /* 193 * If -x is specified, we want to exclude nodes which do not appear 194 * in the spec file. 195 */ 196 #define FSNODE_EXCLUDE_P(opts, fsnode) \ 197 ((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0) 198 199 #define DEBUG_TIME 0x00000001 200 /* debug bits 1..3 unused at this time */ 201 #define DEBUG_WALK_DIR 0x00000010 202 #define DEBUG_WALK_DIR_NODE 0x00000020 203 #define DEBUG_WALK_DIR_LINKCHECK 0x00000040 204 #define DEBUG_DUMP_FSNODES 0x00000080 205 #define DEBUG_DUMP_FSNODES_VERBOSE 0x00000100 206 #define DEBUG_FS_PARSE_OPTS 0x00000200 207 #define DEBUG_FS_MAKEFS 0x00000400 208 #define DEBUG_FS_VALIDATE 0x00000800 209 #define DEBUG_FS_CREATE_IMAGE 0x00001000 210 #define DEBUG_FS_SIZE_DIR 0x00002000 211 #define DEBUG_FS_SIZE_DIR_NODE 0x00004000 212 #define DEBUG_FS_SIZE_DIR_ADD_DIRENT 0x00008000 213 #define DEBUG_FS_POPULATE 0x00010000 214 #define DEBUG_FS_POPULATE_DIRBUF 0x00020000 215 #define DEBUG_FS_POPULATE_NODE 0x00040000 216 #define DEBUG_FS_WRITE_FILE 0x00080000 217 #define DEBUG_FS_WRITE_FILE_BLOCK 0x00100000 218 #define DEBUG_FS_MAKE_DIRBUF 0x00200000 219 #define DEBUG_FS_WRITE_INODE 0x00400000 220 #define DEBUG_BUF_BREAD 0x00800000 221 #define DEBUG_BUF_BWRITE 0x01000000 222 #define DEBUG_BUF_GETBLK 0x02000000 223 #define DEBUG_APPLY_SPECFILE 0x04000000 224 #define DEBUG_APPLY_SPECENTRY 0x08000000 225 #define DEBUG_APPLY_SPECONLY 0x10000000 226 227 228 #define TIMER_START(x) \ 229 if (debug & DEBUG_TIME) \ 230 gettimeofday(&(x), NULL) 231 232 #define TIMER_RESULTS(x,d) \ 233 if (debug & DEBUG_TIME) { \ 234 struct timeval end, td; \ 235 gettimeofday(&end, NULL); \ 236 timersub(&end, &(x), &td); \ 237 printf("%s took %lld.%06ld seconds\n", \ 238 (d), (long long)td.tv_sec, \ 239 (long)td.tv_usec); \ 240 } 241 242 243 #ifndef DEFAULT_FSTYPE 244 #define DEFAULT_FSTYPE "ffs" 245 #endif 246 247 248 /* 249 * ffs specific settings 250 * --------------------- 251 */ 252 253 #define FFS_EI /* for opposite endian support in ffs headers */ 254 255 /* 256 * Write-arounds/compat shims for endian-agnostic support. 257 * These belong in the kernel if/when it's possible to mount 258 * filesystems w/ either byte order. 259 */ 260 261 /* 262 * File system internal flags, also in fs_flags. 263 * (Pick highest number to avoid conflicts with others) 264 */ 265 #define FS_SWAPPED 0x80000000 /* file system is endian swapped */ 266 #define FS_INTERNAL 0x80000000 /* mask for internal flags */ 267 268 #define FS_ISCLEAN 1 269 270 #define DINODE1_SIZE (sizeof(struct ufs1_dinode)) 271 #define DINODE2_SIZE (sizeof(struct ufs2_dinode)) 272 273 #define UFS1_MAXSYMLINKLEN ((UFS_NDADDR + UFS_NIADDR) * sizeof(ufs1_daddr_t)) 274 #define UFS2_MAXSYMLINKLEN ((UFS_NDADDR + UFS_NIADDR) * sizeof(ufs2_daddr_t)) 275 276 #if (BYTE_ORDER == LITTLE_ENDIAN) 277 #define DIRSIZ_SWAP(oldfmt, dp, needswap) \ 278 (((oldfmt) && !(needswap)) ? \ 279 DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen)) 280 #else 281 #define DIRSIZ_SWAP(oldfmt, dp, needswap) \ 282 (((oldfmt) && (needswap)) ? \ 283 DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen)) 284 #endif 285 286 #define cg_chkmagic_swap(cgp, ns) \ 287 (ufs_rw32((cgp)->cg_magic, (ns)) == CG_MAGIC) 288 #define cg_inosused_swap(cgp, ns) \ 289 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_iusedoff, (ns)))) 290 #define cg_blksfree_swap(cgp, ns) \ 291 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_freeoff, (ns)))) 292 #define cg_clustersfree_swap(cgp, ns) \ 293 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_clusteroff, (ns)))) 294 #define cg_clustersum_swap(cgp, ns) \ 295 ((int32_t *)((uintptr_t)(cgp) + ufs_rw32((cgp)->cg_clustersumoff, ns))) 296 297 struct fs; 298 void ffs_fragacct_swap(struct fs *, int, int32_t [], int, int); 299 300 fsinode *link_check(fsinode *); 301 302 #endif /* _MAKEFS_H */ 303