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