usr.sbin/makefs/makefs.h

   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$
  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
  75 enum 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
  81 typedef 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
  88 typedef 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            *contents;      /* file to provide contents */
  97         const char      *root;          /* root path */
  98         char            *path;          /* directory name */
  99         char            *name;          /* file name */
 100         int             flags;          /* misc flags */
 101 } fsnode;
 102
 103 #define FSNODE_F_HASSPEC        0x01    /* fsnode has a spec entry */
 104 #define FSNODE_F_OPTIONAL       0x02    /* fsnode is optional */
 105
 106 /*
 107  * option_t - contains option name, description, pointer to location to store
 108  * result, and range checks for the result. Used to simplify fs specific
 109  * option setting
 110  */
 111 typedef enum {
 112         OPT_STRARRAY,
 113         OPT_STRPTR,
 114         OPT_STRBUF,
 115         OPT_BOOL,
 116         OPT_INT8,
 117         OPT_INT16,
 118         OPT_INT32,
 119         OPT_INT64
 120 } opttype_t;
 121
 122 typedef struct {
 123         char            letter;         /* option letter NUL for none */
 124         const char      *name;          /* option name */
 125         void            *value;         /* where to stuff the value */
 126         opttype_t       type;           /* type of entry */
 127         long long       minimum;        /* minimum for value */
 128         long long       maximum;        /* maximum for value */
 129         const char      *desc;          /* option description */
 130 } option_t;
 131
 132 /*
 133  * fsinfo_t - contains various settings and parameters pertaining to
 134  * the image, including current settings, global options, and fs
 135  * specific options
 136  */
 137 typedef struct makefs_fsinfo {
 138                 /* current settings */
 139         off_t   size;           /* total size */
 140         off_t   inodes;         /* number of inodes */
 141         uint32_t curinode;      /* current inode */
 142
 143                 /* image settings */
 144         int     fd;             /* file descriptor of image */
 145         void    *superblock;    /* superblock */
 146         int     onlyspec;       /* only add entries in specfile */
 147
 148
 149                 /* global options */
 150         off_t   minsize;        /* minimum size image should be */
 151         off_t   maxsize;        /* maximum size image can be */
 152         off_t   freefiles;      /* free file entries to leave */
 153         off_t   freeblocks;     /* free blocks to leave */
 154         off_t   roundup;        /* round image size up to this value */
 155         int     freefilepc;     /* free file % */
 156         int     freeblockpc;    /* free block % */
 157         int     needswap;       /* non-zero if byte swapping needed */
 158         int     sectorsize;     /* sector size */
 159         int     sparse;         /* sparse image, don't fill it with zeros */
 160
 161         void    *fs_specific;   /* File system specific additions. */
 162         option_t *fs_options;   /* File system specific options */
 163 } fsinfo_t;
 164
 165
 166 void            apply_specfile(const char *, const char *, fsnode *, int);
 167 void            dump_fsnodes(fsnode *);
 168 const char *    inode_type(mode_t);
 169 fsnode *        read_mtree(const char *, fsnode *);
 170 int             set_option(const option_t *, const char *, char *, size_t);
 171 int             set_option_var(const option_t *, const char *, const char *,
 172     char *, size_t);
 173 fsnode *        walk_dir(const char *, const char *, fsnode *, fsnode *);
 174 void            free_fsnodes(fsnode *);
 175 option_t *      copy_opts(const option_t *);
 176
 177 #define DECLARE_FUN(fs)                                                 \
 178 void            fs ## _prep_opts(fsinfo_t *);                           \
 179 int             fs ## _parse_opts(const char *, fsinfo_t *);            \
 180 void            fs ## _cleanup_opts(fsinfo_t *);                        \
 181 void            fs ## _makefs(const char *, const char *, fsnode *, fsinfo_t *)
 182
 183 DECLARE_FUN(ffs);
 184 DECLARE_FUN(cd9660);
 185
 186 extern  u_int           debug;
 187 extern  int             dupsok;
 188 extern  struct timespec start_time;
 189 extern struct stat stampst;
 190
 191 /*
 192  * If -x is specified, we want to exclude nodes which do not appear
 193  * in the spec file.
 194  */
 195 #define FSNODE_EXCLUDE_P(opts, fsnode)  \
 196         ((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0)
 197
 198 #define DEBUG_TIME                      0x00000001
 199                 /* debug bits 1..3 unused at this time */
 200 #define DEBUG_WALK_DIR                  0x00000010
 201 #define DEBUG_WALK_DIR_NODE             0x00000020
 202 #define DEBUG_WALK_DIR_LINKCHECK        0x00000040
 203 #define DEBUG_DUMP_FSNODES              0x00000080
 204 #define DEBUG_DUMP_FSNODES_VERBOSE      0x00000100
 205 #define DEBUG_FS_PARSE_OPTS             0x00000200
 206 #define DEBUG_FS_MAKEFS                 0x00000400
 207 #define DEBUG_FS_VALIDATE               0x00000800
 208 #define DEBUG_FS_CREATE_IMAGE           0x00001000
 209 #define DEBUG_FS_SIZE_DIR               0x00002000
 210 #define DEBUG_FS_SIZE_DIR_NODE          0x00004000
 211 #define DEBUG_FS_SIZE_DIR_ADD_DIRENT    0x00008000
 212 #define DEBUG_FS_POPULATE               0x00010000
 213 #define DEBUG_FS_POPULATE_DIRBUF        0x00020000
 214 #define DEBUG_FS_POPULATE_NODE          0x00040000
 215 #define DEBUG_FS_WRITE_FILE             0x00080000
 216 #define DEBUG_FS_WRITE_FILE_BLOCK       0x00100000
 217 #define DEBUG_FS_MAKE_DIRBUF            0x00200000
 218 #define DEBUG_FS_WRITE_INODE            0x00400000
 219 #define DEBUG_BUF_BREAD                 0x00800000
 220 #define DEBUG_BUF_BWRITE                0x01000000
 221 #define DEBUG_BUF_GETBLK                0x02000000
 222 #define DEBUG_APPLY_SPECFILE            0x04000000
 223 #define DEBUG_APPLY_SPECENTRY           0x08000000
 224 #define DEBUG_APPLY_SPECONLY            0x10000000
 225
 226
 227 #define TIMER_START(x)                          \
 228         if (debug & DEBUG_TIME)                 \
 229                 gettimeofday(&(x), NULL)
 230
 231 #define TIMER_RESULTS(x,d)                              \
 232         if (debug & DEBUG_TIME) {                       \
 233                 struct timeval end, td;                 \
 234                 gettimeofday(&end, NULL);               \
 235                 timersub(&end, &(x), &td);              \
 236                 printf("%s took %lld.%06ld seconds\n",  \
 237                     (d), (long long)td.tv_sec,          \
 238                     (long)td.tv_usec);                  \
 239         }
 240
 241
 242 #ifndef DEFAULT_FSTYPE
 243 #define DEFAULT_FSTYPE  "ffs"
 244 #endif
 245
 246
 247 /*
 248  *      ffs specific settings
 249  *      ---------------------
 250  */
 251
 252 #define FFS_EI          /* for opposite endian support in ffs headers */
 253
 254 /*
 255  * Write-arounds/compat shims for endian-agnostic support.
 256  * These belong in the kernel if/when it's possible to mount
 257  * filesystems w/ either byte order.
 258  */
 259
 260 /*
 261  * File system internal flags, also in fs_flags.
 262  * (Pick highest number to avoid conflicts with others)
 263  */
 264 #define        FS_SWAPPED      0x80000000      /* file system is endian swapped */
 265 #define        FS_INTERNAL     0x80000000      /* mask for internal flags */
 266
 267 #define        FS_ISCLEAN      1
 268
 269 #define        DINODE1_SIZE    (sizeof(struct ufs1_dinode))
 270 #define        DINODE2_SIZE    (sizeof(struct ufs2_dinode))
 271
 272 #define UFS1_MAXSYMLINKLEN   ((UFS_NDADDR + UFS_NIADDR) * sizeof(ufs1_daddr_t))
 273 #define UFS2_MAXSYMLINKLEN   ((UFS_NDADDR + UFS_NIADDR) * sizeof(ufs2_daddr_t))
 274
 275 #if (BYTE_ORDER == LITTLE_ENDIAN)
 276 #define DIRSIZ_SWAP(oldfmt, dp, needswap)      \
 277     (((oldfmt) && !(needswap)) ?       \
 278     DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen))
 279 #else
 280 #define DIRSIZ_SWAP(oldfmt, dp, needswap)      \
 281     (((oldfmt) && (needswap)) ?                \
 282     DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen))
 283 #endif
 284
 285 #define        cg_chkmagic_swap(cgp, ns) \
 286     (ufs_rw32((cgp)->cg_magic, (ns)) == CG_MAGIC)
 287 #define        cg_inosused_swap(cgp, ns) \
 288     ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_iusedoff, (ns))))
 289 #define        cg_blksfree_swap(cgp, ns) \
 290     ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_freeoff, (ns))))
 291 #define        cg_clustersfree_swap(cgp, ns) \
 292     ((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_clusteroff, (ns))))
 293 #define        cg_clustersum_swap(cgp, ns) \
 294     ((int32_t *)((uintptr_t)(cgp) + ufs_rw32((cgp)->cg_clustersumoff, ns)))
 295
 296 struct fs;
 297 void   ffs_fragacct_swap(struct fs *, int, int32_t [], int, int);
 298
 299 fsinode *link_check(fsinode *);
 300
 301 #endif  /* _MAKEFS_H */