root/sbin/newfs_ext2fs/newfs_ext2fs.c
/*      $NetBSD: newfs_ext2fs.c,v 1.13 2026/05/03 17:49:58 kre Exp $    */

/*
 * Copyright (c) 1983, 1989, 1993, 1994
 *      The Regents of the University of California.  All rights reserved.
 *
 * 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. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 THE REGENTS OR CONTRIBUTORS 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/cdefs.h>
#ifndef lint
__COPYRIGHT("@(#) Copyright (c) 1983, 1989, 1993, 1994\
 The Regents of the University of California.  All rights reserved.");
#endif /* not lint */

#ifndef lint
#if 0
static char sccsid[] = "@(#)newfs.c     8.13 (Berkeley) 5/1/95";
#else
__RCSID("$NetBSD: newfs_ext2fs.c,v 1.13 2026/05/03 17:49:58 kre Exp $");
#endif
#endif /* not lint */

/*
 * newfs: friendly front end to mke2fs
 */
#include <sys/param.h>
#include <sys/ioctl.h>
#include <sys/disklabel.h>
#include <sys/disk.h>
#include <sys/file.h>
#include <sys/mount.h>

#include <ufs/ext2fs/ext2fs.h>
#include <ufs/ext2fs/ext2fs_dinode.h>

#include <disktab.h>
#include <err.h>
#include <errno.h>
#include <limits.h>
#include <paths.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <util.h>
#include <mntopts.h>

#include "extern.h"
#include "partutil.h"

static int64_t strsuftoi64(const char *, const char *, int64_t, int64_t, int *);
static void usage(void) __dead;

/*
 * For file systems smaller than SMALL_FSSIZE we use the S_DFL_* defaults,
 * otherwise if less than MEDIUM_FSSIZE use M_DFL_*, otherwise use
 * L_DFL_*.
 */
#define SMALL_FSSIZE    ((4 * 1024 * 1024) / sectorsize)        /* 4MB */
#define S_DFL_BSIZE     1024
#define MEDIUM_FSSIZE   ((512 * 1024 * 1024) / sectorsize)      /* 512MB */
#define M_DFL_BSIZE     1024
#define L_DFL_BSIZE     4096

/*
 * Each file system has a number of inodes statically allocated.
 * We allocate one inode slot per 2, 4, or 8 blocks, expecting this
 * to be far more than we will ever need.
 */
#define S_DFL_NINODE(blocks)    ((blocks) / 8)
#define M_DFL_NINODE(blocks)    ((blocks) / 4)
#define L_DFL_NINODE(blocks)    ((blocks) / 2)

/*
 * Default sector size.
 */
#define DFL_SECSIZE     512

int     Nflag;                  /* run without writing file system */
int     Oflag = 1;              /* format as REV1 by default */
int     verbosity;              /* amount of printf() output */
#define DEFAULT_VERBOSITY 3     /* 4 is traditional behavior of newfs(8) */
int64_t fssize;                 /* file system size */
uint    sectorsize;             /* bytes/sector */
uint16_t inodesize = EXT2_REV0_DINODE_SIZE;     /* inode size */
uint    fsize = 0;              /* fragment size */
uint    bsize = 0;              /* block size */
uint    minfree = MINFREE;      /* free space threshold */
uint    density;                /* number of bytes per inode */
uint    num_inodes;             /* number of inodes (overrides density) */
char    *volname = NULL;        /* volume name */

static char *disktype = NULL;
static char device[MAXPATHLEN];

static const char lmsg[] = "%s: can't read disk label";

