root/usr.sbin/makefs/makefs.c
/*      $NetBSD: makefs.c,v 1.26 2006/10/22 21:11:56 christos Exp $     */

/*-
 * SPDX-License-Identifier: BSD-4-Clause
 *
 * Copyright (c) 2001-2003 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.
 */

#include <sys/types.h>
#include <sys/stat.h>
#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <limits.h>
#include <locale.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include <stdbool.h>
#include <util.h>

#include "makefs.h"
#include "mtree.h"

/*
 * list of supported file systems and dispatch functions
 */
typedef struct {
        const char      *type;
        void            (*prepare_options)(fsinfo_t *);
        int             (*parse_options)(const char *, fsinfo_t *);
        void            (*cleanup_options)(fsinfo_t *);
        void            (*make_fs)(const char *, const char *, fsnode *,
                                fsinfo_t *);
} fstype_t;

static fstype_t fstypes[] = {
#define ENTRY(name) { \
        # name, name ## _prep_opts, name ## _parse_opts, \
        name ## _cleanup_opts, name ## _makefs  \
}
        ENTRY(cd9660),
        ENTRY(ffs),
        ENTRY(msdos),
#ifdef HAVE_ZFS
        ENTRY(zfs),
#endif
        { .type = NULL  },
};

u_int           debug;
int             dupsok;
struct timespec start_time;
struct stat stampst;

static  fstype_t *get_fstype(const char *);
static int get_tstamp(const char *, struct stat *);
static  void    usage(fstype_t *, fsinfo_t *);

