1 /* $NetBSD: makefs.h,v 1.8 2002/02/14 05:16:16 lukem 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_CONFIG_H 42 #include "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_STATFS_F_IOSIZE 1 48 #endif 49 50 #include <sys/stat.h> 51 #include <err.h> 52 53 /* 54 * fsnode - 55 * a component of the tree; contains a filename, a pointer to 56 * fsinode, optional symlink name, and tree pointers 57 * 58 * fsinode - 59 * equivalent to an inode, containing target file system inode number, 60 * refcount (nlink), and stat buffer 61 * 62 * A tree of fsnodes looks like this: 63 * 64 * name "." "bin" "netbsd" 65 * type S_IFDIR S_IFDIR S_IFREG 66 * next > > NULL 67 * parent NULL NULL NULL 68 * child NULL v 69 * 70 * name "." "ls" 71 * type S_IFDIR S_IFREG 72 * next > NULL 73 * parent ^ ^ (to "bin") 74 * child NULL NULL 75 * 76 * Notes: 77 * - first always points to first entry, at current level, which 78 * must be "." when the tree has been built; during build it may 79 * not be if "." hasn't yet been found by readdir(2). 80 */ 81 82 enum fi_flags { 83 FI_SIZED = 1<<0, /* inode sized */ 84 FI_ALLOCATED = 1<<1, /* fsinode->ino allocated */ 85 FI_WRITTEN = 1<<2, /* inode written */ 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 struct stat st; /* stat entry */ 93 } fsinode; 94 95 typedef struct _fsnode { 96 struct _fsnode *parent; /* parent (NULL if root) */ 97 struct _fsnode *child; /* child (if type == S_IFDIR) */ 98 struct _fsnode *next; /* next */ 99 struct _fsnode *first; /* first node of current level (".") */ 100 uint32_t type; /* type of entry */ 101 fsinode *inode; /* actual inode data */ 102 char *symlink; /* symlink target */ 103 char *name; /* file name */ 104 } fsnode; 105 106 107 /* 108 * fsinfo_t - contains various settings and parameters pertaining to 109 * the image, including current settings, global options, and fs 110 * specific options 111 */ 112 typedef struct { 113 /* current settings */ 114 off_t size; /* total size */ 115 off_t inodes; /* number of inodes */ 116 uint32_t curinode; /* current inode */ 117 118 /* image settings */ 119 int fd; /* file descriptor of image */ 120 void *superblock; /* superblock */ 121 122 123 /* global options */ 124 off_t minsize; /* minimum size image should be */ 125 off_t maxsize; /* maximum size image can be */ 126 off_t freefiles; /* free file entries to leave */ 127 int freefilepc; /* free file % */ 128 off_t freeblocks; /* free blocks to leave */ 129 int freeblockpc; /* free block % */ 130 int needswap; /* non-zero if byte swapping needed */ 131 int sectorsize; /* sector size */ 132 133 /* ffs specific options */ 134 int bsize; /* block size */ 135 int fsize; /* fragment size */ 136 int cpg; /* cylinders per group */ 137 int cpgflg; /* cpg was specified by user */ 138 int density; /* bytes per inode */ 139 int ntracks; /* number of tracks */ 140 int nsectors; /* number of sectors */ 141 int rpm; /* rpm */ 142 int minfree; /* free space threshold */ 143 int optimization; /* optimization (space or time) */ 144 int maxcontig; /* max contiguous blocks to allocate */ 145 int rotdelay; /* rotational delay between blocks */ 146 int maxbpg; /* maximum blocks per file in a cyl group */ 147 int nrpos; /* # of distinguished rotational positions */ 148 int avgfilesize; /* expected average file size */ 149 int avgfpdir; /* expected # of files per directory */ 150 /* XXX: support `old' file systems ? */ 151 } fsinfo_t; 152 153 154 /* 155 * option_t - contains option name, description, pointer to location to store 156 * result, and range checks for the result. Used to simplify fs specific 157 * option setting 158 */ 159 typedef struct { 160 const char *name; /* option name */ 161 int *value; /* where to stuff the value */ 162 int minimum; /* minimum for value */ 163 int maximum; /* maximum for value */ 164 const char *desc; /* option description */ 165 } option_t; 166 167 168 void apply_specfile(const char *, const char *, fsnode *); 169 void dump_fsnodes(const char *, fsnode *); 170 const char * inode_type(mode_t); 171 int set_option(option_t *, const char *, const char *); 172 fsnode * walk_dir(const char *, fsnode *); 173 174 int ffs_parse_opts(const char *, fsinfo_t *); 175 void ffs_makefs(const char *, const char *, fsnode *, fsinfo_t *); 176 177 178 179 extern uint debug; 180 extern struct timespec start_time; 181 182 #define DEBUG_TIME 0x00000001 183 /* debug bits 1..3 unused at this time */ 184 #define DEBUG_WALK_DIR 0x00000010 185 #define DEBUG_WALK_DIR_NODE 0x00000020 186 #define DEBUG_WALK_DIR_LINKCHECK 0x00000040 187 #define DEBUG_DUMP_FSNODES 0x00000080 188 #define DEBUG_DUMP_FSNODES_VERBOSE 0x00000100 189 #define DEBUG_FS_PARSE_OPTS 0x00000200 190 #define DEBUG_FS_MAKEFS 0x00000400 191 #define DEBUG_FS_VALIDATE 0x00000800 192 #define DEBUG_FS_CREATE_IMAGE 0x00001000 193 #define DEBUG_FS_SIZE_DIR 0x00002000 194 #define DEBUG_FS_SIZE_DIR_NODE 0x00004000 195 #define DEBUG_FS_SIZE_DIR_ADD_DIRENT 0x00008000 196 #define DEBUG_FS_POPULATE 0x00010000 197 #define DEBUG_FS_POPULATE_DIRBUF 0x00020000 198 #define DEBUG_FS_POPULATE_NODE 0x00040000 199 #define DEBUG_FS_WRITE_FILE 0x00080000 200 #define DEBUG_FS_WRITE_FILE_BLOCK 0x00100000 201 #define DEBUG_FS_MAKE_DIRBUF 0x00200000 202 #define DEBUG_FS_WRITE_INODE 0x00400000 203 #define DEBUG_BUF_BREAD 0x00800000 204 #define DEBUG_BUF_BWRITE 0x01000000 205 #define DEBUG_BUF_GETBLK 0x02000000 206 #define DEBUG_APPLY_SPECFILE 0x04000000 207 #define DEBUG_APPLY_SPECENTRY 0x08000000 208 209 210 #define TIMER_START(x) \ 211 if (debug & DEBUG_TIME) \ 212 gettimeofday(&(x), NULL) 213 214 #define TIMER_RESULTS(x,d) \ 215 if (debug & DEBUG_TIME) { \ 216 struct timeval end, td; \ 217 gettimeofday(&end, NULL); \ 218 timersub(&end, &(x), &td); \ 219 printf("%s took %ld.%06ld seconds\n", \ 220 (d), td.tv_sec, td.tv_usec); \ 221 } 222 223 224 #ifndef DEFAULT_FSTYPE 225 #define DEFAULT_FSTYPE "ffs" 226 #endif 227 228 229 /* 230 * ffs specific settings 231 * --------------------- 232 */ 233 234 #define FFS_EI /* for opposite endian support in ffs headers */ 235 236 237 #endif /* _MAKEFS_H */ 238