int
main(int argc, char *argv[])
{
        struct disk_geom geo;
        struct dkwedge_info dkw;
        struct statvfs *mp;
        struct stat sb;
        int ch, fsi, fso, len, n, Fflag, Iflag, Zflag;
        const char *s1, *special;
        char *s2;
        const char *opstring;
        int byte_sized;
        uint blocks;                    /* number of blocks */

        fsi = fso = -1;
        Fflag = Iflag = Zflag = 0;
        verbosity = -1;
        opstring = "D:FINO:S:V:Zb:f:i:l:m:n:s:v:";
        byte_sized = 0;
        while ((ch = getopt(argc, argv, opstring)) != -1)
                switch (ch) {
                case 'D':
                        inodesize = (uint16_t)strtol(optarg, &s2, 0);
                        if (*s2 || (inodesize != 128 && inodesize != 256))
                                errx(1, "Bad inode size %d "
                                    "(only 128 and 256 supported)", inodesize);
                        break;
                case 'F':
                        Fflag = 1;
                        break;
                case 'I':
                        Iflag = 1;
                        break;
                case 'N':
                        Nflag = 1;
                        if (verbosity == -1)
                                verbosity = DEFAULT_VERBOSITY;
                        break;
                case 'O':
                        Oflag = strsuftoi64("format", optarg, 0, 1, NULL);
                        break;
                case 'S':
                        /*
                         * XXX:
                         * non-512 byte sectors almost certainly don't work.
                         */
                        sectorsize = strsuftoi64("sector size",
                            optarg, 512, 65536, NULL);
                        if (!powerof2(sectorsize))
                                errx(EXIT_FAILURE,
                                    "sector size `%s' is not a power of 2.",
                                    optarg);
                        break;
                case 'V':
                        verbosity = strsuftoi64("verbose", optarg, 0, 4, NULL);
                        break;
                case 'Z':
                        Zflag = 1;
                        break;
                case 'b':
                        bsize = strsuftoi64("block size",
                            optarg, MINBSIZE, EXT2_MAXBSIZE, NULL);
                        break;
                case 'f':
                        fsize = strsuftoi64("fragment size",
                            optarg, MINBSIZE, EXT2_MAXBSIZE, NULL);
                        break;
                case 'i':
                        density = strsuftoi64("bytes per inode",
                            optarg, 1, INT_MAX, NULL);
                        break;
                case 'm':
                        minfree = strsuftoi64("free space %",
                            optarg, 0, 99, NULL);
                        break;
                case 'n':
                        num_inodes = strsuftoi64("number of inodes",
                            optarg, 1, INT_MAX, NULL);
                        break;
                case 's':
                        fssize = strsuftoi64("file system size",
                            optarg, INT64_MIN, INT64_MAX, &byte_sized);
                        break;
                case 'v':
                        volname = optarg;
                        if (volname[0] == '\0')
                                errx(EXIT_FAILURE,
                                    "Volume name cannot be zero length");
                        break;
                case '?':
                default:
                        usage();
                }
        argc -= optind;
        argv += optind;

        if (verbosity == -1)
                /* Default to showing cg info */
                verbosity = DEFAULT_VERBOSITY;

        if (argc != 1)
                usage();

        memset(&sb, 0, sizeof(sb));
        memset(&dkw, 0, sizeof(dkw));
        special = argv[0];
        if (Fflag) {
                int fl;
                /*
                 * It's a file system image
                 * no label, use fixed default for sectorsize.
                 */
                if (sectorsize == 0)
                        sectorsize = DFL_SECSIZE;

                /* creating image in a regular file */
                if (Nflag)
                        fl = O_RDONLY;
                else {
                        if (fssize > 0)
                                fl = O_RDWR | O_CREAT;
                        else
                                fl = O_RDWR;
                }
                fsi = open(special, fl, 0777);
                if (fsi == -1)
                        err(EXIT_FAILURE, "can't open file %s", special);
                if (fstat(fsi, &sb) == -1)
                        err(EXIT_FAILURE, "can't fstat opened %s", special);
                if (!Nflag)
                        fso = fsi;
        } else {        /* !Fflag */
                special = findspecial(special, 1);
                fsi = opendisk(special, O_RDONLY, device, sizeof(device), 0);
                special = device;
                if (fsi < 0 || fstat(fsi, &sb) == -1)
                        err(EXIT_FAILURE, "%s: open for read", special);

                if (!Nflag) {
                        fso = open(special, O_WRONLY, 0);
                        if (fso < 0)
                                err(EXIT_FAILURE,
                                    "%s: open for write", special);

                        /* Bail if target special is mounted */
                        n = getmntinfo(&mp, MNT_NOWAIT);
                        if (n == 0)
                                err(EXIT_FAILURE, "%s: getmntinfo", special);

                        len = sizeof(_PATH_DEV) - 1;
                        s1 = special;
                        if (strncmp(_PATH_DEV, s1, len) == 0)
                                s1 += len;

                        while (--n >= 0) {
                                s2 = mp->f_mntfromname;
                                if (strncmp(_PATH_DEV, s2, len) == 0) {
                                        s2 += len - 1;
                                        *s2 = 'r';
                                }
                                if (strcmp(s1, s2) == 0 ||
                                    strcmp(s1, &s2[1]) == 0)
                                        errx(EXIT_FAILURE,
                                            "%s is mounted on %s",
                                            special, mp->f_mntonname);
                                ++mp;
                        }
                }

                if (getdiskinfo(special, fsi, disktype, &geo, &dkw) == -1)
                        errx(EXIT_FAILURE, lmsg, special);

                if (sectorsize == 0) {
                        sectorsize = geo.dg_secsize;
                        if (sectorsize <= 0)
                                errx(EXIT_FAILURE, "no default sector size");
                }

                if (dkw.dkw_parent[0]) {
                        if (dkw.dkw_size == 0)
                                errx(EXIT_FAILURE,
                                    "%s partition is unavailable", special);

                        if (!Iflag) {
                                static const char m[] =
                                    "%s partition type is not `%s' (or use -I)";
                                if (strcmp(dkw.dkw_ptype, DKW_PTYPE_EXT2FS))
                                        errx(EXIT_FAILURE, m,
                                            special, "Linux Ext2");
                        }
                }
        }

        if (byte_sized)
                fssize /= sectorsize;
        if (fssize <= 0) {
                if (sb.st_size != 0)
                        fssize += sb.st_size / sectorsize;
                else
                        fssize += dkw.dkw_size;
                if (fssize <= 0)
                        errx(EXIT_FAILURE,
                            "Unable to determine file system size");
        }

        if (dkw.dkw_parent[0] && fssize > dkw.dkw_size)
                errx(EXIT_FAILURE,
                    "size %" PRIu64 " exceeds maximum file system size on "
                    "`%s' of %" PRIu64 " sectors",
                    fssize, special, dkw.dkw_size);

        /* XXXLUKEM: only ftruncate() regular files ? (dsl: or at all?) */
        if (Fflag && fso != -1
            && ftruncate(fso, (off_t)fssize * sectorsize) == -1)
                err(1, "can't ftruncate %s to %" PRId64, special, fssize);

        if (Zflag && fso != -1) {       /* pre-zero (and de-sparse) the file */
                char *buf;
                int bufsize, i;
                off_t bufrem;
                struct statvfs sfs;

                if (fstatvfs(fso, &sfs) == -1) {
                        warn("can't fstatvfs `%s'", special);
                        bufsize = 8192;
                } else
                        bufsize = sfs.f_iosize;

                if ((buf = calloc(1, bufsize)) == NULL)
                        err(1, "can't malloc buffer of %d",
                        bufsize);
                bufrem = fssize * sectorsize;
                if (verbosity > 0)
                        printf("Creating file system image in `%s', "
                            "size %" PRId64 " bytes, in %d byte chunks.\n",
                            special, bufrem, bufsize);
                while (bufrem > 0) {
                        i = write(fso, buf, MIN(bufsize, bufrem));
                        if (i == -1)
                                err(1, "writing image");
                        bufrem -= i;
                }
                free(buf);
        }

        /* Sort out fragment and block sizes */
        if (bsize == 0) {
                bsize = fsize;
                if (bsize == 0) {
                        if (fssize < SMALL_FSSIZE)
                                bsize = S_DFL_BSIZE;
                        else if (fssize < MEDIUM_FSSIZE)
                                bsize = M_DFL_BSIZE;
                        else
                                bsize = L_DFL_BSIZE;
                }
        }
        if (fsize == 0)
                fsize = bsize;

        blocks = fssize * sectorsize / bsize;

        if (num_inodes == 0) {
                if (density != 0)
                        num_inodes = fssize / density;
                else {
                        if (fssize < SMALL_FSSIZE)
                                num_inodes = S_DFL_NINODE(blocks);
                        else if (fssize < MEDIUM_FSSIZE)
                                num_inodes = M_DFL_NINODE(blocks);
                        else
                                num_inodes = L_DFL_NINODE(blocks);
                }
        }
        mke2fs(special, fsi, fso);

        if (fsi != -1)
                close(fsi);
        if (fso != -1 && fso != fsi)
                close(fso);
        exit(EXIT_SUCCESS);
}

