1 /* $nEtBSD: makefs.h,v 1.38 2022/04/09 10:05:35 riastradh 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 38 #ifndef _MAKEFS_H 39 #define _MAKEFS_H 40 41 #if HAVE_NBTOOL_CONFIG_H 42 #include "nbtool_config.h" 43 #else 44 #define HAVE_STRUCT_STAT_ST_FLAGS 1 45 #define HAVE_STRUCT_STAT_ST_GEN 1 46 #define HAVE_STRUCT_STAT_ST_MTIMENSEC 1 47 #define HAVE_STRUCT_STATVFS_F_IOSIZE 1 48 #define HAVE_STRUCT_STAT_BIRTHTIME 1 49 #define HAVE_FSTATVFS 1 50 #endif 51 52 #include <stdio.h> 53 #include <sys/stat.h> 54 #include <err.h> 55 56 /* 57 * fsnode - 58 * a component of the tree; contains a filename, a pointer to 59 * fsinode, optional symlink name, and tree pointers 60 * 61 * fsinode - 62 * equivalent to an inode, containing target file system inode number, 63 * refcount (nlink), and stat buffer 64 * 65 * A tree of fsnodes looks like this: 66 * 67 * name "." "bin" "netbsd" 68 * type S_IFDIR S_IFDIR S_IFREG 69 * next > > NULL 70 * parent NULL NULL NULL 71 * child NULL v 72 * 73 * name "." "ls" 74 * type S_IFDIR S_IFREG 75 * next > NULL 76 * parent ^ ^ (to "bin") 77 * child NULL NULL 78 * 79 * Notes: 80 * - first always points to first entry, at current level, which 81 * must be "." when the tree has been built; during build it may 82 * not be if "." hasn't yet been found by readdir(2). 83 */ 84 85 enum fi_flags { 86 FI_SIZED = 1<<0, /* inode sized */ 87 FI_ALLOCATED = 1<<1, /* fsinode->ino allocated */ 88 FI_WRITTEN = 1<<2, /* inode written */ 89 }; 90 91 typedef struct { 92 uint64_t ino; /* inode number used on target fs */ 93 uint32_t nlink; /* number of links to this entry */ 94 enum fi_flags flags; /* flags used by fs specific code */ 95 struct stat st; /* stat entry */ 96 void *fsuse; /* for storing FS dependent info */ 97 #if !HAVE_STRUCT_STAT_ST_FLAGS 98 uint32_t st_flags; /* stand-in for st.st_flags */ 99 #endif 100 } fsinode; 101 102 #if HAVE_STRUCT_STAT_ST_FLAGS 103 #define FSINODE_ST_FLAGS(inode) (inode).st.st_flags 104 #else 105 #define FSINODE_ST_FLAGS(inode) (inode).st_flags 106 #endif 107 108 typedef struct _fsnode { 109 struct _fsnode *parent; /* parent (NULL if root) */ 110 struct _fsnode *child; /* child (if type == S_IFDIR) */ 111 struct _fsnode *next; /* next */ 112 struct _fsnode *first; /* first node of current level (".") */ 113 uint32_t type; /* type of entry */ 114 fsinode *inode; /* actual inode data */ 115 char *symlink; /* symlink target */ 116 const char *root; /* root path */ 117 char *path; /* directory name */ 118 char *name; /* file name */ 119 int flags; /* misc flags */ 120 } fsnode; 121 122 #define FSNODE_F_HASSPEC 0x01 /* fsnode has a spec entry */ 123 124 /* 125 * option_t - contains option name, description, pointer to location to store 126 * result, and range checks for the result. Used to simplify fs specific 127 * option setting 128 */ 129 typedef enum { 130 OPT_STRARRAY, 131 OPT_STRPTR, 132 OPT_STRBUF, 133 OPT_BOOL, 134 OPT_INT8, 135 OPT_INT16, 136 OPT_INT32, 137 OPT_INT64 138 } opttype_t; 139 140 typedef struct { 141 char letter; /* option letter NUL for none */ 142 const char *name; /* option name */ 143 void *value; /* where to stuff the value */ 144 opttype_t type; /* type of entry */ 145 long long minimum; /* minimum for value */ 146 long long maximum; /* maximum for value */ 147 const char *desc; /* option description */ 148 } option_t; 149 150 /* 151 * fsinfo_t - contains various settings and parameters pertaining to 152 * the image, including current settings, global options, and fs 153 * specific options 154 */ 155 typedef struct makefs_fsinfo { 156 /* current settings */ 157 off_t size; /* total size */ 158 off_t inodes; /* number of inodes */ 159 uint32_t curinode; /* current inode */ 160 161 /* image settings */ 162 int fd; /* file descriptor of image */ 163 void *superblock; /* superblock */ 164 int onlyspec; /* only add entries in specfile */ 165 166 167 /* global options */ 168 off_t minsize; /* minimum size image should be */ 169 off_t maxsize; /* maximum size image can be */ 170 off_t freefiles; /* free file entries to leave */ 171 off_t freeblocks; /* free blocks to leave */ 172 off_t offset; /* offset from start of file */ 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 int replace; /* replace files when merging */ 179 int follow; /* follow symlinks */ 180 181 void *fs_specific; /* File system specific additions. */ 182 option_t *fs_options; /* File system specific options */ 183 } fsinfo_t; 184 185 186 187 188 void apply_specfile(const char *, const char *, fsnode *, int); 189 void dump_fsnodes(fsnode *); 190 const char * inode_type(mode_t); 191 int set_option(const option_t *, const char *, char *, size_t); 192 void print_options(FILE *, const option_t *); 193 int set_option_var(const option_t *, const char *, const char *, 194 char *, size_t); 195 fsnode * walk_dir(const char *, const char *, fsnode *, fsnode *, int, 196 int); 197 void free_fsnodes(fsnode *); 198 option_t * copy_opts(const option_t *); 199 200 #define DECLARE_FUN(fs) \ 201 void fs ## _prep_opts(fsinfo_t *); \ 202 int fs ## _parse_opts(const char *, fsinfo_t *); \ 203 void fs ## _cleanup_opts(fsinfo_t *); \ 204 void fs ## _makefs(const char *, const char *, fsnode *, fsinfo_t *) 205 206 DECLARE_FUN(ffs); 207 DECLARE_FUN(cd9660); 208 DECLARE_FUN(chfs); 209 DECLARE_FUN(v7fs); 210 DECLARE_FUN(msdos); 211 DECLARE_FUN(udf); 212 213 extern u_int debug; 214 extern struct timespec start_time; 215 extern struct stat stampst; 216 217 /* 218 * If -x is specified, we want to exclude nodes which do not appear 219 * in the spec file. 220 */ 221 #define FSNODE_EXCLUDE_P(opts, fsnode) \ 222 ((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0) 223 224 #define DEBUG_TIME 0x00000001 225 /* debug bits 1..3 unused at this time */ 226 #define DEBUG_WALK_DIR 0x00000010 227 #define DEBUG_WALK_DIR_NODE 0x00000020 228 #define DEBUG_WALK_DIR_LINKCHECK 0x00000040 229 #define DEBUG_DUMP_FSNODES 0x00000080 230 #define DEBUG_DUMP_FSNODES_VERBOSE 0x00000100 231 #define DEBUG_FS_PARSE_OPTS 0x00000200 232 #define DEBUG_FS_MAKEFS 0x00000400 233 #define DEBUG_FS_VALIDATE 0x00000800 234 #define DEBUG_FS_CREATE_IMAGE 0x00001000 235 #define DEBUG_FS_SIZE_DIR 0x00002000 236 #define DEBUG_FS_SIZE_DIR_NODE 0x00004000 237 #define DEBUG_FS_SIZE_DIR_ADD_DIRENT 0x00008000 238 #define DEBUG_FS_POPULATE 0x00010000 239 #define DEBUG_FS_POPULATE_DIRBUF 0x00020000 240 #define DEBUG_FS_POPULATE_NODE 0x00040000 241 #define DEBUG_FS_WRITE_FILE 0x00080000 242 #define DEBUG_FS_WRITE_FILE_BLOCK 0x00100000 243 #define DEBUG_FS_MAKE_DIRBUF 0x00200000 244 #define DEBUG_FS_WRITE_INODE 0x00400000 245 #define DEBUG_BUF_BREAD 0x00800000 246 #define DEBUG_BUF_BWRITE 0x01000000 247 #define DEBUG_BUF_GETBLK 0x02000000 248 #define DEBUG_APPLY_SPECFILE 0x04000000 249 #define DEBUG_APPLY_SPECENTRY 0x08000000 250 #define DEBUG_APPLY_SPECONLY 0x10000000 251 252 #define DEBUG_STRINGS \ 253 { "time", DEBUG_TIME }, \ 254 { "walk_dir", DEBUG_WALK_DIR }, \ 255 { "walk_dir_node", DEBUG_WALK_DIR_NODE }, \ 256 { "walk_dir_linkcheck", DEBUG_WALK_DIR_LINKCHECK }, \ 257 { "dump_fsnodes", DEBUG_DUMP_FSNODES }, \ 258 { "dump_fsnodes_verbose", DEBUG_DUMP_FSNODES_VERBOSE }, \ 259 { "fs_parse_opts", DEBUG_FS_PARSE_OPTS }, \ 260 { "fs_makefs", DEBUG_FS_MAKEFS }, \ 261 { "fs_validate", DEBUG_FS_VALIDATE }, \ 262 { "fs_create_image", DEBUG_FS_CREATE_IMAGE }, \ 263 { "fs_size_dir", DEBUG_FS_SIZE_DIR }, \ 264 { "fs_size_dir_node", DEBUG_FS_SIZE_DIR_NODE }, \ 265 { "fs_size_dir_add_dirent", DEBUG_FS_SIZE_DIR_ADD_DIRENT }, \ 266 { "fs_populate", DEBUG_FS_POPULATE }, \ 267 { "fs_populate_dirbuf", DEBUG_FS_POPULATE_DIRBUF }, \ 268 { "fs_populate_node", DEBUG_FS_POPULATE_NODE }, \ 269 { "fs_write_file", DEBUG_FS_WRITE_FILE }, \ 270 { "fs_write_file_block", DEBUG_FS_WRITE_FILE_BLOCK }, \ 271 { "fs_make_dirbuf", DEBUG_FS_MAKE_DIRBUF }, \ 272 { "fs_write_inode", DEBUG_FS_WRITE_INODE }, \ 273 { "buf_bread", DEBUG_BUF_BREAD }, \ 274 { "buf_bwrite", DEBUG_BUF_BWRITE }, \ 275 { "buf_getblk", DEBUG_BUF_GETBLK }, \ 276 { "apply_specfile", DEBUG_APPLY_SPECFILE }, \ 277 { "apply_specentry", DEBUG_APPLY_SPECENTRY }, \ 278 { "apply_speconly", DEBUG_APPLY_SPECONLY }, 279 280 #define TIMER_START(x) \ 281 if (debug & DEBUG_TIME) \ 282 gettimeofday(&(x), NULL) 283 284 #define TIMER_RESULTS(x,d) \ 285 if (debug & DEBUG_TIME) { \ 286 struct timeval end, td; \ 287 gettimeofday(&end, NULL); \ 288 timersub(&end, &(x), &td); \ 289 printf("%s took %lld.%06ld seconds\n", \ 290 (d), (long long)td.tv_sec, \ 291 (long)td.tv_usec); \ 292 } 293 294 295 #ifndef DEFAULT_FSTYPE 296 #define DEFAULT_FSTYPE "ffs" 297 #endif 298 299 300 /* 301 * ffs specific settings 302 * --------------------- 303 */ 304 305 #define FFS_EI /* for opposite endian support in ffs headers */ 306 307 308 #endif /* _MAKEFS_H */ 309