xref: /freebsd-head/sys/geom/raid/md_jmicron.c

/*-
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
 * Copyright (c) 2010 Alexander Motin <mav@FreeBSD.org>
 * Copyright (c) 2000 - 2008 S��ren Schmidt <sos@FreeBSD.org>
 * 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 AUTHORS 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 AUTHORS 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>
__FBSDID("$FreeBSD$");

#include <sys/param.h>
#include <sys/bio.h>
#include <sys/endian.h>
#include <sys/kernel.h>
#include <sys/kobj.h>
#include <sys/limits.h>
#include <sys/lock.h>
#include <sys/malloc.h>
#include <sys/mutex.h>
#include <sys/systm.h>
#include <sys/taskqueue.h>
#include <geom/geom.h>
#include <geom/geom_dbg.h>
#include "geom/raid/g_raid.h"
#include "g_raid_md_if.h"

static MALLOC_DEFINE(M_MD_JMICRON, "md_jmicron_data", "GEOM_RAID JMicron metadata");

#define	JMICRON_MAX_DISKS	8
#define	JMICRON_MAX_SPARE	2

struct jmicron_raid_conf {
    u_int8_t		signature[2];
#define	JMICRON_MAGIC		"JM"

    u_int16_t		version;
#define	JMICRON_VERSION		0x0001

    u_int16_t		checksum;
    u_int8_t		filler_1[10];
    u_int32_t		disk_id;
    u_int32_t		offset;
    u_int32_t		disk_sectors_high;
    u_int16_t		disk_sectors_low;
    u_int8_t		filler_2[2];
    u_int8_t		name[16];
    u_int8_t		type;
#define	JMICRON_T_RAID0		0
#define	JMICRON_T_RAID1		1
#define	JMICRON_T_RAID01	2
#define	JMICRON_T_CONCAT	3
#define	JMICRON_T_RAID5		5

    u_int8_t		stripe_shift;
    u_int16_t		flags;
#define	JMICRON_F_READY		0x0001
#define	JMICRON_F_BOOTABLE	0x0002
#define	JMICRON_F_BADSEC	0x0004
#define	JMICRON_F_ACTIVE	0x0010
#define	JMICRON_F_UNSYNC	0x0020
#define	JMICRON_F_NEWEST	0x0040

    u_int8_t		filler_3[4];
    u_int32_t		spare[JMICRON_MAX_SPARE];
    u_int32_t		disks[JMICRON_MAX_DISKS];
#define	JMICRON_DISK_MASK	0xFFFFFFF0
#define	JMICRON_SEG_MASK	0x0000000F
    u_int8_t		filler_4[32];
    u_int8_t		filler_5[384];
};

struct g_raid_md_jmicron_perdisk {
	struct jmicron_raid_conf	*pd_meta;
	int				 pd_disk_pos;
	int				 pd_disk_id;
	off_t				 pd_disk_size;
};

struct g_raid_md_jmicron_object {
	struct g_raid_md_object	 mdio_base;
	uint32_t		 mdio_config_id;
	struct jmicron_raid_conf	*mdio_meta;
	struct callout		 mdio_start_co;	/* STARTING state timer. */
	int			 mdio_total_disks;
	int			 mdio_disks_present;
	int			 mdio_started;
	int			 mdio_incomplete;
	struct root_hold_token	*mdio_rootmount; /* Root mount delay token. */
};

static g_raid_md_create_t g_raid_md_create_jmicron;
static g_raid_md_taste_t g_raid_md_taste_jmicron;
static g_raid_md_event_t g_raid_md_event_jmicron;
static g_raid_md_ctl_t g_raid_md_ctl_jmicron;
static g_raid_md_write_t g_raid_md_write_jmicron;
static g_raid_md_fail_disk_t g_raid_md_fail_disk_jmicron;
static g_raid_md_free_disk_t g_raid_md_free_disk_jmicron;
static g_raid_md_free_t g_raid_md_free_jmicron;

static kobj_method_t g_raid_md_jmicron_methods[] = {
	KOBJMETHOD(g_raid_md_create,	g_raid_md_create_jmicron),
	KOBJMETHOD(g_raid_md_taste,	g_raid_md_taste_jmicron),
	KOBJMETHOD(g_raid_md_event,	g_raid_md_event_jmicron),
	KOBJMETHOD(g_raid_md_ctl,	g_raid_md_ctl_jmicron),
	KOBJMETHOD(g_raid_md_write,	g_raid_md_write_jmicron),
	KOBJMETHOD(g_raid_md_fail_disk,	g_raid_md_fail_disk_jmicron),
	KOBJMETHOD(g_raid_md_free_disk,	g_raid_md_free_disk_jmicron),
	KOBJMETHOD(g_raid_md_free,	g_raid_md_free_jmicron),
	{ 0, 0 }
};

static struct g_raid_md_class g_raid_md_jmicron_class = {
	"JMicron",
	g_raid_md_jmicron_methods,
	sizeof(struct g_raid_md_jmicron_object),
	.mdc_enable = 1,
	.mdc_priority = 100
};