static int64_t
strsuftoi64(const char *desc, const char *arg, int64_t min, int64_t max,
    int *num_suffix)
{
        int64_t result, r1;
        int shift = 0;
        char *ep;

        errno = 0;
        r1 = strtoll(arg, &ep, 10);
        if (ep[0] != '\0' && ep[1] != '\0')
                errx(EXIT_FAILURE,
                    "%s `%s' is not a valid number.", desc, arg);
        switch (ep[0]) {
        case '\0':
        case 's':
        case 'S':
                if (num_suffix != NULL)
                        *num_suffix = 0;
                break;
        case 'g':
        case 'G':
                shift += 10;
                /* FALLTHROUGH */
        case 'm':
        case 'M':
                shift += 10;
                /* FALLTHROUGH */
        case 'k':
        case 'K':
                shift += 10;
                /* FALLTHROUGH */
        case 'b':
        case 'B':
                if (num_suffix != NULL)
                        *num_suffix = 1;
                break;
        default:
                errx(EXIT_FAILURE,
                    "`%s' is not a valid suffix for %s.", ep, desc);
        }
        result = r1 << shift;
        if (errno == ERANGE || result >> shift != r1)
                errx(EXIT_FAILURE,
                    "%s `%s' is too large to convert.", desc, arg);
        if (result < min)
                errx(EXIT_FAILURE,
                    "%s `%s' (%" PRId64 ") is less than the minimum (%"
                    PRId64 ").", desc, arg, result, min);
        if (result > max)
                errx(EXIT_FAILURE,
                    "%s `%s' (%" PRId64 ") is greater than the maximum (%"
                    PRId64 ").", desc, arg, result, max);
        return result;
}

