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