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