int
main(int argc, char *argv[])
{
        struct stat      sb;
        struct timeval   start;
        fstype_t        *fstype;
        fsinfo_t         fsoptions;
        fsnode          *root;
        int              ch, i, len;
        const char      *subtree;
        const char      *specfile;

        setprogname(argv[0]);

        /*
         * Set the locale for collation, so that directory entry sorting is
         * consistent.
         */
        if (setlocale(LC_COLLATE, "C") == NULL)
                err(1, "setlocale");

        debug = 0;
        if ((fstype = get_fstype(DEFAULT_FSTYPE)) == NULL)
                errx(1, "Unknown default fs type `%s'.", DEFAULT_FSTYPE);

                /* set default fsoptions */
        (void)memset(&fsoptions, 0, sizeof(fsoptions));
        fsoptions.fd = -1;
        fsoptions.sectorsize = -1;

        if (fstype->prepare_options)
                fstype->prepare_options(&fsoptions);

        specfile = NULL;
#ifdef CLOCK_REALTIME
        ch = clock_gettime(CLOCK_REALTIME, &start_time);
#else
        ch = gettimeofday(&start, NULL);
        start_time.tv_sec = start.tv_sec;
        start_time.tv_nsec = start.tv_usec * 1000;
#endif
        if (ch == -1)
                err(1, "Unable to get system time");


        while ((ch = getopt(argc, argv, "B:b:Dd:f:F:M:m:N:O:o:pR:s:S:t:T:xZ")) != -1) {
                switch (ch) {

                case 'B':
                        if (strcmp(optarg, "be") == 0 ||
                            strcmp(optarg, "4321") == 0 ||
                            strcmp(optarg, "big") == 0) {
#if BYTE_ORDER == LITTLE_ENDIAN
                                fsoptions.needswap = 1;
#endif
                        } else if (strcmp(optarg, "le") == 0 ||
                            strcmp(optarg, "1234") == 0 ||
                            strcmp(optarg, "little") == 0) {
#if BYTE_ORDER == BIG_ENDIAN
                                fsoptions.needswap = 1;
#endif
                        } else {
                                warnx("Invalid endian `%s'.", optarg);
                                usage(fstype, &fsoptions);
                        }
                        break;

                case 'b':
                        len = strlen(optarg) - 1;
                        if (optarg[len] == '%') {
                                optarg[len] = '\0';
                                fsoptions.freeblockpc =
                                    strsuftoll("free block percentage",
                                        optarg, 0, 99);
                        } else {
                                fsoptions.freeblocks =
                                    strsuftoll("free blocks",
                                        optarg, 0, LLONG_MAX);
                        }
                        break;

                case 'D':
                        dupsok++;
                        break;

                case 'd':
                        debug = strtoll(optarg, NULL, 0);
                        break;

                case 'f':
                        len = strlen(optarg) - 1;
                        if (optarg[len] == '%') {
                                optarg[len] = '\0';
                                fsoptions.freefilepc =
                                    strsuftoll("free file percentage",
                                        optarg, 0, 99);
                        } else {
                                fsoptions.freefiles =
                                    strsuftoll("free files",
                                        optarg, 0, LLONG_MAX);
                        }
                        break;

                case 'F':
                        specfile = optarg;
                        break;

                case 'M':
                        fsoptions.minsize =
                            strsuftoll("minimum size", optarg, 1LL, LLONG_MAX);
                        break;

                case 'N':
                        if (! setup_getid(optarg))
                                errx(1,
                            "Unable to use user and group databases in `%s'",
                                    optarg);
                        break;

                case 'm':
                        fsoptions.maxsize =
                            strsuftoll("maximum size", optarg, 1LL, LLONG_MAX);
                        break;

                case 'O':
                        fsoptions.offset =
                            strsuftoll("offset", optarg, 0LL, LLONG_MAX);
                        break;

                case 'o':
                {
                        char *p;

                        while ((p = strsep(&optarg, ",")) != NULL) {
                                if (*p == '\0')
                                        errx(1, "Empty option");
                                if (! fstype->parse_options(p, &fsoptions))
                                        usage(fstype, &fsoptions);
                        }
                        break;
                }
                case 'p':
                        /* Deprecated in favor of 'Z' */
                        fsoptions.sparse = 1;
                        break;

                case 'R':
                        /* Round image size up to specified block size */
                        fsoptions.roundup =
                            strsuftoll("roundup-size", optarg, 0, LLONG_MAX);
                        break;

                case 's':
                        fsoptions.minsize = fsoptions.maxsize =
                            strsuftoll("size", optarg, 1LL, LLONG_MAX);
                        break;

                case 'S':
                        fsoptions.sectorsize =
                            (int)strsuftoll("sector size", optarg,
                                1LL, INT_MAX);
                        break;

                case 't':
                        /* Check current one and cleanup if necessary. */
                        if (fstype->cleanup_options)
                                fstype->cleanup_options(&fsoptions);
                        fsoptions.fs_specific = NULL;
                        if ((fstype = get_fstype(optarg)) == NULL)
                                errx(1, "Unknown fs type `%s'.", optarg);
                        fstype->prepare_options(&fsoptions);
                        break;

                case 'T':
                        if (get_tstamp(optarg, &stampst) == -1)
                                errx(1, "Cannot get timestamp from `%s'",
                                    optarg);
                        break;

                case 'x':
                        fsoptions.onlyspec = 1;
                        break;

                case 'Z':
                        /* Superscedes 'p' for compatibility with NetBSD makefs(8) */
                        fsoptions.sparse = 1;
                        break;

                default:
                        usage(fstype, &fsoptions);
                        /* NOTREACHED */

                }
        }
        if (debug) {
                printf("debug mask: 0x%08x\n", debug);
                printf("start time: %ld.%ld, %s",
                    (long)start_time.tv_sec, (long)start_time.tv_nsec,
                    ctime(&start_time.tv_sec));
        }
        argc -= optind;
        argv += optind;

        if (argc < 2)
                usage(fstype, &fsoptions);

        /* -x must be accompanied by -F */
        if (fsoptions.onlyspec != 0 && specfile == NULL)
                errx(1, "-x requires -F mtree-specfile.");

        /* Accept '-' as meaning "read from standard input". */
        if (strcmp(argv[1], "-") == 0)
                sb.st_mode = S_IFREG;
        else {
                if (stat(argv[1], &sb) == -1)
                        err(1, "Can't stat `%s'", argv[1]);
        }

        switch (sb.st_mode & S_IFMT) {
        case S_IFDIR:           /* walk the tree */
                subtree = argv[1];
                TIMER_START(start);
                root = walk_dir(subtree, ".", NULL, NULL);
                TIMER_RESULTS(start, "walk_dir");
                break;
        case S_IFREG:           /* read the manifest file */
                subtree = ".";
                TIMER_START(start);
                root = read_mtree(argv[1], NULL);
                TIMER_RESULTS(start, "manifest");
                break;
        default:
                errx(1, "%s: not a file or directory", argv[1]);
                /* NOTREACHED */
        }

        /* append extra directory */
        for (i = 2; i < argc; i++) {
                if (stat(argv[i], &sb) == -1)
                        err(1, "Can't stat `%s'", argv[i]);
                if (!S_ISDIR(sb.st_mode))
                        errx(1, "%s: not a directory", argv[i]);
                TIMER_START(start);
                root = walk_dir(argv[i], ".", NULL, root);
                TIMER_RESULTS(start, "walk_dir2");
        }

        if (specfile) {         /* apply a specfile */
                TIMER_START(start);
                apply_specfile(specfile, subtree, root, fsoptions.onlyspec);
                TIMER_RESULTS(start, "apply_specfile");
        }

        if (debug & DEBUG_DUMP_FSNODES) {
                printf("\nparent: %s\n", subtree);
                dump_fsnodes(root);
                putchar('\n');
        }

                                /* build the file system */
        TIMER_START(start);
        fstype->make_fs(argv[0], subtree, root, &fsoptions);
        TIMER_RESULTS(start, "make_fs");

        free_fsnodes(root);

        exit(0);
        /* NOTREACHED */
}

