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 * fsinfo_t - contains various settings and parameters pertaining to 108 * the image, including current settings, global options, and fs 109 * specific options 110 */ 111 typedef struct { 112 /* current settings */ 113 off_t size; /* total size */ 114 off_t inodes; /* number of inodes */ 115 uint32_t curinode; /* current inode */ 116 117 /* image settings */ 118 int fd; /* file descriptor of image */ 119 void *superblock; /* superblock */ 120 int onlyspec; /* only add entries in specfile */ 121 122 123 /* global options */ 124 off_t minsize; /* minimum size image should be */ 125 off_t maxsize; /* maximum size image can be */ 126 off_t freefiles; /* free file entries to leave */ 127 int freefilepc; /* free file % */ 128 off_t freeblocks; /* free blocks to leave */ 129 int freeblockpc; /* free block % */ 130 int needswap; /* non-zero if byte swapping needed */ 131 int sectorsize; /* sector size */ 132 int sparse; /* sparse image, don't fill it with zeros */ 133 134 void *fs_specific; /* File system specific additions. */ 135 } fsinfo_t; 136 137 138 /* 139 * option_t - contains option name, description, pointer to location to store 140 * result, and range checks for the result. Used to simplify fs specific 141 * option setting 142 */ 143 typedef struct { 144 const char *name; /* option name */ 145 int *value; /* where to stuff the value */ 146 int minimum; /* minimum for value */ 147 int maximum; /* maximum for value */ 148 const char *desc; /* option description */ 149 } option_t; 150 151 152 void apply_specfile(const char *, const char *, fsnode *, int); 153 void dump_fsnodes(fsnode *); 154 const char * inode_type(mode_t); 155 fsnode * read_mtree(const char *, fsnode *); 156 int set_option(option_t *, const char *, const char *); 157 fsnode * walk_dir(const char *, const char *, fsnode *, fsnode *); 158 void free_fsnodes(fsnode *); 159 160 void ffs_prep_opts(fsinfo_t *); 161 int ffs_parse_opts(const char *, fsinfo_t *); 162 void ffs_cleanup_opts(fsinfo_t *); 163 void ffs_makefs(const char *, const char *, fsnode *, fsinfo_t *); 164 165 void cd9660_prep_opts(fsinfo_t *); 166 int cd9660_parse_opts(const char *, fsinfo_t *); 167 void cd9660_cleanup_opts(fsinfo_t *); 168 void cd9660_makefs(const char *, const char *, fsnode *, fsinfo_t *); 169 170 171 extern u_int debug; 172 extern int dupsok; 173 extern struct timespec start_time; 174 175 /* 176 * If -x is specified, we want to exclude nodes which do not appear 177 * in the spec file. 178 */ 179 #define FSNODE_EXCLUDE_P(opts, fsnode) \ 180 ((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0) 181 182 #define DEBUG_TIME 0x00000001 183 /* debug bits 1..3 unused at this time */ 184 #define DEBUG_WALK_DIR 0x00000010 185 #define DEBUG_WALK_DIR_NODE 0x00000020 186 #define DEBUG_WALK_DIR_LINKCHECK 0x00000040 187 #define DEBUG_DUMP_FSNODES 0x00000080 188 #define DEBUG_DUMP_FSNODES_VERBOSE 0x00000100 189 #define DEBUG_FS_PARSE_OPTS 0x00000200 190 #define DEBUG_FS_MAKEFS 0x00000400 191 #define DEBUG_FS_VALIDATE 0x00000800 192 #define DEBUG_FS_CREATE_IMAGE 0x00001000 193 #define DEBUG_FS_SIZE_DIR 0x00002000 194 #define DEBUG_FS_SIZE_DIR_NODE 0x00004000 195 #define DEBUG_FS_SIZE_DIR_ADD_DIRENT 0x00008000 196 #define DEBUG_FS_POPULATE 0x00010000 197 #define DEBUG_FS_POPULATE_DIRBUF 0x00020000 198 #define DEBUG_FS_POPULATE_NODE 0x00040000 199 #define DEBUG_FS_WRITE_FILE 0x00080000 200 #define DEBUG_FS_WRITE_FILE_BLOCK 0x00100000 201 #define DEBUG_FS_MAKE_DIRBUF 0x00200000 202 #define DEBUG_FS_WRITE_INODE 0x00400000 203 #define DEBUG_BUF_BREAD 0x00800000 204 #define DEBUG_BUF_BWRITE 0x01000000 205 #define DEBUG_BUF_GETBLK 0x02000000 206 #define DEBUG_APPLY_SPECFILE 0x04000000 207 #define DEBUG_APPLY_SPECENTRY 0x08000000 208 #define DEBUG_APPLY_SPECONLY 0x10000000 209 210 211 #define TIMER_START(x) \ 212 if (debug & DEBUG_TIME) \ 213 gettimeofday(&(x), NULL) 214 215 #define TIMER_RESULTS(x,d) \ 216 if (debug & DEBUG_TIME) { \ 217 struct timeval end, td; \ 218 gettimeofday(&end, NULL); \ 219 timersub(&end, &(x), &td); \ 220 printf("%s took %lld.%06ld seconds\n", \ 221 (d), (long long)td.tv_sec, \ 222 (long)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 * Write-arounds/compat shims for endian-agnostic support. 240 * These belong in the kernel if/when it's possible to mount 241 * filesystems w/ either byte order. 242 */ 243 244 /* 245 * File system internal flags, also in fs_flags. 246 * (Pick highest number to avoid conflicts with others) 247 */ 248 #define FS_SWAPPED 0x80000000 /* file system is endian swapped */ 249 #define FS_INTERNAL 0x80000000 /* mask for internal flags */ 250 251 #define FS_ISCLEAN 1 252 253 #define DINODE1_SIZE (sizeof(struct ufs1_dinode)) 254 #define DINODE2_SIZE (sizeof(struct ufs2_dinode)) 255 256 #define MAXSYMLINKLEN_UFS1 ((NDADDR + NIADDR) * sizeof(ufs1_daddr_t)) 257 #define MAXSYMLINKLEN_UFS2 ((NDADDR + NIADDR) * sizeof(ufs2_daddr_t)) 258 259 #if (BYTE_ORDER == LITTLE_ENDIAN) 260 #define DIRSIZ_SWAP(oldfmt, dp, needswap) \ 261 (((oldfmt) && !(needswap)) ? \ 262 DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen)) 263 #else 264 #define DIRSIZ_SWAP(oldfmt, dp, needswap) \ 265 (((oldfmt) && (needswap)) ? \ 266 DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen)) 267 #endif 268 269 #define cg_chkmagic_swap(cgp, ns) \ 270 (ufs_rw32((cgp)->cg_magic, (ns)) == CG_MAGIC) 271 #define cg_inosused_swap(cgp, ns) \ 272 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_iusedoff, (ns)))) 273 #define cg_blksfree_swap(cgp, ns) \ 274 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_freeoff, (ns)))) 275 #define cg_clustersfree_swap(cgp, ns) \ 276 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_clusteroff, (ns)))) 277 #define cg_clustersum_swap(cgp, ns) \ 278 ((int32_t *)((uintptr_t)(cgp) + ufs_rw32((cgp)->cg_clustersumoff, ns))) 279 280 struct fs; 281 void ffs_fragacct_swap(struct fs *, int, int32_t [], int, int); 282 283 fsinode *link_check(fsinode *); 284 285 #endif /* _MAKEFS_H */ 286