root/sbin/ccdconfig/ccdconfig.c
/*
 * Copyright (c) 1995 Jason R. Thorpe.
 * 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. 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 Jason R. Thorpe.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 *
 * $NetBSD: ccdconfig.c,v 1.2.2.1 1995/11/11 02:43:35 thorpej Exp $
 * $FreeBSD: src/sbin/ccdconfig/ccdconfig.c,v 1.16.2.2 2000/12/11 01:03:25 obrien Exp $
 */

#define _KERNEL_STRUCTURES
#include <sys/param.h>
#include <sys/linker.h>
#include <sys/stat.h>
#include <sys/module.h>
#include <ctype.h>
#include <err.h>
#include <errno.h>
#include <fcntl.h>
#include <kvm.h>
#include <limits.h>
#include <paths.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include <sys/devicestat.h>
#include <sys/ccdvar.h>

#include "pathnames.h"

static  int lineno = 0;
static  int verbose = 0;
static  const char *ccdconf = _PATH_CCDCONF;

static  char *core = NULL;
static  char *kernel = NULL;

static struct flagval {
        const char      *fv_flag;
        int     fv_val;
} flagvaltab[] = {
        { "CCDF_SWAP",          CCDF_SWAP },
        { "CCDF_UNIFORM",       CCDF_UNIFORM },
        { "CCDF_MIRROR",        CCDF_MIRROR },
        { "CCDF_PARITY",        CCDF_PARITY },
        { NULL,                 0 },
};

static  struct nlist nl[] = {
        { "_ccd_softc", 0, 0, 0, 0 },
#define SYM_CCDSOFTC            0
        { "_numccd", 0, 0, 0, 0 },
#define SYM_NUMCCD              1
        { NULL , 0, 0, 0, 0 },
};

#define CCD_CONFIG              0       /* configure a device */
#define CCD_CONFIGALL           1       /* configure all devices */
#define CCD_UNCONFIG            2       /* unconfigure a device */
#define CCD_UNCONFIGALL         3       /* unconfigure all devices */
#define CCD_DUMP                4       /* dump a ccd's configuration */

static  int checkdev(char *);
static  int do_io(char *, u_long, struct ccd_ioctl *);
static  int do_single(int, char **, int);
static  int do_all(int);
static  int dump_ccd(int, char **);
static  int getmaxpartitions(void);
static  int flags_to_val(char *);
static  void print_ccd_info(struct ccd_softc *, kvm_t *);
static  char *resolve_ccdname(char *);
static  void usage(void);

int
main(int argc, char **argv)
{
        int ch, options = 0, action = CCD_CONFIG;

        while ((ch = getopt(argc, argv, "cCf:gM:N:uUv")) != -1) {
                switch (ch) {
                case 'c':
                        action = CCD_CONFIG;
                        ++options;
                        break;

                case 'C':
                        action = CCD_CONFIGALL;
                        ++options;
                        break;

                case 'f':
                        ccdconf = optarg;
                        break;

                case 'g':
                        action = CCD_DUMP;
                        break;

                case 'M':
                        core = optarg;
                        break;

                case 'N':
                        kernel = optarg;
                        break;

                case 'u':
                        action = CCD_UNCONFIG;
                        ++options;
                        break;

                case 'U':
                        action = CCD_UNCONFIGALL;
                        ++options;
                        break;

                case 'v':
                        verbose = 1;
                        break;

                default:
                        usage();
                }
        }
        argc -= optind;
        argv += optind;

        if (options > 1)
                usage();

        /*
         * Discard setgid privileges if not the running kernel so that bad
         * guys can't print interesting stuff from kernel memory.
         */
        if (core != NULL || kernel != NULL || action != CCD_DUMP) {
                setegid(getgid());
                setgid(getgid());
        }

        if (modfind("ccd") < 0) {
                /* Not present in kernel, try loading it */
                if (kldload("ccd") < 0 || modfind("ccd") < 0) {
                        warn("ccd module not available!\n"
                            "NOTE: Systems which don't have /boot as part of"
                            " the root partition\n"
                            "      (as is the case with the default HAMMER"
                            " install) need to load ccd(4)\n"
                            "      via /boot/loader.conf or compile it into"
                            " the kernel.");
                }
        }

        switch (action) {
                case CCD_CONFIG:
                case CCD_UNCONFIG:
                        exit(do_single(argc, argv, action));
                        /* NOTREACHED */

                case CCD_CONFIGALL:
                case CCD_UNCONFIGALL:
                        exit(do_all(action));
                        /* NOTREACHED */

                case CCD_DUMP:
                        exit(dump_ccd(argc, argv));
                        /* NOTREACHED */
        }
        /* NOTREACHED */
        return (0);
}

