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

/*-
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
 * Copyright (c) 2011 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_NVIDIA, "md_nvidia_data", "GEOM_RAID NVIDIA metadata");

struct nvidia_raid_conf {
	uint8_t		nvidia_id[8];
#define NVIDIA_MAGIC                "NVIDIA  "

	uint32_t	config_size;
	uint32_t	checksum;
	uint16_t	version;
	uint8_t		disk_number;
	uint8_t		dummy_0;
	uint32_t	total_sectors;
	uint32_t	sector_size;
	uint8_t		name[16];
	uint8_t		revision[4];
	uint32_t	disk_status;

	uint32_t	magic_0;
#define NVIDIA_MAGIC0		0x00640044

	uint64_t	volume_id[2];
	uint8_t		state;
#define NVIDIA_S_IDLE		0
#define NVIDIA_S_INIT		2
#define NVIDIA_S_REBUILD	3
#define NVIDIA_S_UPGRADE	4
#define NVIDIA_S_SYNC		5
	uint8_t		array_width;
	uint8_t		total_disks;
	uint8_t		orig_array_width;
	uint16_t	type;
#define NVIDIA_T_RAID0		0x0080
#define NVIDIA_T_RAID1		0x0081
#define NVIDIA_T_RAID3		0x0083
#define NVIDIA_T_RAID5		0x0085	/* RLQ = 00/02? */
#define NVIDIA_T_RAID5_SYM	0x0095	/* RLQ = 03 */
#define NVIDIA_T_RAID10		0x008a
#define NVIDIA_T_RAID01		0x8180
#define NVIDIA_T_CONCAT		0x00ff

	uint16_t	dummy_3;
	uint32_t	strip_sectors;
	uint32_t	strip_bytes;
	uint32_t	strip_shift;
	uint32_t	strip_mask;
	uint32_t	stripe_sectors;
	uint32_t	stripe_bytes;
	uint32_t	rebuild_lba;
	uint32_t	orig_type;
	uint32_t	orig_total_sectors;
	uint32_t	status;
#define NVIDIA_S_BOOTABLE	0x00000001
#define NVIDIA_S_DEGRADED	0x00000002

	uint32_t	filler[98];
} __packed;

struct g_raid_md_nvidia_perdisk {
	struct nvidia_raid_conf	*pd_meta;
	int			 pd_disk_pos;
	off_t			 pd_disk_size;
};

