makefs.h revision 214921
1/* $NetBSD: makefs.h,v 1.20 2008/12/28 21:51:46 christos 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: head/usr.sbin/makefs/makefs.h 214921 2010-11-07 16:05:04Z cognet $ 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 void *fs_specific; /* File system specific additions. */ 130} fsinfo_t; 131 132 133/* 134 * option_t - contains option name, description, pointer to location to store 135 * result, and range checks for the result. Used to simplify fs specific 136 * option setting 137 */ 138typedef struct { 139 const char *name; /* option name */ 140 int *value; /* where to stuff the value */ 141 int minimum; /* minimum for value */ 142 int maximum; /* maximum for value */ 143 const char *desc; /* option description */ 144} option_t; 145 146 147void apply_specfile(const char *, const char *, fsnode *, int); 148void dump_fsnodes(const char *, fsnode *); 149const char * inode_type(mode_t); 150int set_option(option_t *, const char *, const char *); 151fsnode * walk_dir(const char *, fsnode *); 152void free_fsnodes(fsnode *); 153 154void ffs_prep_opts(fsinfo_t *); 155int ffs_parse_opts(const char *, fsinfo_t *); 156void ffs_cleanup_opts(fsinfo_t *); 157void ffs_makefs(const char *, const char *, fsnode *, fsinfo_t *); 158 159void cd9660_prep_opts(fsinfo_t *); 160int cd9660_parse_opts(const char *, fsinfo_t *); 161void cd9660_cleanup_opts(fsinfo_t *); 162void cd9660_makefs(const char *, const char *, fsnode *, fsinfo_t *); 163 164 165extern u_int debug; 166extern struct timespec start_time; 167 168/* 169 * If -x is specified, we want to exclude nodes which do not appear 170 * in the spec file. 171 */ 172#define FSNODE_EXCLUDE_P(opts, fsnode) \ 173 ((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0) 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#define DEBUG_APPLY_SPECONLY 0x10000000 202 203 204#define TIMER_START(x) \ 205 if (debug & DEBUG_TIME) \ 206 gettimeofday(&(x), NULL) 207 208#define TIMER_RESULTS(x,d) \ 209 if (debug & DEBUG_TIME) { \ 210 struct timeval end, td; \ 211 gettimeofday(&end, NULL); \ 212 timersub(&end, &(x), &td); \ 213 printf("%s took %lld.%06ld seconds\n", \ 214 (d), (long long)td.tv_sec, \ 215 (long)td.tv_usec); \ 216 } 217 218 219#ifndef DEFAULT_FSTYPE 220#define DEFAULT_FSTYPE "ffs" 221#endif 222 223 224/* 225 * ffs specific settings 226 * --------------------- 227 */ 228 229#define FFS_EI /* for opposite endian support in ffs headers */ 230 231/* 232 * Write-arounds/compat shims for endian-agnostic support. 233 * These belong in the kernel if/when it's possible to mount 234 * filesystems w/ either byte order. 235 */ 236 237/* 238 * File system internal flags, also in fs_flags. 239 * (Pick highest number to avoid conflicts with others) 240 */ 241#define FS_SWAPPED 0x80000000 /* file system is endian swapped */ 242#define FS_INTERNAL 0x80000000 /* mask for internal flags */ 243 244#define FS_ISCLEAN 1 245 246#define DINODE1_SIZE (sizeof(struct ufs1_dinode)) 247#define DINODE2_SIZE (sizeof(struct ufs2_dinode)) 248 249#define MAXSYMLINKLEN_UFS1 ((NDADDR + NIADDR) * sizeof(ufs1_daddr_t)) 250#define MAXSYMLINKLEN_UFS2 ((NDADDR + NIADDR) * sizeof(ufs2_daddr_t)) 251 252#if (BYTE_ORDER == LITTLE_ENDIAN) 253#define DIRSIZ_SWAP(oldfmt, dp, needswap) \ 254 (((oldfmt) && !(needswap)) ? \ 255 DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen)) 256#else 257#define DIRSIZ_SWAP(oldfmt, dp, needswap) \ 258 (((oldfmt) && (needswap)) ? \ 259 DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen)) 260#endif 261 262#define cg_chkmagic_swap(cgp, ns) \ 263 (ufs_rw32((cgp)->cg_magic, (ns)) == CG_MAGIC) 264#define cg_inosused_swap(cgp, ns) \ 265 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_iusedoff, (ns)))) 266#define cg_blksfree_swap(cgp, ns) \ 267 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_freeoff, (ns)))) 268#define cg_clustersfree_swap(cgp, ns) \ 269 ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_clusteroff, (ns)))) 270#define cg_clustersum_swap(cgp, ns) \ 271 ((int32_t *)((uintptr_t)(cgp) + ufs_rw32((cgp)->cg_clustersumoff, ns))) 272 273struct fs; 274void ffs_fragacct_swap(struct fs *, int, int32_t [], int, int); 275 276/* 277 * Declarations for compat routines. 278 */ 279long long strsuftoll(const char *, const char *, long long, long long); 280long long strsuftollx(const char *, const char *, 281 long long, long long, char *, size_t); 282 283struct passwd; 284int uid_from_user(const char *, uid_t *); 285int pwcache_userdb(int (*)(int), void (*)(void), 286 struct passwd * (*)(const char *), struct passwd * (*)(uid_t)); 287struct group; 288int gid_from_group(const char *, gid_t *); 289int pwcache_groupdb(int (*)(int), void (*)(void), 290 struct group * (*)(const char *), struct group * (*)(gid_t)); 291 292int setup_getid(const char *dir); 293 294#endif /* _MAKEFS_H */ 295