static int
do_single(int argc, char **argv, int action)
{
        struct ccd_ioctl ccio;
        char *ccd, *cp, *cp2, **disks;
        int noflags = 0, ileave, flags = 0, j;
        unsigned int i;

        bzero(&ccio, sizeof(ccio));

        /*
         * If unconfiguring, all arguments are treated as ccds.
         */
        if (action == CCD_UNCONFIG || action == CCD_UNCONFIGALL) {
                for (i = 0; argc != 0; ) {
                        cp = *argv++; --argc;
                        if ((ccd = resolve_ccdname(cp)) == NULL) {
                                warnx("invalid ccd name: %s", cp);
                                i = 1;
                                continue;
                        }
                        if (do_io(ccd, CCDIOCCLR, &ccio))
                                i = 1;
                        else
                                if (verbose)
                                        printf("%s unconfigured\n", cp);
                }
                return (i);
        }

        /* Make sure there are enough arguments. */
        if (argc < 4) {
                if (argc == 3) {
                        /* Assume that no flags are specified. */
                        noflags = 1;
                } else {
                        if (action == CCD_CONFIGALL) {
                                warnx("%s: bad line: %d", ccdconf, lineno);
                                return (1);
                        } else
                                usage();
                }
        }

        /* First argument is the ccd to configure. */
        cp = *argv++; --argc;
        if ((ccd = resolve_ccdname(cp)) == NULL) {
                warnx("invalid ccd name: %s", cp);
                return (1);
        }

        /* Next argument is the interleave factor. */
        cp = *argv++; --argc;
        errno = 0;      /* to check for ERANGE */
        ileave = (int)strtol(cp, &cp2, 10);
        if ((errno == ERANGE) || (ileave < 0) || (*cp2 != '\0')) {
                warnx("invalid interleave factor: %s", cp);
                return (1);
        }

        if (noflags == 0) {
                /* Next argument is the ccd configuration flags. */
                cp = *argv++; --argc;
                if ((flags = flags_to_val(cp)) < 0) {
                        warnx("invalid flags argument: %s", cp);
                        return (1);
                }
        }

        /* Next is the list of disks to make the ccd from. */
        disks = malloc(argc * sizeof(char *));
        if (disks == NULL) {
                warnx("no memory to configure ccd");
                return (1);
        }
        for (i = 0; argc != 0; ) {
                cp = *argv++; --argc;
                if ((j = checkdev(cp)) == 0)
                        disks[i++] = cp;
                else {
                        warnx("%s: %s", cp, strerror(j));
                        free(disks);
                        return (1);
                }
        }

        /* Fill in the ccio. */
        ccio.ccio_disks = disks;
        ccio.ccio_ndisks = i;
        ccio.ccio_ileave = ileave;
        ccio.ccio_flags = flags;

        if (do_io(ccd, CCDIOCSET, &ccio)) {
                free(disks);
                return (1);
        }

        if (verbose) {
                printf("ccd%d: %d components ", ccio.ccio_unit,
                    ccio.ccio_ndisks);
                for (i = 0; i < ccio.ccio_ndisks; ++i) {
                        if ((cp2 = strrchr(disks[i], '/')) != NULL)
                                ++cp2;
                        else
                                cp2 = disks[i];
                        printf("%c%s%c",
                            i == 0 ? '(' : ' ', cp2,
                            i == ccio.ccio_ndisks - 1 ? ')' : ',');
                }
                printf(", %ju blocks ", (uintmax_t)ccio.ccio_size);
                if (ccio.ccio_ileave != 0)
                        printf("interleaved at %d blocks\n", ccio.ccio_ileave);
                else
                        printf("concatenated\n");
        }

        free(disks);
        return (0);
}

static int
do_all(int action)
{
        FILE *f;
        char line[_POSIX2_LINE_MAX];
        char *cp, **argv;
        int argc, rval;
        gid_t egid;

        rval = 0;
        egid = getegid();
        setegid(getgid());
        if ((f = fopen(ccdconf, "r")) == NULL) {
                setegid(egid);
                warn("fopen: %s", ccdconf);
                return (1);
        }
        setegid(egid);

        while (fgets(line, sizeof(line), f) != NULL) {
                argc = 0;
                argv = NULL;
                ++lineno;
                if ((cp = strrchr(line, '\n')) != NULL)
                        *cp = '\0';

                /* Break up the line and pass it's contents to do_single(). */
                if (line[0] == '\0')
                        goto end_of_line;
                for (cp = line; (cp = strtok(cp, " \t")) != NULL; cp = NULL) {
                        if (*cp == '#')
                                break;
                        if ((argv = realloc(argv,
                            sizeof(char *) * ++argc)) == NULL) {
                                warnx("no memory to configure ccds");
                                return (1);
                        }
                        argv[argc - 1] = cp;
                        /*
                         * If our action is to unconfigure all, then pass
                         * just the first token to do_single() and ignore
                         * the rest.  Since this will be encountered on
                         * our first pass through the line, the Right
                         * Thing will happen.
                         */
                        if (action == CCD_UNCONFIGALL) {
                                if (do_single(argc, argv, action))
                                        rval = 1;
                                goto end_of_line;
                        }
                }
                if (argc != 0)
                        if (do_single(argc, argv, action))
                                rval = 1;

 end_of_line:
                if (argv != NULL)
                        free(argv);
        }

        fclose(f);
        return (rval);
}

