usr.sbin/makefs/makefs.h

   1 /*      $NetBSD: makefs.h,v 1.20 2008/12/28 21:51:46 christos Exp $     */
   2
   3 /*-
   4  * SPDX-License-Identifier: BSD-4-Clause
   5  *
   6  * Copyright (c) 2001 Wasabi Systems, Inc.
   7  * All rights reserved.
   8  *
   9  * Written by Luke Mewburn for Wasabi Systems, Inc.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed for the NetBSD Project by
  22  *      Wasabi Systems, Inc.
  23  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
  24  *    or promote products derived from this software without specific prior
  25  *    written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
  31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  37  * POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  * $FreeBSD$
  40  */
  41
  42 #ifndef _MAKEFS_H
  43 #define _MAKEFS_H
  44
  45 #include <sys/stat.h>
  46 #include <err.h>
  47
  48 /*
  49  * fsnode -
  50  *      a component of the tree; contains a filename, a pointer to
  51  *      fsinode, optional symlink name, and tree pointers
  52  *
  53  * fsinode -
  54  *      equivalent to an inode, containing target file system inode number,
  55  *      refcount (nlink), and stat buffer
  56  *
  57  * A tree of fsnodes looks like this:
  58  *
  59  *      name    "."             "bin"           "netbsd"
  60  *      type    S_IFDIR         S_IFDIR         S_IFREG
  61  *      next      >               >             NULL
  62  *      parent  NULL            NULL            NULL
  63  *      child   NULL              v
  64  *
  65  *      name                    "."             "ls"
  66  *      type                    S_IFDIR         S_IFREG
  67  *      next                      >             NULL
  68  *      parent                    ^             ^ (to "bin")
  69  *      child                   NULL            NULL
  70  *
  71  * Notes:
  72  *      -   first always points to first entry, at current level, which
  73  *          must be "." when the tree has been built; during build it may
  74  *          not be if "." hasn't yet been found by readdir(2).
  75  */
  76
  77 enum fi_flags {
  78         FI_SIZED =      1<<0,           /* inode sized */
  79         FI_ALLOCATED =  1<<1,           /* fsinode->ino allocated */
  80         FI_WRITTEN =    1<<2,           /* inode written */
  81 };
  82
  83 typedef struct {
  84         uint32_t         ino;           /* inode number used on target fs */
  85         uint32_t         nlink;         /* number of links to this entry */
  86         enum fi_flags    flags;         /* flags used by fs specific code */
  87         struct stat      st;            /* stat entry */
  88 } fsinode;
  89
  90 typedef struct _fsnode {
  91         struct _fsnode  *parent;        /* parent (NULL if root) */
  92         struct _fsnode  *child;         /* child (if type == S_IFDIR) */
  93         struct _fsnode  *next;          /* next */
  94         struct _fsnode  *first;         /* first node of current level (".") */
  95         uint32_t         type;          /* type of entry */
  96         fsinode         *inode;         /* actual inode data */
  97         char            *symlink;       /* symlink target */
  98         char            *contents;      /* file to provide contents */
  99         const char      *root;          /* root path */
 100         char            *path;          /* directory name */
 101         char            *name;          /* file name */
 102         int             flags;          /* misc flags */
 103 } fsnode;
 104
 105 #define FSNODE_F_HASSPEC        0x01    /* fsnode has a spec entry */
 106 #define FSNODE_F_OPTIONAL       0x02    /* fsnode is optional */
 107
 108 /*
 109  * fsinfo_t - contains various settings and parameters pertaining to
 110  * the image, including current settings, global options, and fs
 111  * specific options
 112  */
 113 typedef struct {
 114                 /* current settings */
 115         off_t   size;           /* total size */
 116         off_t   inodes;         /* number of inodes */
 117         uint32_t curinode;      /* current inode */
 118
 119                 /* image settings */
 120         int     fd;             /* file descriptor of image */
 121         void    *superblock;    /* superblock */
 122         int     onlyspec;       /* only add entries in specfile */
 123
 124
 125                 /* global options */
 126         off_t   minsize;        /* minimum size image should be */
 127         off_t   maxsize;        /* maximum size image can be */
 128         off_t   freefiles;      /* free file entries to leave */
 129         off_t   freeblocks;     /* free blocks to leave */
 130         off_t   roundup;        /* round image size up to this value */
 131         int     freefilepc;     /* free file % */
 132         int     freeblockpc;    /* free block % */
 133         int     needswap;       /* non-zero if byte swapping needed */
 134         int     sectorsize;     /* sector size */
 135         int     sparse;         /* sparse image, don't fill it with zeros */
 136
 137         void    *fs_specific;   /* File system specific additions. */
 138 } fsinfo_t;
 139
 140
 141 /*
 142  * option_t - contains option name, description, pointer to location to store
 143  * result, and range checks for the result. Used to simplify fs specific
 144  * option setting
 145  */
 146 typedef struct {
 147         const char      *name;          /* option name */
 148         int             *value;         /* where to stuff the value */
 149         int             minimum;        /* minimum for value */
 150         int             maximum;        /* maximum for value */
 151         const char      *desc;          /* option description */
 152 } option_t;
 153
 154
 155 void            apply_specfile(const char *, const char *, fsnode *, int);
 156 void            dump_fsnodes(fsnode *);
 157 const char *    inode_type(mode_t);
 158 fsnode *        read_mtree(const char *, fsnode *);
 159 int             set_option(option_t *, const char *, const char *);
 160 fsnode *        walk_dir(const char *, const char *, fsnode *, fsnode *);
 161 void            free_fsnodes(fsnode *);
 162
 163 void            ffs_prep_opts(fsinfo_t *);
 164 int             ffs_parse_opts(const char *, fsinfo_t *);
 165 void            ffs_cleanup_opts(fsinfo_t *);
 166 void            ffs_makefs(const char *, const char *, fsnode *, fsinfo_t *);
 167
 168 void            cd9660_prep_opts(fsinfo_t *);
 169 int             cd9660_parse_opts(const char *, fsinfo_t *);
 170 void            cd9660_cleanup_opts(fsinfo_t *);
 171 void            cd9660_makefs(const char *, const char *, fsnode *, fsinfo_t *);
 172
 173
 174 extern  u_int           debug;
 175 extern  int             dupsok;
 176 extern  struct timespec start_time;
 177 extern struct stat stampst;
 178
 179 /*
 180  * If -x is specified, we want to exclude nodes which do not appear
 181  * in the spec file.
 182  */
 183 #define FSNODE_EXCLUDE_P(opts, fsnode)  \
 184         ((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0)
 185
 186 #define DEBUG_TIME                      0x00000001
 187                 /* debug bits 1..3 unused at this time */
 188 #define DEBUG_WALK_DIR                  0x00000010
 189 #define DEBUG_WALK_DIR_NODE             0x00000020
 190 #define DEBUG_WALK_DIR_LINKCHECK        0x00000040
 191 #define DEBUG_DUMP_FSNODES              0x00000080
 192 #define DEBUG_DUMP_FSNODES_VERBOSE      0x00000100
 193 #define DEBUG_FS_PARSE_OPTS             0x00000200
 194 #define DEBUG_FS_MAKEFS                 0x00000400
 195 #define DEBUG_FS_VALIDATE               0x00000800
 196 #define DEBUG_FS_CREATE_IMAGE           0x00001000
 197 #define DEBUG_FS_SIZE_DIR               0x00002000
 198 #define DEBUG_FS_SIZE_DIR_NODE          0x00004000
 199 #define DEBUG_FS_SIZE_DIR_ADD_DIRENT    0x00008000
 200 #define DEBUG_FS_POPULATE               0x00010000
 201 #define DEBUG_FS_POPULATE_DIRBUF        0x00020000
 202 #define DEBUG_FS_POPULATE_NODE          0x00040000
 203 #define DEBUG_FS_WRITE_FILE             0x00080000
 204 #define DEBUG_FS_WRITE_FILE_BLOCK       0x00100000
 205 #define DEBUG_FS_MAKE_DIRBUF            0x00200000
 206 #define DEBUG_FS_WRITE_INODE            0x00400000
 207 #define DEBUG_BUF_BREAD                 0x00800000
 208 #define DEBUG_BUF_BWRITE                0x01000000
 209 #define DEBUG_BUF_GETBLK                0x02000000
 210 #define DEBUG_APPLY_SPECFILE            0x04000000
 211 #define DEBUG_APPLY_SPECENTRY           0x08000000
 212 #define DEBUG_APPLY_SPECONLY            0x10000000
 213
 214
 215 #define TIMER_START(x)                          \
 216         if (debug & DEBUG_TIME)                 \
 217                 gettimeofday(&(x), NULL)
 218
 219 #define TIMER_RESULTS(x,d)                              \
 220         if (debug & DEBUG_TIME) {                       \
 221                 struct timeval end, td;                 \
 222                 gettimeofday(&end, NULL);               \
 223                 timersub(&end, &(x), &td);              \
 224                 printf("%s took %lld.%06ld seconds\n",  \
 225                     (d), (long long)td.tv_sec,          \
 226                     (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
 284 struct fs;
 285 void   ffs_fragacct_swap(struct fs *, int, int32_t [], int, int);
 286
 287 fsinode *link_check(fsinode *);
 288
 289 #endif  /* _MAKEFS_H */