root/usr.bin/mkimg/scheme.c
/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2013,2014 Juniper Networks, Inc.
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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>
#include <sys/stat.h>
#include <assert.h>
#include <errno.h>
#include <limits.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include "image.h"
#include "mkimg.h"
#include "scheme.h"

static struct {
        const char *name;
        enum alias alias;
} scheme_alias[] = {
        { "ebr", ALIAS_EBR },
        { "efi", ALIAS_EFI },
        { "fat16b", ALIAS_FAT16B },
        { "fat32", ALIAS_FAT32 },
        { "fat32lba", ALIAS_FAT32LBA },
        { "freebsd", ALIAS_FREEBSD },
        { "freebsd-boot", ALIAS_FREEBSD_BOOT },
        { "freebsd-nandfs", ALIAS_FREEBSD_NANDFS },
        { "freebsd-swap", ALIAS_FREEBSD_SWAP },
        { "freebsd-ufs", ALIAS_FREEBSD_UFS },
        { "freebsd-vinum", ALIAS_FREEBSD_VINUM },
        { "freebsd-zfs", ALIAS_FREEBSD_ZFS },
        { "mbr", ALIAS_MBR },
        { "ntfs", ALIAS_NTFS },
        { "prepboot", ALIAS_PPCBOOT },
        { NULL, ALIAS_NONE }            /* Keep last! */
};

static struct mkimg_scheme *first;
static struct mkimg_scheme *scheme;
static void *bootcode;

static enum alias
scheme_parse_alias(const char *name)
{
        u_int idx;

        idx = 0;
        while (scheme_alias[idx].name != NULL) {
                if (strcasecmp(scheme_alias[idx].name, name) == 0)
                        return (scheme_alias[idx].alias);
                idx++;
        }
        return (ALIAS_NONE);
}

struct mkimg_scheme *
scheme_iterate(struct mkimg_scheme *s)
{

        return ((s == NULL) ? first : s->next);
}

void
scheme_register(struct mkimg_scheme *s)
{
        s->next = first;
        first = s;
}

int
scheme_select(const char *spec)
{
        struct mkimg_scheme *s;

        s = NULL;
        while ((s = scheme_iterate(s)) != NULL) {
                if (strcasecmp(spec, s->name) == 0) {
                        scheme = s;
                        return (0);
                }
        }
        return (EINVAL);
}

struct mkimg_scheme *
scheme_selected(void)
{

        return (scheme);
}

int
scheme_bootcode(int fd)
{
        struct stat sb;

        if (scheme == NULL || scheme->bootcode == 0)
                return (ENXIO);

        if (fstat(fd, &sb) == -1)
                return (errno);
        if (sb.st_size > scheme->bootcode)
                return (EFBIG);

        bootcode = malloc(scheme->bootcode);
        if (bootcode == NULL)
                return (ENOMEM);
        memset(bootcode, 0, scheme->bootcode);
        if (read(fd, bootcode, sb.st_size) != sb.st_size) {
                free(bootcode);
                bootcode = NULL;
                return (errno);
        }
        return (0);
}

int
scheme_check_part(struct part *p)
{
        struct mkimg_alias *iter;
        enum alias alias;

        assert(scheme != NULL);

        /* Check the partition type alias */
        alias = scheme_parse_alias(p->alias);
        if (alias == ALIAS_NONE)
                return (EINVAL);

        iter = scheme->aliases;
        while (iter->alias != ALIAS_NONE) {
                if (alias == iter->alias)
                        break;
                iter++;
        }
        if (iter->alias == ALIAS_NONE)
                return (EINVAL);
        p->type = iter->type;

        /* Validate the optional label. */
        if (p->label != NULL) {
                if (strlen(p->label) > scheme->labellen)
                        return (EINVAL);
        }

        return (0);
}

u_int
scheme_max_parts(void)
{

        return ((scheme == NULL) ? 0 : scheme->nparts);
}

u_int
scheme_max_secsz(void)
{

        return ((scheme == NULL) ? INT_MAX+1U : scheme->maxsecsz);
}

lba_t
scheme_metadata(u_int where, lba_t start)
{

        return ((scheme == NULL) ? start : scheme->metadata(where, start));
}

int
scheme_write(lba_t end)
{

        return ((scheme == NULL) ? 0 : scheme->write(end, bootcode));
}