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 85enum 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 91typedef struct { 92 uint32_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} fsinode; 98 99typedef struct _fsnode { 100 struct _fsnode *parent; /* parent (NULL if root) */ 101 struct _fsnode *child; /* child (if type == S_IFDIR) */ 102 struct _fsnode *next; /* next */ 103 struct _fsnode *first; /* first node of current level (".") */ 104 uint32_t type; /* type of entry */ 105 fsinode *inode; /* actual inode data */ 106 char *symlink; /* symlink target */ 107 const char *root; /* root path */ 108 char *path; /* directory name */ 109 char *name; /* file name */ 110 int flags; /* misc flags */ 111} fsnode; 112 113#define FSNODE_F_HASSPEC 0x01 /* fsnode has a spec entry */ 114 115/* 116 * option_t - contains option name, description, pointer to location to store 117 * result, and range checks for the result. Used to simplify fs specific 118 * option setting 119 */ 120typedef enum { 121 OPT_STRARRAY, 122 OPT_STRPTR, 123 OPT_STRBUF, 124 OPT_BOOL, 125 OPT_INT8, 126 OPT_INT16, 127 OPT_INT32, 128 OPT_INT64 129} opttype_t; 130 131typedef struct { 132 char letter; /* option letter NUL for none */ 133 const char *name; /* option name */ 134 void *value; /* where to stuff the value */ 135 opttype_t type; /* type of entry */ 136 long long minimum; /* minimum for value */ 137 long long maximum; /* maximum for value */ 138 const char *desc; /* option description */ 139} option_t; 140 141/* 142 * fsinfo_t - contains various settings and parameters pertaining to 143 * the image, including current settings, global options, and fs 144 * specific options 145 */ 146typedef struct makefs_fsinfo { 147 /* current settings */ 148 off_t size; /* total size */ 149 off_t inodes; /* number of inodes */ 150 uint32_t curinode; /* current inode */ 151 152 /* image settings */ 153 int fd; /* file descriptor of image */ 154 void *superblock; /* superblock */ 155 int onlyspec; /* only add entries in specfile */ 156 157 158 /* global options */ 159 off_t minsize; /* minimum size image should be */ 160 off_t maxsize; /* maximum size image can be */ 161 off_t freefiles; /* free file entries to leave */ 162 off_t freeblocks; /* free blocks to leave */ 163 off_t offset; /* offset from start of file */ 164 int freefilepc; /* free file % */ 165 int freeblockpc; /* free block % */ 166 int needswap; /* non-zero if byte swapping needed */ 167 int sectorsize; /* sector size */ 168 int sparse; /* sparse image, don't fill it with zeros */ 169 int replace; /* replace files when merging */ 170 int follow; /* follow symlinks */ 171 172 void *fs_specific; /* File system specific additions. */ 173 option_t *fs_options; /* File system specific options */ 174} fsinfo_t; 175 176 177 178 179void apply_specfile(const char *, const char *, fsnode *, int); 180void dump_fsnodes(fsnode *); 181const char * inode_type(mode_t); 182int set_option(const option_t *, const char *, char *, size_t); 183void print_options(FILE *, const option_t *); 184int set_option_var(const option_t *, const char *, const char *, 185 char *, size_t); 186fsnode * walk_dir(const char *, const char *, fsnode *, fsnode *, int, 187 int); 188void free_fsnodes(fsnode *); 189option_t * copy_opts(const option_t *); 190 191#define DECLARE_FUN(fs) \ 192void fs ## _prep_opts(fsinfo_t *); \ 193int fs ## _parse_opts(const char *, fsinfo_t *); \ 194void fs ## _cleanup_opts(fsinfo_t *); \ 195void fs ## _makefs(const char *, const char *, fsnode *, fsinfo_t *) 196 197DECLARE_FUN(ffs); 198DECLARE_FUN(cd9660); 199DECLARE_FUN(chfs); 200DECLARE_FUN(v7fs); 201DECLARE_FUN(msdos); 202DECLARE_FUN(udf); 203 204extern u_int debug; 205extern struct timespec start_time; 206extern struct stat stampst; 207 208/* 209 * If -x is specified, we want to exclude nodes which do not appear 210 * in the spec file. 211 */ 212#define FSNODE_EXCLUDE_P(opts, fsnode) \ 213 ((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0) 214 215#define DEBUG_TIME 0x00000001 216 /* debug bits 1..3 unused at this time */ 217#define DEBUG_WALK_DIR 0x00000010 218#define DEBUG_WALK_DIR_NODE 0x00000020 219#define DEBUG_WALK_DIR_LINKCHECK 0x00000040 220#define DEBUG_DUMP_FSNODES 0x00000080 221#define DEBUG_DUMP_FSNODES_VERBOSE 0x00000100 222#define DEBUG_FS_PARSE_OPTS 0x00000200 223#define DEBUG_FS_MAKEFS 0x00000400 224#define DEBUG_FS_VALIDATE 0x00000800 225#define DEBUG_FS_CREATE_IMAGE 0x00001000 226#define DEBUG_FS_SIZE_DIR 0x00002000 227#define DEBUG_FS_SIZE_DIR_NODE 0x00004000 228#define DEBUG_FS_SIZE_DIR_ADD_DIRENT 0x00008000 229#define DEBUG_FS_POPULATE 0x00010000 230#define DEBUG_FS_POPULATE_DIRBUF 0x00020000 231#define DEBUG_FS_POPULATE_NODE 0x00040000 232#define DEBUG_FS_WRITE_FILE 0x00080000 233#define DEBUG_FS_WRITE_FILE_BLOCK 0x00100000 234#define DEBUG_FS_MAKE_DIRBUF 0x00200000 235#define DEBUG_FS_WRITE_INODE 0x00400000 236#define DEBUG_BUF_BREAD 0x00800000 237#define DEBUG_BUF_BWRITE 0x01000000 238#define DEBUG_BUF_GETBLK 0x02000000 239#define DEBUG_APPLY_SPECFILE 0x04000000 240#define DEBUG_APPLY_SPECENTRY 0x08000000 241#define DEBUG_APPLY_SPECONLY 0x10000000 242 243 244#define TIMER_START(x) \ 245 if (debug & DEBUG_TIME) \ 246 gettimeofday(&(x), NULL) 247 248#define TIMER_RESULTS(x,d) \ 249 if (debug & DEBUG_TIME) { \ 250 struct timeval end, td; \ 251 gettimeofday(&end, NULL); \ 252 timersub(&end, &(x), &td); \ 253 printf("%s took %lld.%06ld seconds\n", \ 254 (d), (long long)td.tv_sec, \ 255 (long)td.tv_usec); \ 256 } 257 258 259#ifndef DEFAULT_FSTYPE 260#define DEFAULT_FSTYPE "ffs" 261#endif 262 263 264/* 265 * ffs specific settings 266 * --------------------- 267 */ 268 269#define FFS_EI /* for opposite endian support in ffs headers */ 270 271 272#endif /* _MAKEFS_H */ 273