root/usr.sbin/makefs/makefs.h
/*      $OpenBSD: makefs.h,v 1.13 2021/10/06 00:40:39 deraadt Exp $     */
/*      $NetBSD: makefs.h,v 1.36 2015/11/25 00:48:49 christos Exp $     */

/*
 * Copyright (c) 2001 Wasabi Systems, Inc.
 * All rights reserved.
 *
 * Written by Luke Mewburn for Wasabi Systems, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed for the NetBSD Project by
 *      Wasabi Systems, Inc.
 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
 *    or promote products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _MAKEFS_H
#define _MAKEFS_H

#include <sys/stat.h>
#include <err.h>

/*
 * fsnode -
 *      a component of the tree; contains a filename, a pointer to
 *      fsinode, optional symlink name, and tree pointers
 *
 * fsinode -
 *      equivalent to an inode, containing target file system inode number,
 *      refcount (nlink), and stat buffer
 *
 * A tree of fsnodes looks like this:
 *
 *      name    "."             "bin"           "netbsd"
 *      type    S_IFDIR         S_IFDIR         S_IFREG
 *      next      >               >             NULL
 *      parent  NULL            NULL            NULL
 *      child   NULL              v
 *
 *      name                    "."             "ls"
 *      type                    S_IFDIR         S_IFREG
 *      next                      >             NULL
 *      parent                    ^             ^ (to "bin")
 *      child                   NULL            NULL
 *
 * Notes:
 *      -   first always points to first entry, at current level, which
 *          must be "." when the tree has been built; during build it may
 *          not be if "." hasn't yet been found by readdir(2).
 */

enum fi_flags {
        FI_SIZED =      1<<0,           /* inode sized */
        FI_ALLOCATED =  1<<1,           /* fsinode->ino allocated */
        FI_WRITTEN =    1<<2,           /* inode written */
};

typedef struct {
        uint32_t         ino;           /* inode number used on target fs */
        uint32_t         nlink;         /* number of links to this entry */
        enum fi_flags    flags;         /* flags used by fs specific code */
        struct stat      st;            /* stat entry */
        void            *fsuse;         /* for storing FS dependent info */
} fsinode;

typedef struct _fsnode {
        struct _fsnode  *parent;        /* parent (NULL if root) */
        struct _fsnode  *child;         /* child (if type == S_IFDIR) */
        struct _fsnode  *next;          /* next */
        struct _fsnode  *first;         /* first node of current level (".") */
        uint32_t         type;          /* type of entry */
        fsinode         *inode;         /* actual inode data */
        char            *symlink;       /* symlink target */
        const char      *root;          /* root path */
        char            *path;          /* directory name */
        char            *name;          /* file name */
        int             flags;          /* misc flags */
} fsnode;

#define FSNODE_F_HASSPEC        0x01    /* fsnode has a spec entry */

/*
 * option_t - contains option name, description, pointer to location to store
 * result, and range checks for the result. Used to simplify fs specific
 * option setting
 */
typedef enum {
        OPT_STRARRAY,
        OPT_STRPTR,
        OPT_STRBUF,
        OPT_BOOL,
        OPT_INT8,
        OPT_INT16,
        OPT_INT32,
        OPT_INT64
} opttype_t;

typedef struct {
        const char      *name;          /* option name */
        void            *value;         /* where to stuff the value */
        opttype_t       type;           /* type of entry */
        long long       minimum;        /* minimum for value */
        long long       maximum;        /* maximum for value */
} option_t;

/*
 * fsinfo_t - contains various settings and parameters pertaining to
 * the image, including current settings, global options, and fs
 * specific options
 */
typedef struct makefs_fsinfo {
                /* current settings */
        off_t   size;           /* total size */
        off_t   inodes;         /* number of inodes */
        uint32_t curinode;      /* current inode */

                /* image settings */
        int     fd;             /* file descriptor of image */
        void    *superblock;    /* superblock */

                /* global options */
        off_t   minsize;        /* minimum size image should be */
        off_t   maxsize;        /* maximum size image can be */
        off_t   freefiles;      /* free file entries to leave */
        off_t   freeblocks;     /* free blocks to leave */
        off_t   offset;         /* offset from start of file */
        int     freefilepc;     /* free file % */
        int     freeblockpc;    /* free block % */
        int     sectorsize;     /* sector size */

        void    *fs_specific;   /* File system specific additions. */
        option_t *fs_options;   /* File system specific options */
} fsinfo_t;




const char *    inode_type(mode_t);
int             set_option(const option_t *, const char *, char *, size_t);
int             set_option_var(const option_t *, const char *, const char *,
    char *, size_t);
fsnode *        walk_dir(const char *, const char *, fsnode *, fsnode *);
void            free_fsnodes(fsnode *);
option_t *      copy_opts(const option_t *);

#define DECLARE_FUN(fs)                                                 \
void            fs ## _prep_opts(fsinfo_t *);                           \
int             fs ## _parse_opts(const char *, fsinfo_t *);            \
void            fs ## _cleanup_opts(fsinfo_t *);                        \
void            fs ## _makefs(const char *, const char *, fsnode *, fsinfo_t *)

DECLARE_FUN(ffs);
DECLARE_FUN(cd9660);
DECLARE_FUN(msdos);

extern  int Tflag;
extern  time_t stampts;
extern  struct timespec start_time;


#ifndef DEFAULT_FSTYPE
#define DEFAULT_FSTYPE  "ffs"
#endif

#define MINIMUM(a, b)   (((a) < (b)) ? (a) : (b))
#define MAXIMUM(a, b)   (((a) > (b)) ? (a) : (b))

/* xmalloc.c */
void    *emalloc(size_t);
void    *ecalloc(size_t, size_t);
void    *erealloc(void *, size_t);
char    *estrdup(const char *);

#endif  /* _MAKEFS_H */