static int
checkdev(char *path)
{
        struct stat st;

        if (stat(path, &st) != 0)
                return (errno);

        if (!S_ISBLK(st.st_mode) && !S_ISCHR(st.st_mode))
                return (EINVAL);

        return (0);
}

static int
pathtounit(char *path, int *unitp)
{
        struct stat st;
        int maxpartitions;

        if (stat(path, &st) != 0)
                return (errno);

        if (!S_ISBLK(st.st_mode) && !S_ISCHR(st.st_mode))
                return (EINVAL);

        if ((maxpartitions = getmaxpartitions()) < 0)
                return (errno);

        *unitp = minor(st.st_rdev) / maxpartitions;

        return (0);
}

static char *
resolve_ccdname(char *name)
{
        char *path;

        if (name[0] == '/' || name[0] == '.') {
                /* Assume they gave the correct pathname. */
                return (strdup(name));
        }

        asprintf(&path, "%s%s", _PATH_DEV, name);

        return (path);
}

static int
do_io(char *path, u_long cmd, struct ccd_ioctl *cciop)
{
        int fd;
        const char *cp;

        if ((fd = open(path, O_RDWR, 0640)) < 0) {
                warn("open: %s", path);
                return (1);
        }

        if (ioctl(fd, cmd, cciop) < 0) {
                switch (cmd) {
                case CCDIOCSET:
                        cp = "CCDIOCSET";
                        break;

                case CCDIOCCLR:
                        cp = "CCDIOCCLR";
                        break;

                default:
                        cp = "unknown";
                }
                warn("ioctl (%s): %s", cp, path);
                return (1);
        }

        return (0);
}

#define KVM_ABORT(kd, str) {                                            \
        kvm_close((kd));                                                \
        warnx("%s", (str));                                                     \
        warnx("%s", kvm_geterr((kd)));                                  \
        return (1);                                                     \
}

static int
dump_ccd(int argc, char **argv)
{
        char errbuf[_POSIX2_LINE_MAX], *ccd, *cp;
        struct ccd_softc *cs, *kcs;
        ssize_t readsize;
        int i = 0, error, numccd, numconfiged = 0;
        kvm_t *kd;

        bzero(errbuf, sizeof(errbuf));

        if ((kd = kvm_openfiles(kernel, core, NULL, O_RDONLY,
            errbuf)) == NULL) {
                warnx("can't open kvm: %s", errbuf);
                return (1);
        }

        if (kvm_nlist(kd, nl))
                KVM_ABORT(kd, "ccd-related symbols not available");

        /* Check to see how many ccds are currently configured. */
        if (kvm_read(kd, nl[SYM_NUMCCD].n_value, (char *)&numccd,
            sizeof(numccd)) != sizeof(numccd))
                KVM_ABORT(kd, "can't determine number of configured ccds");

        if (numccd == 0) {
                printf("ccd driver in kernel, but is uninitialized\n");
                goto done;
        }

        /* Allocate space for the configuration data. */
        readsize = numccd * sizeof(struct ccd_softc);
        if ((cs = malloc(readsize)) == NULL) {
                warnx("no memory for configuration data");
                goto bad;
        }
        bzero(cs, readsize);

        /*
         * Read the ccd configuration data from the kernel and dump
         * it to stdout.
         */
        if (kvm_read(kd, nl[SYM_CCDSOFTC].n_value, (char *)&kcs,
            sizeof(kcs)) != sizeof(kcs)) {
                free(cs);
                KVM_ABORT(kd, "can't find pointer to configuration data");
        }
        if (kvm_read(kd, (u_long)kcs, (char *)cs, readsize) != readsize) {
                free(cs);
                KVM_ABORT(kd, "can't read configuration data");
        }

        if (argc == 0) {
                for (i = 0; i < numccd; ++i)
                        if (cs[i].sc_flags & CCDF_INITED) {
                                ++numconfiged;
                                print_ccd_info(&cs[i], kd);
                        }

                if (numconfiged == 0)
                        printf("no concatenated disks configured\n");
        } else {
                while (argc) {
                        cp = *argv++; --argc;
                        if ((ccd = resolve_ccdname(cp)) == NULL) {
                                warnx("invalid ccd name: %s", cp);
                                continue;
                        }
                        if ((error = pathtounit(ccd, &i)) != 0) {
                                warnx("%s: %s", ccd, strerror(error));
                                continue;
                        }
                        if (i >= numccd) {
                                warnx("ccd%d not configured", i);
                                continue;
                        }
                        if (cs[i].sc_flags & CCDF_INITED)
                                print_ccd_info(&cs[i], kd);
                        else
                                printf("ccd%d not configured\n", i);
                }
        }

        free(cs);

 done:
        kvm_close(kd);
        return (0);

 bad:
        kvm_close(kd);
        return (1);
}