static const char help_strings[] =
        "\t-b bsize\tblock size\n"
        "\t-D inodesize\tsize of an inode in bytes (128 or 256)\n"
        "\t-F \t\tcreate file system image in regular file\n"
        "\t-f fsize\tfragment size\n"
        "\t-I \t\tdo not check that the file system type is `Linux Ext2'\n"
        "\t-i density\tnumber of bytes per inode\n"
        "\t-m minfree\tminimum free space %\n"
        "\t-N \t\tdo not create file system, just print out parameters\n"
        "\t-n inodes\tnumber of inodes (overrides -i density)\n"
        "\t-O N\t\tfilesystem revision: 0 ==> REV0, 1 ==> REV1 (default 0)\n"
        "\t-S secsize\tsector size\n"
        "\t-s fssize\tfile system size (sectors)\n"
        "\t-V verbose\toutput verbosity: 0 ==> none, 4 ==> max\n"
        "\t-v volname\text2fs volume name\n"
        "\t-Z \t\tpre-zero the image file\n";

static void
usage(void)
{

        fprintf(stderr,
            "usage: %s [ fsoptions ] special-device\n", getprogname());
        fprintf(stderr, "where fsoptions are:\n");
        fprintf(stderr, "%s", help_strings);

        exit(EXIT_FAILURE);
}