static void
g_raid_md_jmicron_print(struct jmicron_raid_conf *meta)
{
	int k;

	if (g_raid_debug < 1)
		return;

	printf("********* ATA JMicron RAID Metadata *********\n");
	printf("signature           <%c%c>\n", meta->signature[0], meta->signature[1]);
	printf("version             %04x\n", meta->version);
	printf("checksum            0x%04x\n", meta->checksum);
	printf("disk_id             0x%08x\n", meta->disk_id);
	printf("offset              0x%08x\n", meta->offset);
	printf("disk_sectors_high   0x%08x\n", meta->disk_sectors_high);
	printf("disk_sectors_low    0x%04x\n", meta->disk_sectors_low);
	printf("name                <%.16s>\n", meta->name);
	printf("type                %d\n", meta->type);
	printf("stripe_shift        %d\n", meta->stripe_shift);
	printf("flags               %04x\n", meta->flags);
	printf("spare              ");
	for (k = 0; k < JMICRON_MAX_SPARE; k++)
		printf(" 0x%08x", meta->spare[k]);
	printf("\n");
	printf("disks              ");
	for (k = 0; k < JMICRON_MAX_DISKS; k++)
		printf(" 0x%08x", meta->disks[k]);
	printf("\n");
	printf("=================================================\n");
}

static struct jmicron_raid_conf *
jmicron_meta_copy(struct jmicron_raid_conf *meta)
{
	struct jmicron_raid_conf *nmeta;

	nmeta = malloc(sizeof(*meta), M_MD_JMICRON, M_WAITOK);
	memcpy(nmeta, meta, sizeof(*meta));
	return (nmeta);
}

static int
jmicron_meta_total_disks(struct jmicron_raid_conf *meta)
{
	int pos;

	for (pos = 0; pos < JMICRON_MAX_DISKS; pos++) {
		if (meta->disks[pos] == 0)
			break;
	}
	return (pos);
}

static int
jmicron_meta_total_spare(struct jmicron_raid_conf *meta)
{
	int pos, n;

	n = 0;
	for (pos = 0; pos < JMICRON_MAX_SPARE; pos++) {
		if (meta->spare[pos] != 0)
			n++;
	}
	return (n);
}

/*
 * Generate fake Configuration ID based on disk IDs.
 * Note: it will change after each disk set change.
 */
static uint32_t
jmicron_meta_config_id(struct jmicron_raid_conf *meta)
{
	int pos;
	uint32_t config_id;

	config_id = 0;
	for (pos = 0; pos < JMICRON_MAX_DISKS; pos++)
		config_id += meta->disks[pos] << pos;
	return (config_id);
}

static void
jmicron_meta_get_name(struct jmicron_raid_conf *meta, char *buf)
{
	int i;

	strncpy(buf, meta->name, 16);
	buf[16] = 0;
	for (i = 15; i >= 0; i--) {
		if (buf[i] > 0x20)
			break;
		buf[i] = 0;
	}
}

static void
jmicron_meta_put_name(struct jmicron_raid_conf *meta, char *buf)
{

	memset(meta->name, 0x20, 16);
	memcpy(meta->name, buf, MIN(strlen(buf), 16));
}

static int
jmicron_meta_find_disk(struct jmicron_raid_conf *meta, uint32_t id)
{
	int pos;

	id &= JMICRON_DISK_MASK;
	for (pos = 0; pos < JMICRON_MAX_DISKS; pos++) {
		if ((meta->disks[pos] & JMICRON_DISK_MASK) == id)
			return (pos);
	}
	for (pos = 0; pos < JMICRON_MAX_SPARE; pos++) {
		if ((meta->spare[pos] & JMICRON_DISK_MASK) == id)
			return (-3);
	}
	return (-1);
}

static struct jmicron_raid_conf *
jmicron_meta_read(struct g_consumer *cp)
{
	struct g_provider *pp;
	struct jmicron_raid_conf *meta;
	char *buf;
	int error, i;
	uint16_t checksum, *ptr;

	pp = cp->provider;

	/* Read the anchor sector. */
	buf = g_read_data(cp,
	    pp->mediasize - pp->sectorsize, pp->sectorsize, &error);
	if (buf == NULL) {
		G_RAID_DEBUG(1, "Cannot read metadata from %s (error=%d).",
		    pp->name, error);
		return (NULL);
	}
	meta = (struct jmicron_raid_conf *)buf;

	/* Check if this is an JMicron RAID struct */
	if (strncmp(meta->signature, JMICRON_MAGIC, strlen(JMICRON_MAGIC))) {
		G_RAID_DEBUG(1, "JMicron signature check failed on %s", pp->name);
		g_free(buf);
		return (NULL);
	}
	meta = malloc(sizeof(*meta), M_MD_JMICRON, M_WAITOK);
	memcpy(meta, buf, min(sizeof(*meta), pp->sectorsize));
	g_free(buf);

	/* Check metadata checksum. */
	for (checksum = 0, ptr = (uint16_t *)meta, i = 0; i < 64; i++)
		checksum += *ptr++;