d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

blob: Make the ABI compatibility of spdk_blob_opts structure.

Browse Source 
Change-Id: I1b1806864783e944d8f55c9393228a1954051236
Signed-off-by: Ziye Yang <ziye.yang@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/5687
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
This commit is contained in:
Ziye Yang 2020-12-24 00:56:38 +08:00 committed by Tomasz Zawadzki
parent 3de9887d6d
commit b47f0f20b7
6 changed files with 95 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -16,6 +16,10 @@ An `opts_size` element was added in the `spdk_bs_opts` structure to solve the
ABI compatiblity issue between different SPDK version. And also add `opts_size`
parameter in `spdk_bs_opts_init` function.
An `opts_size` element was added in the `spdk_blob_opts` structure to solve the
ABI compatiblity issue between different SPDK version. And also add `opts_size`
parameter in `spdk_blob_opts_init` function.
### event
The pci_whitelist and pci_blacklist members of struct spdk_app_opts have been

11
include/spdk/blob.h
View File

@ -426,14 +426,23 @@ struct spdk_blob_opts {
/** Enable separate extent pages in metadata */
bool use_extent_table;
/**
* The size of spdk_blob_opts according to the caller of this library is used for ABI
* compatibility. The library uses this field to know how many fields in this
* structure are valid. And the library will populate any remaining fields with default values.
* New added fields should be put at the end of the struct.
*/
size_t opts_size;
};
/**
* Initialize a spdk_blob_opts structure to the default blob option values.
*
* \param opts spdk_blob_opts structure to initialize.
* \param opts_size It must be the size of spdk_blob_opts structure.
*/
void spdk_blob_opts_init(struct spdk_blob_opts *opts);
void spdk_blob_opts_init(struct spdk_blob_opts *opts, size_t opts_size);
/**
* Create a new blob with options on the given blobstore. The new blob id will

95
lib/blob/blobstore.c
View File

@ -203,13 +203,41 @@ blob_xattrs_init(struct spdk_blob_xattr_opts *xattrs)
}
void
spdk_blob_opts_init(struct spdk_blob_opts *opts)
spdk_blob_opts_init(struct spdk_blob_opts *opts, size_t opts_size)
{
opts->num_clusters = 0;
opts->thin_provision = false;
opts->clear_method = BLOB_CLEAR_WITH_DEFAULT;
blob_xattrs_init(&opts->xattrs);
opts->use_extent_table = true;
if (!opts) {
SPDK_ERRLOG("opts should not be NULL\n");
return;
}
if (!opts_size) {
SPDK_ERRLOG("opts_size should not be zero value\n");
return;
}
memset(opts, 0, opts_size);
opts->opts_size = opts_size;
#define FIELD_OK(field) \
offsetof(struct spdk_blob_opts, field) + sizeof(opts->field) <= opts_size
#define SET_FIELD(field, value) \
if (FIELD_OK(field)) { \
opts->field = value; \
} \
SET_FIELD(num_clusters, 0);
SET_FIELD(thin_provision, false);
SET_FIELD(clear_method, BLOB_CLEAR_WITH_DEFAULT);
if (FIELD_OK(xattrs)) {
blob_xattrs_init(&opts->xattrs);
}
SET_FIELD(use_extent_table, true);
#undef FIELD_OK
#undef SET_FIELD
}
void
@ -4300,7 +4328,7 @@ bs_load_super_cpl(spdk_bs_sequence_t *seq, void *cb_arg, int bserrno)
}
}
static int
static inline int
bs_opts_copy(struct spdk_bs_opts *src, struct spdk_bs_opts *dst)
{
@ -5308,6 +5336,37 @@ blob_set_xattrs(struct spdk_blob *blob, const struct spdk_blob_xattr_opts *xattr
return 0;
}
static void
blob_opts_copy(const struct spdk_blob_opts *src, struct spdk_blob_opts *dst)
{
#define FIELD_OK(field) \
offsetof(struct spdk_blob_opts, field) + sizeof(src->field) <= src->opts_size
#define SET_FIELD(field) \
if (FIELD_OK(field)) { \
dst->field = src->field; \
} \
SET_FIELD(num_clusters);
SET_FIELD(thin_provision);
SET_FIELD(clear_method);
if (FIELD_OK(xattrs)) {
memcpy(&dst->xattrs, &src->xattrs, sizeof(src->xattrs));
}
SET_FIELD(use_extent_table);
dst->opts_size = src->opts_size;
/* You should not remove this statement, but need to update the assert statement
* if you add a new field, and also add a corresponding SET_FIELD statement */
SPDK_STATIC_ASSERT(sizeof(struct spdk_blob_opts) == 64, "Incorrect size");
#undef FIELD_OK
#undef SET_FIELD
}
static void
bs_create_blob(struct spdk_blob_store *bs,
const struct spdk_blob_opts *opts,
@ -5317,7 +5376,7 @@ bs_create_blob(struct spdk_blob_store *bs,
struct spdk_blob *blob;
uint32_t page_idx;
struct spdk_bs_cpl cpl;
struct spdk_blob_opts opts_default;
struct spdk_blob_opts opts_local;
struct spdk_blob_xattr_opts internal_xattrs_default;
spdk_bs_sequence_t *seq;
spdk_blob_id id;
@ -5345,12 +5404,12 @@ bs_create_blob(struct spdk_blob_store *bs,
return;
}
if (!opts) {
spdk_blob_opts_init(&opts_default);
opts = &opts_default;
spdk_blob_opts_init(&opts_local, sizeof(opts_local));
if (opts) {
blob_opts_copy(opts, &opts_local);
}
blob->use_extent_table = opts->use_extent_table;
blob->use_extent_table = opts_local.use_extent_table;
if (blob->use_extent_table) {
blob->invalid_flags |= SPDK_BLOB_EXTENT_TABLE;
}
@ -5360,7 +5419,7 @@ bs_create_blob(struct spdk_blob_store *bs,
internal_xattrs = &internal_xattrs_default;
}
rc = blob_set_xattrs(blob, &opts->xattrs, false);
rc = blob_set_xattrs(blob, &opts_local.xattrs, false);
if (rc < 0) {
blob_free(blob);
spdk_bit_array_clear(bs->used_blobids, page_idx);
@ -5378,13 +5437,13 @@ bs_create_blob(struct spdk_blob_store *bs,
return;
}
if (opts->thin_provision) {
if (opts_local.thin_provision) {
blob_set_thin_provision(blob);
}
blob_set_clear_method(blob, opts->clear_method);
blob_set_clear_method(blob, opts_local.clear_method);
rc = blob_resize(blob, opts->num_clusters);
rc = blob_resize(blob, opts_local.num_clusters);
if (rc < 0) {
blob_free(blob);
spdk_bit_array_clear(bs->used_blobids, page_idx);
@ -5769,7 +5828,7 @@ bs_snapshot_origblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno
_blob->locked_operation_in_progress = true;
spdk_blob_opts_init(&opts);
spdk_blob_opts_init(&opts, sizeof(opts));
blob_xattrs_init(&internal_xattrs);
/* Change the size of new blob to the same as in original blob,
@ -5880,7 +5939,7 @@ bs_clone_origblob_open_cpl(void *cb_arg, struct spdk_blob *_blob, int bserrno)
_blob->locked_operation_in_progress = true;
spdk_blob_opts_init(&opts);
spdk_blob_opts_init(&opts, sizeof(opts));
blob_xattrs_init(&internal_xattrs);
opts.thin_provision = true;

2
lib/lvol/lvol.c
View File

@ -1063,7 +1063,7 @@ spdk_lvol_create(struct spdk_lvol_store *lvs, const char *name, uint64_t sz,
spdk_uuid_fmt_lower(lvol->uuid_str, sizeof(lvol->uuid_str), &lvol->uuid);
req->lvol = lvol;
spdk_blob_opts_init(&opts);
spdk_blob_opts_init(&opts, sizeof(opts));
opts.thin_provision = thin_provision;
opts.num_clusters = num_clusters;
opts.clear_method = lvol->clear_method;

2
test/unit/lib/blob/blob.c/blob_ut.c
View File

@ -131,7 +131,7 @@ _get_snapshots_count(struct spdk_blob_store *bs)
static void
ut_spdk_blob_opts_init(struct spdk_blob_opts *opts)
{
spdk_blob_opts_init(opts);
spdk_blob_opts_init(opts, sizeof(*opts));
opts->use_extent_table = g_use_extent_table;
}

3
test/unit/lib/lvol/lvol.c/lvol_ut.c
View File

@ -399,8 +399,9 @@ spdk_bs_open_blob(struct spdk_blob_store *bs, spdk_blob_id blobid,
DEFINE_STUB(spdk_bs_free_cluster_count, uint64_t, (struct spdk_blob_store *bs), BS_FREE_CLUSTERS);
void
spdk_blob_opts_init(struct spdk_blob_opts *opts)
spdk_blob_opts_init(struct spdk_blob_opts *opts, size_t opts_size)
{
opts->opts_size = opts_size;
opts->num_clusters = 0;
opts->thin_provision = false;
opts->xattrs.count = 0;