static void
print_ccd_info(struct ccd_softc *cs, kvm_t *kd)
{
        static int header_printed = 0;
        struct ccdcinfo *cip;
        ssize_t readsize;
        char path[MAXPATHLEN];
        unsigned int i;

        if (header_printed == 0 && verbose) {
                printf("# ccd\t\tileave\tflags\tcompnent devices\n");
                header_printed = 1;
        }

        readsize = cs->sc_nccdisks * sizeof(struct ccdcinfo);
        if ((cip = malloc(readsize)) == NULL) {
                warn("ccd%d: can't allocate memory for component info",
                    cs->sc_unit);
                return;
        }
        bzero(cip, readsize);

        /* Dump out softc information. */
        printf("ccd%d\t\t%d\t%d\t", cs->sc_unit, cs->sc_ileave,
            cs->sc_cflags & CCDF_USERMASK);
        fflush(stdout);

        /* Read in the component info. */
        if (kvm_read(kd, (u_long)cs->sc_cinfo, (char *)cip,
            readsize) != readsize) {
                printf("\n");
                warnx("can't read component info");
                warnx("%s", kvm_geterr(kd));
                goto done;
        }

        /* Read component pathname and display component info. */
        for (i = 0; i < cs->sc_nccdisks; ++i) {
                if ((unsigned)kvm_read(kd, (u_long)cip[i].ci_path, (char *)path,
                    cip[i].ci_pathlen) != cip[i].ci_pathlen) {
                        printf("\n");
                        warnx("can't read component pathname");
                        warnx("%s", kvm_geterr(kd));
                        goto done;
                }
                printf((i + 1 < cs->sc_nccdisks) ? "%s " : "%s\n", path);
                fflush(stdout);
        }

 done:
        free(cip);
}

static int
getmaxpartitions(void)
{
    return (MAXPARTITIONS);
}

static int
flags_to_val(char *flags)
{
        char *cp, *tok;
        int i, tmp, val = ~CCDF_USERMASK;
        size_t flagslen;

        /*
         * The most common case is that of NIL flags, so check for
         * those first.
         */
        if (strcmp("none", flags) == 0 || strcmp("0x0", flags) == 0 ||
            strcmp("0", flags) == 0)
                return (0);

        flagslen = strlen(flags);

        /* Check for values represented by strings. */
        if ((cp = strdup(flags)) == NULL)
                err(1, "no memory to parse flags");
        tmp = 0;
        for (tok = cp; (tok = strtok(tok, ",")) != NULL; tok = NULL) {
                for (i = 0; flagvaltab[i].fv_flag != NULL; ++i)
                        if (strcmp(tok, flagvaltab[i].fv_flag) == 0)
                                break;
                if (flagvaltab[i].fv_flag == NULL) {
                        free(cp);
                        goto bad_string;
                }
                tmp |= flagvaltab[i].fv_val;
        }

        /* If we get here, the string was ok. */
        free(cp);
        val = tmp;
        goto out;

 bad_string:

        /* Check for values represented in hex. */
        if (flagslen > 2 && flags[0] == '0' && flags[1] == 'x') {
                errno = 0;      /* to check for ERANGE */
                val = (int)strtol(&flags[2], &cp, 16);
                if ((errno == ERANGE) || (*cp != '\0'))
                        return (-1);
                goto out;
        }

        /* Check for values represented in decimal. */
        errno = 0;      /* to check for ERANGE */
        val = (int)strtol(flags, &cp, 10);
        if ((errno == ERANGE) || (*cp != '\0'))
                return (-1);

 out:
        return (((val & ~CCDF_USERMASK) == 0) ? val : -1);
}

static void
usage(void)
{
        fprintf(stderr, "%s\n%s\n%s\n%s\n%s\n",
                "usage: ccdconfig [-cv] ccd ileave [flags] dev ...",
                "       ccdconfig -C [-v] [-f config_file]",
                "       ccdconfig -u [-v] ccd ...",
                "       ccdconfig -U [-v] [-f config_file]",
                "       ccdconfig -g [-M core] [-N system] [ccd ...]");
        exit(1);
}