struct g_raid_md_nvidia_object {
	struct g_raid_md_object	 mdio_base;
	uint64_t		 mdio_volume_id[2];
	struct nvidia_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_nvidia;
static g_raid_md_taste_t g_raid_md_taste_nvidia;
static g_raid_md_event_t g_raid_md_event_nvidia;
static g_raid_md_ctl_t g_raid_md_ctl_nvidia;
static g_raid_md_write_t g_raid_md_write_nvidia;
static g_raid_md_fail_disk_t g_raid_md_fail_disk_nvidia;
static g_raid_md_free_disk_t g_raid_md_free_disk_nvidia;
static g_raid_md_free_t g_raid_md_free_nvidia;

static kobj_method_t g_raid_md_nvidia_methods[] = {
	KOBJMETHOD(g_raid_md_create,	g_raid_md_create_nvidia),
	KOBJMETHOD(g_raid_md_taste,	g_raid_md_taste_nvidia),
	KOBJMETHOD(g_raid_md_event,	g_raid_md_event_nvidia),
	KOBJMETHOD(g_raid_md_ctl,	g_raid_md_ctl_nvidia),
	KOBJMETHOD(g_raid_md_write,	g_raid_md_write_nvidia),
	KOBJMETHOD(g_raid_md_fail_disk,	g_raid_md_fail_disk_nvidia),
	KOBJMETHOD(g_raid_md_free_disk,	g_raid_md_free_disk_nvidia),
	KOBJMETHOD(g_raid_md_free,	g_raid_md_free_nvidia),
	{ 0, 0 }
};

static struct g_raid_md_class g_raid_md_nvidia_class = {
	"NVIDIA",
	g_raid_md_nvidia_methods,
	sizeof(struct g_raid_md_nvidia_object),
	.mdc_enable = 1,
	.mdc_priority = 100
};

static int NVIDIANodeID = 1;

static void
g_raid_md_nvidia_print(struct nvidia_raid_conf *meta)
{

	if (g_raid_debug < 1)
		return;

	printf("********* ATA NVIDIA RAID Metadata *********\n");
	printf("nvidia_id           <%.8s>\n", meta->nvidia_id);
	printf("config_size         %u\n", meta->config_size);
	printf("checksum            0x%08x\n", meta->checksum);
	printf("version             0x%04x\n", meta->version);
	printf("disk_number         %d\n", meta->disk_number);
	printf("dummy_0             0x%02x\n", meta->dummy_0);
	printf("total_sectors       %u\n", meta->total_sectors);
	printf("sector_size         %u\n", meta->sector_size);
	printf("name                <%.16s>\n", meta->name);
	printf("revision            0x%02x%02x%02x%02x\n",
	    meta->revision[0], meta->revision[1],
	    meta->revision[2], meta->revision[3]);
	printf("disk_status         0x%08x\n", meta->disk_status);
	printf("magic_0             0x%08x\n", meta->magic_0);
	printf("volume_id           0x%016jx%016jx\n",
	    meta->volume_id[1], meta->volume_id[0]);
	printf("state               0x%02x\n", meta->state);
	printf("array_width         %u\n", meta->array_width);
	printf("total_disks         %u\n", meta->total_disks);
	printf("orig_array_width    %u\n", meta->orig_array_width);
	printf("type                0x%04x\n", meta->type);
	printf("dummy_3             0x%04x\n", meta->dummy_3);
	printf("strip_sectors       %u\n", meta->strip_sectors);
	printf("strip_bytes         %u\n", meta->strip_bytes);
	printf("strip_shift         %u\n", meta->strip_shift);
	printf("strip_mask          0x%08x\n", meta->strip_mask);
	printf("stripe_sectors      %u\n", meta->stripe_sectors);
	printf("stripe_bytes        %u\n", meta->stripe_bytes);
	printf("rebuild_lba         %u\n", meta->rebuild_lba);
	printf("orig_type           0x%04x\n", meta->orig_type);
	printf("orig_total_sectors  %u\n", meta->orig_total_sectors);
	printf("status              0x%08x\n", meta->status);
	printf("=================================================\n");
}

static struct nvidia_raid_conf *
nvidia_meta_copy(struct nvidia_raid_conf *meta)
{
	struct nvidia_raid_conf *nmeta;

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

static int
nvidia_meta_translate_disk(struct nvidia_raid_conf *meta, int md_disk_pos)
{
	int disk_pos;

	if (md_disk_pos >= 0 && meta->type == NVIDIA_T_RAID01) {
		disk_pos = (md_disk_pos / meta->array_width) +
		    (md_disk_pos % meta->array_width) * meta->array_width;
	} else
		disk_pos = md_disk_pos;
	return (disk_pos);
}

static void
nvidia_meta_get_name(struct nvidia_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
nvidia_meta_put_name(struct nvidia_raid_conf *meta, char *buf)
{

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

static struct nvidia_raid_conf *
nvidia_meta_read(struct g_consumer *cp)
{
	struct g_provider *pp;
	struct nvidia_raid_conf *meta;
	char *buf;
	int error, i;
	uint32_t checksum, *ptr;

	pp = cp->provider;

	/* Read the anchor sector. */
	buf = g_read_data(cp,
	    pp->mediasize - 2 * 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 nvidia_raid_conf *)buf;

	/* Check if this is an NVIDIA RAID struct */
	if (strncmp(meta->nvidia_id, NVIDIA_MAGIC, strlen(NVIDIA_MAGIC))) {
		G_RAID_DEBUG(1, "NVIDIA signature check failed on %s", pp->name);
		g_free(buf);
		return (NULL);
	}
	if (meta->config_size > 128 ||
	    meta->config_size < 30) {
		G_RAID_DEBUG(1, "NVIDIA metadata size looks wrong: %d",
		    meta->config_size);
		g_free(buf);
		return (NULL);
	}
	meta = malloc(sizeof(*meta), M_MD_NVIDIA, M_WAITOK);
	memcpy(meta, buf, min(sizeof(*meta), pp->sectorsize));
	g_free(buf);

	/* Check metadata checksum. */
	for (checksum = 0, ptr = (uint32_t *)meta,
	    i = 0; i < meta->config_size; i++)
		checksum += *ptr++;
	if (checksum != 0) {
		G_RAID_DEBUG(1, "NVIDIA checksum check failed on %s", pp->name);
		free(meta, M_MD_NVIDIA);
		return (NULL);
	}

	/* Check volume state. */
	if (meta->state != NVIDIA_S_IDLE && meta->state != NVIDIA_S_INIT &&
	    meta->state != NVIDIA_S_REBUILD && meta->state != NVIDIA_S_SYNC) {
		G_RAID_DEBUG(1, "NVIDIA unknown state on %s (0x%02x)",
		    pp->name, meta->state);
		free(meta, M_MD_NVIDIA);
		return (NULL);
	}