a6dbe3721e
per Intel policy to include file commit date using git cmd below. The policy does not apply to non-Intel (C) notices. git log --follow -C90% --format=%ad --date default <file> | tail -1 and then pull just the 4 digit year from the result. Intel copyrights were not added to files where Intel either had no contribution ot the contribution lacked substance (ie license header updates, formatting changes, etc). Contribution date used "--follow -C95%" to get the most accurate date. Note that several files in this patch didn't end the license/(c) block with a blank comment line so these were added as the vast majority of files do have this last blank line. Simply there for consistency. Signed-off-by: paul luse <paul.e.luse@intel.com> Change-Id: Id5b7ce4f658fe87132f14139ead58d6e285c04d4 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15192 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Community-CI: Mellanox Build Bot
179 lines
5.1 KiB
C
179 lines
5.1 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (C) 2022 Intel Corporation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
#ifndef FTL_LAYOUT_UPGRADE_H
|
|
#define FTL_LAYOUT_UPGRADE_H
|
|
|
|
#include "ftl_core.h"
|
|
#include "ftl_layout.h"
|
|
|
|
struct spdk_ftl_dev;
|
|
struct ftl_layout_region;
|
|
struct ftl_layout_upgrade_ctx;
|
|
|
|
enum ftl_layout_upgrade_result {
|
|
/* Continue with the selected region upgrade */
|
|
FTL_LAYOUT_UPGRADE_CONTINUE = 0,
|
|
|
|
/* Layout upgrade done */
|
|
FTL_LAYOUT_UPGRADE_DONE,
|
|
|
|
/* Layout upgrade fault */
|
|
FTL_LAYOUT_UPGRADE_FAULT,
|
|
};
|
|
|
|
/* MD region upgrade verify fn: return 0 on success */
|
|
typedef int (*ftl_region_upgrade_verify_fn)(struct spdk_ftl_dev *dev,
|
|
struct ftl_layout_region *region);
|
|
|
|
/* MD region upgrade fn: return 0 on success */
|
|
typedef int (*ftl_region_upgrade_fn)(struct spdk_ftl_dev *dev, struct ftl_layout_upgrade_ctx *ctx);
|
|
|
|
/* MD region upgrade descriptor */
|
|
struct ftl_region_upgrade_desc {
|
|
/* Qualifies the region for upgrade */
|
|
ftl_region_upgrade_verify_fn verify;
|
|
|
|
/* Upgrades the region */
|
|
ftl_region_upgrade_fn upgrade;
|
|
|
|
/* New region version (i.e. after the upgrade) */
|
|
uint32_t new_version;
|
|
|
|
/* Context buffer allocated for upgrade() */
|
|
size_t ctx_size;
|
|
};
|
|
|
|
/* MD layout upgrade descriptor - one instance contains information about the upgrade steps necessary
|
|
* for updating to latest metadata version. For example version 0 of metadata region will have no descriptors
|
|
* (as it's by definition up to date and there's no need to upgrade it), while version 2 will have 2 (0 -> 1
|
|
* and 1 -> 2).
|
|
*/
|
|
struct ftl_layout_upgrade_desc_list {
|
|
/* # of entries in the region upgrade descriptor */
|
|
size_t count;
|
|
|
|
/* Region upgrade descriptor */
|
|
struct ftl_region_upgrade_desc *desc;
|
|
};
|
|
|
|
/* Region upgrade callback */
|
|
typedef void (*ftl_region_upgrade_cb)(struct spdk_ftl_dev *dev, void *ctx, int status);
|
|
|
|
/* MD layout upgrade context */
|
|
struct ftl_layout_upgrade_ctx {
|
|
/* MD region being upgraded */
|
|
struct ftl_layout_region *reg;
|
|
|
|
/* MD region upgrade descriptor */
|
|
struct ftl_layout_upgrade_desc_list *upgrade;
|
|
|
|
/* New region version (i.e. after the upgrade) */
|
|
uint64_t next_reg_ver;
|
|
|
|
/* Context buffer for the region upgrade */
|
|
void *ctx;
|
|
|
|
/* Region upgrade callback */
|
|
ftl_region_upgrade_cb cb;
|
|
|
|
/* Ctx for the region upgrade callback */
|
|
void *cb_ctx;
|
|
};
|
|
|
|
/**
|
|
* @brief Disable region upgrade for particular version.
|
|
*
|
|
* @param dev FTL device
|
|
* @param region FTL layout region descriptor
|
|
* @return int -1
|
|
*/
|
|
int ftl_region_upgrade_disabled(struct spdk_ftl_dev *dev, struct ftl_layout_region *region);
|
|
|
|
/**
|
|
* @brief Enable region upgrade for particular version.
|
|
*
|
|
* @param dev FTL device
|
|
* @param region FTL layout region descriptor
|
|
* @return int -1 (i.e. disable) if SB is dirty or SHM clean, 0 otherwise (i.e. enable)
|
|
*/
|
|
int ftl_region_upgrade_enabled(struct spdk_ftl_dev *dev, struct ftl_layout_region *region);
|
|
|
|
/**
|
|
* @brief Upgrade the superblock.
|
|
*
|
|
* This call is sychronous.
|
|
*
|
|
* @param dev FTL device
|
|
* @return int 0: success, error code otherwise
|
|
*/
|
|
int ftl_superblock_upgrade(struct spdk_ftl_dev *dev);
|
|
|
|
/**
|
|
* @brief Qualify the MD layout for upgrade.
|
|
*
|
|
* The SB MD layout is built or loaded.
|
|
* If loaded, walk through all MD layout and filter out all MD regions that need an upgrade.
|
|
* Call .verify() on region upgrade descriptors for all such regions.
|
|
*
|
|
* @param dev FTL device
|
|
* @return int 0: success, error code otherwise
|
|
*/
|
|
int ftl_layout_verify(struct spdk_ftl_dev *dev);
|
|
|
|
/**
|
|
* @brief Dump the FTL layout
|
|
*
|
|
* Verify MD layout in terms of region overlaps.
|
|
*
|
|
* @param dev FTL device
|
|
* @return int 0: success, error code otherwise
|
|
*/
|
|
int ftl_upgrade_layout_dump(struct spdk_ftl_dev *dev);
|
|
|
|
/**
|
|
* @brief Upgrade the MD region.
|
|
*
|
|
* Call .upgrade() on the selected region upgrade descriptor.
|
|
* When returned 0, this call is asynchronous.
|
|
* The .upgrade() is expected to convert and persist the metadata.
|
|
* When that's done, the call to ftl_region_upgrade_completed() is expected
|
|
* to continue with the layout upgrade.
|
|
*
|
|
* When returned an error code, the caller is responsible to abort the mngt pipeline.
|
|
*
|
|
* @param dev FTL device
|
|
* @param ctx Layout upgrade context
|
|
* @return int 0: upgrade in progress, error code otherwise
|
|
*/
|
|
int ftl_region_upgrade(struct spdk_ftl_dev *dev, struct ftl_layout_upgrade_ctx *ctx);
|
|
|
|
/**
|
|
* @brief Called when MD region upgrade is completed - see ftl_region_upgrade().
|
|
*
|
|
* Upgrades the SB MD layout and region's prev version descriptor to the just upgraded version.
|
|
* Executes the layout upgrade owner's callback (mngt region_upgrade_cb()) to continue
|
|
* with the layout upgrade.
|
|
*
|
|
* @param dev FTL device
|
|
* @param ctx Layout upgrade context
|
|
* @param status Region upgrade status: 0: success, error code otherwise
|
|
*/
|
|
void ftl_region_upgrade_completed(struct spdk_ftl_dev *dev, struct ftl_layout_upgrade_ctx *ctx,
|
|
int status);
|
|
|
|
/**
|
|
* @brief Initialize the layout upgrade context.
|
|
*
|
|
* Select the next region to be upgraded.
|
|
*
|
|
* @param dev FTL device
|
|
* @param ctx Layout upgrade context
|
|
* @return int see enum ftl_layout_upgrade_result
|
|
*/
|
|
int ftl_layout_upgrade_init_ctx(struct spdk_ftl_dev *dev, struct ftl_layout_upgrade_ctx *ctx);
|
|
|
|
#endif /* FTL_LAYOUT_UPGRADE_H */
|