makefs.h revision 186334
1/* $NetBSD: makefs.h,v 1.14 2004/06/20 22:20:18 jmc 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 * $FreeBSD: projects/makefs/makefs.h 186334 2008-12-19 18:45:43Z sam $ 38 */ 39 40#ifndef _MAKEFS_H 41#define _MAKEFS_H 42 43#include <sys/stat.h> 44#include <err.h> 45 46/* 47 * fsnode - 48 * a component of the tree; contains a filename, a pointer to 49 * fsinode, optional symlink name, and tree pointers 50 * 51 * fsinode - 52 * equivalent to an inode, containing target file system inode number, 53 * refcount (nlink), and stat buffer 54 * 55 * A tree of fsnodes looks like this: 56 * 57 * name "." "bin" "netbsd" 58 * type S_IFDIR S_IFDIR S_IFREG 59 * next > > NULL 60 * parent NULL NULL NULL 61 * child NULL v 62 * 63 * name "." "ls" 64 * type S_IFDIR S_IFREG 65 * next > NULL 66 * parent ^ ^ (to "bin") 67 * child NULL NULL 68 * 69 * Notes: 70 * - first always points to first entry, at current level, which 71 * must be "." when the tree has been built; during build it may 72 * not be if "." hasn't yet been found by readdir(2). 73 */ 74 75enum fi_flags { 76 FI_SIZED = 1<<0, /* inode sized */ 77 FI_ALLOCATED = 1<<1, /* fsinode->ino allocated */ 78 FI_WRITTEN = 1<<2, /* inode written */ 79}; 80 81typedef struct { 82 uint32_t ino; /* inode number used on target fs */ 83 uint32_t nlink; /* number of links to this entry */ 84 enum fi_flags flags; /* flags used by fs specific code */ 85 struct stat st; /* stat entry */ 86} fsinode; 87 88typedef struct _fsnode { 89 struct _fsnode *parent; /* parent (NULL if root) */ 90 struct _fsnode *child; /* child (if type == S_IFDIR) */ 91 struct _fsnode *next; /* next */ 92 struct _fsnode *first; /* first node of current level (".") */ 93 uint32_t type; /* type of entry */ 94 fsinode *inode; /* actual inode data */ 95 char *symlink; /* symlink target */ 96 char *name; /* file name */ 97 int flags; /* misc flags */ 98} fsnode; 99 100#define FSNODE_F_HASSPEC 0x01 /* fsnode has a spec entry */ 101 102/* 103 * fsinfo_t - contains various settings and parameters pertaining to 104 * the image, including current settings, global options, and fs 105 * specific options 106 */ 107typedef struct { 108 /* current settings */ 109 off_t size; /* total size */ 110 off_t inodes; /* number of inodes */ 111 uint32_t curinode; /* current inode */ 112 113 /* image settings */ 114 int fd; /* file descriptor of image */ 115 void *superblock; /* superblock */ 116 int onlyspec; /* only add entries in specfile */ 117 118 119 /* global options */ 120 off_t minsize; /* minimum size image should be */ 121 off_t maxsize; /* maximum size image can be */ 122 off_t freefiles; /* free file entries to leave */ 123 int freefilepc; /* free file % */ 124 off_t freeblocks; /* free blocks to leave */ 125 int freeblockpc; /* free block % */ 126 int needswap; /* non-zero if byte swapping needed */ 127 int sectorsize; /* sector size */ 128 129 /* ffs specific options */ 130 int bsize; /* block size */ 131 int fsize; /* fragment size */ 132 int cpg; /* cylinders per group */ 133 int cpgflg; /* cpg was specified by user */ 134 int density; /* bytes per inode */ 135 int ntracks; /* number of tracks */ 136 int nsectors; /* number of sectors */ 137 int rpm; /* rpm */ 138 int minfree; /* free space threshold */ 139 int optimization; /* optimization (space or time) */ 140 int maxcontig; /* max contiguous blocks to allocate */ 141 int rotdelay; /* rotational delay between blocks */ 142 int maxbpg; /* maximum blocks per file in a cyl group */ 143 int nrpos; /* # of distinguished rotational positions */ 144 int avgfilesize; /* expected average file size */ 145 int avgfpdir; /* expected # of files per directory */ 146 int version; /* filesystem version (1 = FFS, 2 = UFS2) */ 147 int maxbsize; /* maximum extent size */ 148 int maxblkspercg; /* max # of blocks per cylinder group */ 149 /* XXX: support `old' file systems ? */ 150} fsinfo_t; 151 152 153/* 154 * option_t - contains option name, description, pointer to location to store 155 * result, and range checks for the result. Used to simplify fs specific 156 * option setting 157 */ 158typedef struct { 159 const char *name; /* option name */ 160 int *value; /* where to stuff the value */ 161 int minimum; /* minimum for value */ 162 int maximum; /* maximum for value */ 163 const char *desc; /* option description */ 164} option_t; 165 166 167void apply_specfile(const char *, const char *, fsnode *); 168void dump_fsnodes(const char *, fsnode *); 169const char * inode_type(mode_t); 170int set_option(option_t *, const char *, const char *); 171fsnode * walk_dir(const char *, fsnode *); 172 173int ffs_parse_opts(const char *, fsinfo_t *); 174void ffs_makefs(const char *, const char *, fsnode *, fsinfo_t *); 175 176 177 178extern u_int debug; 179extern struct timespec start_time; 180 181/* 182 * If -x is specified, we want to exclude nodes which do not appear 183 * in the spec file. 184 */ 185#define FSNODE_EXCLUDE_P(opts, fsnode) \ 186 ((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0) 187 188#define DEBUG_TIME 0x00000001 189 /* debug bits 1..3 unused at this time */ 190#define DEBUG_WALK_DIR 0x00000010 191#define DEBUG_WALK_DIR_NODE 0x00000020 192#define DEBUG_WALK_DIR_LINKCHECK 0x00000040 193#define DEBUG_DUMP_FSNODES 0x00000080 194#define DEBUG_DUMP_FSNODES_VERBOSE 0x00000100 195#define DEBUG_FS_PARSE_OPTS 0x00000200 196#define DEBUG_FS_MAKEFS 0x00000400 197#define DEBUG_FS_VALIDATE 0x00000800 198#define DEBUG_FS_CREATE_IMAGE 0x00001000 199#define DEBUG_FS_SIZE_DIR 0x00002000 200#define DEBUG_FS_SIZE_DIR_NODE 0x00004000 201#define DEBUG_FS_SIZE_DIR_ADD_DIRENT 0x00008000 202#define DEBUG_FS_POPULATE 0x00010000 203#define DEBUG_FS_POPULATE_DIRBUF 0x00020000 204#define DEBUG_FS_POPULATE_NODE 0x00040000 205#define DEBUG_FS_WRITE_FILE 0x00080000 206#define DEBUG_FS_WRITE_FILE_BLOCK 0x00100000 207#define DEBUG_FS_MAKE_DIRBUF 0x00200000 208#define DEBUG_FS_WRITE_INODE 0x00400000 209#define DEBUG_BUF_BREAD 0x00800000 210#define DEBUG_BUF_BWRITE 0x01000000 211#define DEBUG_BUF_GETBLK 0x02000000 212#define DEBUG_APPLY_SPECFILE 0x04000000 213#define DEBUG_APPLY_SPECENTRY 0x08000000 214 215 216#define TIMER_START(x) \ 217 if (debug & DEBUG_TIME) \ 218 gettimeofday(&(x), NULL) 219 220#define TIMER_RESULTS(x,d) \ 221 if (debug & DEBUG_TIME) { \ 222 struct timeval end, td; \ 223 gettimeofday(&end, NULL); \ 224 timersub(&end, &(x), &td); \ 225 printf("%s took %ld.%06ld seconds\n", \ 226 (d), (long) td.tv_sec, (long) td.tv_usec); \ 227 } 228 229 230#ifndef DEFAULT_FSTYPE 231#define DEFAULT_FSTYPE "ffs" 232#endif 233 234 235/* 236 * ffs specific settings 237 * --------------------- 238 */ 239 240#define FFS_EI /* for opposite endian support in ffs headers */ 241 242/* 243 * Write-arounds/compat shims for endian-agnostic support. 244 * These belong in the kernel if/when it's possible to mount 245 * filesystems w/ either byte order. 246 */ 247 248/* 249 * File system internal flags, also in fs_flags. 250 * (Pick highest number to avoid conflicts with others) 251 */ 252#define FS_SWAPPED 0x80000000 /* file system is endian swapped */ 253#define FS_INTERNAL 0x80000000 /* mask for internal flags */ 254 255#define FS_ISCLEAN 1 256 257#define DINODE1_SIZE (sizeof(struct ufs1_dinode)) 258#define DINODE2_SIZE (sizeof(struct ufs2_dinode)) 259 260#define MAXSYMLINKLEN_UFS1 ((NDADDR + NIADDR) * sizeof(ufs1_daddr_t)) 261#define MAXSYMLINKLEN_UFS2 ((NDADDR + NIADDR) * sizeof(ufs2_daddr_t)) 262 263#if (BYTE_ORDER == LITTLE_ENDIAN) 264#define DIRSIZ_SWAP(oldfmt, dp, needswap) \ 265 (((oldfmt) && !(needswap)) ? \ 266 DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen)) 267#else 268#define DIRSIZ_SWAP(oldfmt, dp, needswap) \ 269 (((oldfmt) && (needswap)) ? \ 270 DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen)) 271#endif 272 273#define cg_chkmagic_swap(cgp, ns) \ 274 (ufs_rw32((cgp)->cg_magic, (ns)) == CG_MAGIC) 275#define cg_inosused_swap(cgp, ns) \ 276 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_iusedoff, (ns)))) 277#define cg_blksfree_swap(cgp, ns) \ 278 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_freeoff, (ns)))) 279#define cg_clustersfree_swap(cgp, ns) \ 280 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_clusteroff, (ns)))) 281#define cg_clustersum_swap(cgp, ns) \ 282 ((int32_t *)((uintptr_t)(cgp) + ufs_rw32((cgp)->cg_clustersumoff, ns))) 283 284struct fs; 285void ffs_fragacct_swap(struct fs *, int, int32_t [], int, int); 286 287/* 288 * Declarations for compat routines. 289 */ 290long long strsuftoll(const char *, const char *, long long, long long); 291long long strsuftollx(const char *, const char *, 292 long long, long long, char *, size_t); 293 294struct passwd; 295int uid_from_user(const char *, uid_t *); 296int pwcache_userdb(int (*)(int), void (*)(void), 297 struct passwd * (*)(const char *), struct passwd * (*)(uid_t)); 298struct group; 299int gid_from_group(const char *, gid_t *); 300int pwcache_groupdb(int (*)(int), void (*)(void), 301 struct group * (*)(const char *), struct group * (*)(gid_t)); 302 303int setup_getid(const char *dir); 304 305#endif /* _MAKEFS_H */ 306