int
set_option(const option_t *options, const char *option, char *buf, size_t len)
{
        char *var, *val;
        int retval;

        assert(option != NULL);

        var = estrdup(option);
        for (val = var; *val; val++)
                if (*val == '=') {
                        *val++ = '\0';
                        break;
                }
        retval = set_option_var(options, var, val, buf, len);
        free(var);
        return retval;
}

int
set_option_var(const option_t *options, const char *var, const char *val,
    char *buf, size_t len)
{
        char *s;
        size_t i;

#define NUM(type) \
        if (!*val) { \
                *(type *)options[i].value = 1; \
                break; \
        } \
        *(type *)options[i].value = (type)strsuftoll(options[i].desc, val, \
            options[i].minimum, options[i].maximum); break

        for (i = 0; options[i].name != NULL; i++) {
                if (var[1] == '\0') {
                        if (options[i].letter != var[0])
                                continue;
                } else if (strcmp(options[i].name, var) != 0)
                        continue;
                switch (options[i].type) {
                case OPT_BOOL:
                        *(bool *)options[i].value = 1;
                        break;
                case OPT_STRARRAY:
                        strlcpy((void *)options[i].value, val, (size_t)
                            options[i].maximum);
                        break;
                case OPT_STRPTR:
                        s = estrdup(val);
                        *(char **)options[i].value = s;
                        break;
                case OPT_STRBUF:
                        if (buf == NULL)
                                abort();
                        strlcpy(buf, val, len);
                        break;
                case OPT_INT64:
                        NUM(uint64_t);
                case OPT_INT32:
                        NUM(uint32_t);
                case OPT_INT16:
                        NUM(uint16_t);
                case OPT_INT8:
                        NUM(uint8_t);
                default:
                        warnx("Unknown type %d in option %s", options[i].type,
                            val);
                        return 0;
                }
                return i;
        }
        warnx("Unknown option `%s'", var);
        return -1;
}

void
set_tstamp(fsnode *cur)
{
        cur->inode->st.st_atime = stampst.st_atime;
        cur->inode->st.st_mtime = stampst.st_mtime;
        cur->inode->st.st_ctime = stampst.st_ctime;
#if HAVE_STRUCT_STAT_ST_MTIMENSEC
        cur->inode->st.st_atimensec = stampst.st_atimensec;
        cur->inode->st.st_mtimensec = stampst.st_mtimensec;
        cur->inode->st.st_ctimensec = stampst.st_ctimensec;
#endif
#if HAVE_STRUCT_STAT_BIRTHTIME
        cur->inode->st.st_birthtime = stampst.st_birthtime;
        cur->inode->st.st_birthtimensec = stampst.st_birthtimensec;
#endif
}

static fstype_t *
get_fstype(const char *type)
{
        int i;
        
        for (i = 0; fstypes[i].type != NULL; i++)
                if (strcmp(fstypes[i].type, type) == 0)
                        return (&fstypes[i]);
        return (NULL);
}

option_t *
copy_opts(const option_t *o)
{
        size_t i;

        for (i = 0; o[i].name; i++)
                continue;
        i++;
        return memcpy(ecalloc(i, sizeof(*o)), o, i * sizeof(*o));
}

static int
get_tstamp(const char *b, struct stat *st)
{
        time_t when;
        char *eb;
        long long l;

        if (stat(b, st) != -1)
                return 0;

        {
                errno = 0;
                l = strtoll(b, &eb, 0);
                if (b == eb || *eb || errno)
                        return -1;
                when = (time_t)l;
        }

        st->st_ino = 1;
#if HAVE_STRUCT_STAT_BIRTHTIME
        st->st_birthtime =
#endif
        st->st_mtime = st->st_ctime = st->st_atime = when;
        return 0;
}

static void
usage(fstype_t *fstype, fsinfo_t *fsoptions)
{
        const char *prog;

        prog = getprogname();
        fprintf(stderr,
"Usage: %s [-xZ] [-B endian] [-b free-blocks] [-d debug-mask]\n"
"\t[-F mtree-specfile] [-f free-files] [-M minimum-size] [-m maximum-size]\n"
"\t[-N userdb-dir] [-O offset] [-o fs-options] [-R roundup-size]\n"
"\t[-S sector-size] [-s image-size] [-T <timestamp/file>] [-t fs-type]\n"
"\timage-file directory | manifest [extra-directory ...]\n",
            prog);

        if (fstype) {
                size_t i;
                option_t *o = fsoptions->fs_options;

                fprintf(stderr, "\n%s specific options:\n", fstype->type);
                for (i = 0; o[i].name != NULL; i++)
                        fprintf(stderr, "\t%c%c%20.20s\t%s\n",
                            o[i].letter ? o[i].letter : ' ',
                            o[i].letter ? ',' : ' ',
                            o[i].name, o[i].desc);
        }
        exit(1);
}