1 /* $NetBSD: makefs.h,v 1.20 2008/12/28 21:51:46 christos Exp $ */ 2 3 /*- 4 * SPDX-License-Identifier: BSD-4-Clause 5 * 6 * Copyright (c) 2001 Wasabi Systems, Inc. 7 * All rights reserved. 8 * 9 * Written by Luke Mewburn for Wasabi Systems, Inc. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed for the NetBSD Project by 22 * Wasabi Systems, Inc. 23 * 4. The name of Wasabi Systems, Inc. may not be used to endorse 24 * or promote products derived from this software without specific prior 25 * written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND 28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 #ifndef _MAKEFS_H 41 #define _MAKEFS_H 42 43 #if HAVE_NBTOOL_CONFIG_H 44 #include "nbtool_config.h" 45 #else 46 #define HAVE_STRUCT_STAT_ST_FLAGS 1 47 #endif 48 49 #include <sys/stat.h> 50 #include <err.h> 51 52 /* 53 * fsnode - 54 * a component of the tree; contains a filename, a pointer to 55 * fsinode, optional symlink name, and tree pointers 56 * 57 * fsinode - 58 * equivalent to an inode, containing target file system inode number, 59 * refcount (nlink), and stat buffer 60 * 61 * A tree of fsnodes looks like this: 62 * 63 * name "." "bin" "netbsd" 64 * type S_IFDIR S_IFDIR S_IFREG 65 * next > > NULL 66 * parent NULL NULL NULL 67 * child NULL v 68 * 69 * name "." "ls" 70 * type S_IFDIR S_IFREG 71 * next > NULL 72 * parent ^ ^ (to "bin") 73 * child NULL NULL 74 * 75 * Notes: 76 * - first always points to first entry, at current level, which 77 * must be "." when the tree has been built; during build it may 78 * not be if "." hasn't yet been found by readdir(2). 79 */ 80 81 enum fi_flags { 82 FI_SIZED = 1<<0, /* inode sized */ 83 FI_ALLOCATED = 1<<1, /* fsinode->ino allocated */ 84 FI_WRITTEN = 1<<2, /* inode written */ 85 FI_ROOT = 1<<3, /* root of a ZFS dataset */ 86 }; 87 88 typedef struct { 89 uint32_t ino; /* inode number used on target fs */ 90 uint32_t nlink; /* number of links to this entry */ 91 enum fi_flags flags; /* flags used by fs specific code */ 92 void *param; /* for use by individual fs impls */ 93 struct stat st; /* stat entry */ 94 #if !HAVE_STRUCT_STAT_ST_FLAGS 95 uint32_t st_flags; /* stand-in for st.st_flags */ 96 #endif 97 } fsinode; 98 99 #if HAVE_STRUCT_STAT_ST_FLAGS 100 #define FSINODE_ST_FLAGS(inode) (inode).st.st_flags 101 #else 102 #define FSINODE_ST_FLAGS(inode) (inode).st_flags 103 #endif 104 105 typedef struct _fsnode { 106 struct _fsnode *parent; /* parent (NULL if root) */ 107 struct _fsnode *child; /* child (if type == S_IFDIR) */ 108 struct _fsnode *next; /* next */ 109 struct _fsnode *first; /* first node of current level (".") */ 110 uint32_t type; /* type of entry */ 111 fsinode *inode; /* actual inode data */ 112 char *symlink; /* symlink target */ 113 char *contents; /* file to provide contents */ 114 const char *root; /* root path */ 115 char *path; /* directory name */ 116 char *name; /* file name */ 117 int flags; /* misc flags */ 118 } fsnode; 119 120 #define FSNODE_F_HASSPEC 0x01 /* fsnode has a spec entry */ 121 #define FSNODE_F_OPTIONAL 0x02 /* fsnode is optional */ 122 123 /* 124 * option_t - contains option name, description, pointer to location to store 125 * result, and range checks for the result. Used to simplify fs specific 126 * option setting 127 */ 128 typedef enum { 129 OPT_STRARRAY, 130 OPT_STRPTR, 131 OPT_STRBUF, 132 OPT_BOOL, 133 OPT_INT8, 134 OPT_INT16, 135 OPT_INT32, 136 OPT_INT64 137 } opttype_t; 138 139 typedef struct { 140 char letter; /* option letter NUL for none */ 141 const char *name; /* option name */ 142 void *value; /* where to stuff the value */ 143 opttype_t type; /* type of entry */ 144 long long minimum; /* minimum for value */ 145 long long maximum; /* maximum for value */ 146 const char *desc; /* option description */ 147 } option_t; 148 149 /* 150 * fsinfo_t - contains various settings and parameters pertaining to 151 * the image, including current settings, global options, and fs 152 * specific options 153 */ 154 typedef struct makefs_fsinfo { 155 /* current settings */ 156 off_t size; /* total size */ 157 off_t inodes; /* number of inodes */ 158 uint32_t curinode; /* current inode */ 159 160 /* image settings */ 161 int fd; /* file descriptor of image */ 162 void *superblock; /* superblock */ 163 int onlyspec; /* only add entries in specfile */ 164 165 166 /* global options */ 167 off_t minsize; /* minimum size image should be */ 168 off_t maxsize; /* maximum size image can be */ 169 off_t freefiles; /* free file entries to leave */ 170 off_t freeblocks; /* free blocks to leave */ 171 off_t offset; /* offset from start of file */ 172 off_t roundup; /* round image size up to this value */ 173 int freefilepc; /* free file % */ 174 int freeblockpc; /* free block % */ 175 int needswap; /* non-zero if byte swapping needed */ 176 int sectorsize; /* sector size */ 177 int sparse; /* sparse image, don't fill it with zeros */ 178 179 void *fs_specific; /* File system specific additions. */ 180 option_t *fs_options; /* File system specific options */ 181 } fsinfo_t; 182 183 184 void apply_specfile(const char *, const char *, fsnode *, int); 185 void dump_fsnodes(fsnode *); 186 const char * inode_type(mode_t); 187 fsnode * read_mtree(const char *, fsnode *); 188 int set_option(const option_t *, const char *, char *, size_t); 189 int set_option_var(const option_t *, const char *, const char *, 190 char *, size_t); 191 void set_tstamp(fsnode *); 192 fsnode * walk_dir(const char *, const char *, fsnode *, fsnode *); 193 void free_fsnodes(fsnode *); 194 option_t * copy_opts(const option_t *); 195 196 #define DECLARE_FUN(fs) \ 197 void fs ## _prep_opts(fsinfo_t *); \ 198 int fs ## _parse_opts(const char *, fsinfo_t *); \ 199 void fs ## _cleanup_opts(fsinfo_t *); \ 200 void fs ## _makefs(const char *, const char *, fsnode *, fsinfo_t *) 201 202 DECLARE_FUN(cd9660); 203 DECLARE_FUN(ffs); 204 DECLARE_FUN(msdos); 205 #ifdef HAVE_ZFS 206 DECLARE_FUN(zfs); 207 #endif 208 209 extern u_int debug; 210 extern int dupsok; 211 extern struct timespec start_time; 212 extern struct stat stampst; 213 214 /* 215 * If -x is specified, we want to exclude nodes which do not appear 216 * in the spec file. 217 */ 218 #define FSNODE_EXCLUDE_P(opts, fsnode) \ 219 ((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0) 220 221 #define DEBUG_TIME 0x00000001 222 /* debug bits 1..3 unused at this time */ 223 #define DEBUG_WALK_DIR 0x00000010 224 #define DEBUG_WALK_DIR_NODE 0x00000020 225 #define DEBUG_WALK_DIR_LINKCHECK 0x00000040 226 #define DEBUG_DUMP_FSNODES 0x00000080 227 #define DEBUG_DUMP_FSNODES_VERBOSE 0x00000100 228 #define DEBUG_FS_PARSE_OPTS 0x00000200 229 #define DEBUG_FS_MAKEFS 0x00000400 230 #define DEBUG_FS_VALIDATE 0x00000800 231 #define DEBUG_FS_CREATE_IMAGE 0x00001000 232 #define DEBUG_FS_SIZE_DIR 0x00002000 233 #define DEBUG_FS_SIZE_DIR_NODE 0x00004000 234 #define DEBUG_FS_SIZE_DIR_ADD_DIRENT 0x00008000 235 #define DEBUG_FS_POPULATE 0x00010000 236 #define DEBUG_FS_POPULATE_DIRBUF 0x00020000 237 #define DEBUG_FS_POPULATE_NODE 0x00040000 238 #define DEBUG_FS_WRITE_FILE 0x00080000 239 #define DEBUG_FS_WRITE_FILE_BLOCK 0x00100000 240 #define DEBUG_FS_MAKE_DIRBUF 0x00200000 241 #define DEBUG_FS_WRITE_INODE 0x00400000 242 #define DEBUG_BUF_BREAD 0x00800000 243 #define DEBUG_BUF_BWRITE 0x01000000 244 #define DEBUG_BUF_GETBLK 0x02000000 245 #define DEBUG_APPLY_SPECFILE 0x04000000 246 #define DEBUG_APPLY_SPECENTRY 0x08000000 247 #define DEBUG_APPLY_SPECONLY 0x10000000 248 #define DEBUG_MSDOSFS 0x20000000 249 250 251 #define TIMER_START(x) \ 252 if (debug & DEBUG_TIME) \ 253 gettimeofday(&(x), NULL) 254 255 #define TIMER_RESULTS(x,d) \ 256 if (debug & DEBUG_TIME) { \ 257 struct timeval end, td; \ 258 gettimeofday(&end, NULL); \ 259 timersub(&end, &(x), &td); \ 260 printf("%s took %lld.%06ld seconds\n", \ 261 (d), (long long)td.tv_sec, \ 262 (long)td.tv_usec); \ 263 } 264 265 266 #ifndef DEFAULT_FSTYPE 267 #define DEFAULT_FSTYPE "ffs" 268 #endif 269 270 271 /* 272 * ffs specific settings 273 * --------------------- 274 */ 275 276 #define FFS_EI /* for opposite endian support in ffs headers */ 277 278 /* 279 * Write-arounds/compat shims for endian-agnostic support. 280 * These belong in the kernel if/when it's possible to mount 281 * filesystems w/ either byte order. 282 */ 283 284 /* 285 * File system internal flags, also in fs_flags. 286 * (Pick highest number to avoid conflicts with others) 287 */ 288 #define FS_SWAPPED 0x80000000 /* file system is endian swapped */ 289 #define FS_INTERNAL 0x80000000 /* mask for internal flags */ 290 291 #define FS_ISCLEAN 1 292 293 #define DINODE1_SIZE (sizeof(struct ufs1_dinode)) 294 #define DINODE2_SIZE (sizeof(struct ufs2_dinode)) 295 296 #define UFS1_MAXSYMLINKLEN ((UFS_NDADDR + UFS_NIADDR) * sizeof(ufs1_daddr_t)) 297 #define UFS2_MAXSYMLINKLEN ((UFS_NDADDR + UFS_NIADDR) * sizeof(ufs2_daddr_t)) 298 299 #if (BYTE_ORDER == LITTLE_ENDIAN) 300 #define DIRSIZ_SWAP(oldfmt, dp, needswap) \ 301 (((oldfmt) && !(needswap)) ? \ 302 DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen)) 303 #else 304 #define DIRSIZ_SWAP(oldfmt, dp, needswap) \ 305 (((oldfmt) && (needswap)) ? \ 306 DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen)) 307 #endif 308 309 #define cg_chkmagic_swap(cgp, ns) \ 310 (ufs_rw32((cgp)->cg_magic, (ns)) == CG_MAGIC) 311 #define cg_inosused_swap(cgp, ns) \ 312 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_iusedoff, (ns)))) 313 #define cg_blksfree_swap(cgp, ns) \ 314 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_freeoff, (ns)))) 315 #define cg_clustersfree_swap(cgp, ns) \ 316 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_clusteroff, (ns)))) 317 #define cg_clustersum_swap(cgp, ns) \ 318 ((int32_t *)((uintptr_t)(cgp) + ufs_rw32((cgp)->cg_clustersumoff, ns))) 319 320 struct fs; 321 void ffs_fragacct_swap(struct fs *, int, uint32_t [], int, int); 322 323 fsinode *link_check(fsinode *); 324 325 #endif /* _MAKEFS_H */ 326