xref: /spdk/lib/ftl/upgrade/ftl_sb_prev.h (revision f968b954a94944780711b6c2548cbe7aa1c77d81)

/*   SPDX-License-Identifier: BSD-3-Clause
 *   Copyright (C) 2022 Intel Corporation.
 *   All rights reserved.
 */

#ifndef FTL_SB_PREV_H
#define FTL_SB_PREV_H

#include "spdk/uuid.h"
#include "ftl_sb_common.h"

/**
 * Magic number identifies FTL superblock
 *
 * This old (pre v3) version has a bug - it's generating the magic number off 16b numbers, but only utilizing 8b from each
 */
#define FTL_MAGIC_V2(a, b, c, d) \
    ((UINT64_C(a) << 24) | (UINT64_C(b) << 16) | (UINT64_C(c) << 8) | UINT64_C(d))

#define FTL_SUPERBLOCK_MAGIC_V2 FTL_MAGIC_V2(0x1410, 0x1683, 0x1920, 0x1989)

#define FTL_SB_VERSION_0	0
#define FTL_SB_VERSION_1	1
#define FTL_SB_VERSION_2	2
#define FTL_SB_VERSION_3	3
#define FTL_SB_VERSION_4	4

struct ftl_superblock_v2 {
	struct ftl_superblock_header	header;

	struct spdk_uuid		uuid;

	/* Current sequence number */
	uint64_t			seq_id;

	/* Flag describing clean shutdown */
	uint64_t			clean;

	/* Number of surfaced LBAs */
	uint64_t			lba_cnt;
	/* Number of reserved addresses not exposed to the user */
	size_t				lba_rsvd;

	/* Maximum IO depth per band relocate */
	size_t				max_reloc_qdepth;

	/* Maximum active band relocates */
	size_t				max_active_relocs;

	/* Use append instead of write */
	bool				use_append;

	/* Maximum supported number of IO channels */
	uint32_t			max_io_channels;

	/* Last L2P checkpoint +1 (i.e. min_seq_id, 0:no ckpt) */
	uint64_t			ckpt_seq_id;

	struct ftl_superblock_gc_info	gc_info;
};


SPDK_STATIC_ASSERT(offsetof(struct ftl_superblock_v2, header) == 0,
		   "Invalid placement of header");

SPDK_STATIC_ASSERT(FTL_SUPERBLOCK_SIZE >= sizeof(struct ftl_superblock_v2),
		   "FTL SB metadata size is invalid");

struct ftl_superblock_v3 {
	struct ftl_superblock_header	header;

	struct spdk_uuid		uuid;

	/* Current sequence number */
	uint64_t			seq_id;

	/* Flag describing clean shutdown */
	uint64_t			clean;

	/* Number of surfaced LBAs */
	uint64_t			lba_cnt;

	/* Percentage of base device blocks not exposed to the user */
	uint64_t			overprovisioning;

	/* Maximum IO depth per band relocate */
	uint64_t			max_reloc_qdepth;

	/* Reserved field */
	uint8_t				reserved3[16];

	/* Last L2P checkpoint +1 (i.e. min_seq_id, 0:no ckpt) */
	uint64_t			ckpt_seq_id;

	struct ftl_superblock_gc_info	gc_info;

	struct ftl_superblock_v3_md_region	md_layout_head;
} __attribute__((packed));

SPDK_STATIC_ASSERT(offsetof(struct ftl_superblock_v3, header) == 0,
		   "Invalid placement of header");

SPDK_STATIC_ASSERT(FTL_SUPERBLOCK_SIZE >= sizeof(struct ftl_superblock_v3),
		   "FTL SB metadata size is invalid");

struct ftl_superblock_v5 {
	struct ftl_superblock_header	header;

	struct spdk_uuid		uuid;

	/* Current sequence number */
	uint64_t			seq_id;

	/* Flag describing clean shutdown */
	uint64_t			clean;

	/* Number of surfaced LBAs */
	uint64_t			lba_cnt;

	/* Percentage of base device blocks not exposed to the user */
	uint64_t			overprovisioning;

	/* Maximum IO depth per band relocate */
	uint64_t			max_reloc_qdepth;

	/* Reserved field */
	uint8_t				reserved3[16];

	/* Last L2P checkpoint +1 (i.e. min_seq_id, 0:no ckpt) */
	uint64_t			ckpt_seq_id;

	struct ftl_superblock_gc_info	gc_info;

	/* Points to the end of blob area */
	ftl_df_obj_id			blob_area_end;

	/* NVC device name */
	char				nvc_dev_name[16];

	/* NVC-stored MD layout tracking info */
	struct ftl_superblock_v5_md_blob_hdr	md_layout_nvc;

	/* Base device name */
	char					base_dev_name[16];

	/* Base dev-stored MD layout tracking info */
	struct ftl_superblock_v5_md_blob_hdr	md_layout_base;

	/* FTL layout params */
	struct ftl_superblock_v5_md_blob_hdr	layout_params;

	/* Start of the blob area */
	char blob_area[0];
} __attribute__((packed));

SPDK_STATIC_ASSERT(offsetof(struct ftl_superblock_v5, header) == 0,
		   "Invalid placement of header");

SPDK_STATIC_ASSERT(FTL_SUPERBLOCK_SIZE >= sizeof(struct ftl_superblock_v5),
		   "FTL SB metadata size is invalid");

#endif /* FTL_SB_PREV_H */