Commit adb39585 authored by Maciej Szwed's avatar Maciej Szwed Committed by Darek Stojaczyk
Browse files

lvol: add option to change default data erase method 



Some users require to do write zeroes operation when
erasing data on lvol. Currently the default method is
unmap. This patch adds flag to spdk_rpc_construct_lvol_bdev
call that changes default erase method. This is also a base
implementation for possible future function for erasing
data on lvol bdev.

Signed-off-by: default avatarMaciej Szwed <maciej.szwed@intel.com>
Change-Id: I8964f170b13c2268fe3c18104f7956c32be96040

Reviewed-on: https://review.gerrithub.io/c/441527


Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarDarek Stojaczyk <dariusz.stojaczyk@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
parent 0652c0a6

doc/jsonrpc.md

+2 −0
Original line number Diff line number Diff line
@@ -4183,6 +4183,7 @@ size | Required | number | Desired size of logical volum 
thin_provision          | Optional | boolean     | True to enable thin provisioning

uuid                    | Optional | string      | UUID of logical volume store to create logical volume on

lvs_name                | Optional | string      | Name of logical volume store to create logical volume on

clear_method            | Optional | string      | Change default data clusters clear method. Available: none, unmap, write_zeroes



Size will be rounded up to a multiple of cluster size. Either uuid or lvs_name must be specified, but not both.

lvol_name will be used in the alias of the created logical volume.
@@ -4203,6 +4204,7 @@ Example request: 
    "lvol_name": "LVOL0",

    "size": 1048576,

    "lvs_name": "LVS0",

    "clear_method": "unmap",

    "thin_provision": true

  }

}

include/spdk/blob.h

+30 −0
Original line number Diff line number Diff line
@@ -70,6 +70,13 @@ typedef uint64_t spdk_blob_id; 
#define SPDK_BLOBID_INVALID	(uint64_t)-1

#define SPDK_BLOBSTORE_TYPE_LENGTH 16



enum blob_clear_method {

	BLOB_CLEAR_WITH_DEFAULT,

	BLOB_CLEAR_WITH_NONE,

	BLOB_CLEAR_WITH_UNMAP,

	BLOB_CLEAR_WITH_WRITE_ZEROES,

};



struct spdk_blob_store;

struct spdk_io_channel;

struct spdk_blob;
@@ -572,6 +579,17 @@ void spdk_bs_inflate_blob(struct spdk_blob_store *bs, struct spdk_io_channel *ch 
void spdk_bs_blob_decouple_parent(struct spdk_blob_store *bs, struct spdk_io_channel *channel,

				  spdk_blob_id blobid, spdk_blob_op_complete cb_fn, void *cb_arg);



struct spdk_blob_open_opts {

	enum blob_clear_method  clear_method;

};



/**

 * Initialize a spdk_blob_open_opts structure to the default blob option values.

 *

 * \param opts spdk_blob_open_opts structure to initialize.

 */

void spdk_blob_open_opts_init(struct spdk_blob_open_opts *opts);



/**

 * Open a blob from the given blobstore.

 *
@@ -583,6 +601,18 @@ void spdk_bs_blob_decouple_parent(struct spdk_blob_store *bs, struct spdk_io_cha 
void spdk_bs_open_blob(struct spdk_blob_store *bs, spdk_blob_id blobid,

		       spdk_blob_op_with_handle_complete cb_fn, void *cb_arg);



/**

 * Open a blob from the given blobstore with additional options.

 *

 * \param bs blobstore.

 * \param blobid The id of the blob to open.

 * \param opts The structure which contains the option values for the blob.

 * \param cb_fn Called when the operation is complete.

 * \param cb_arg Argument passed to function cb_fn.

 */

void spdk_bs_open_blob_ext(struct spdk_blob_store *bs, spdk_blob_id blobid,

			   struct spdk_blob_open_opts *opts, spdk_blob_op_with_handle_complete cb_fn, void *cb_arg);



/**

 * Resize a blob to 'sz' clusters. These changes are not persisted to disk until

 * spdk_bs_md_sync_blob() is called.

include/spdk/lvol.h

+11 −1
Original line number Diff line number Diff line
@@ -48,6 +48,14 @@ struct spdk_bs_dev; 
struct spdk_lvol_store;

struct spdk_lvol;



enum lvol_clear_method {

	LVOL_CLEAR_WITH_DEFAULT,

	LVOL_CLEAR_WITH_NONE,

	LVOL_CLEAR_WITH_UNMAP,

	LVOL_CLEAR_WITH_WRITE_ZEROES,

};





/* Must include null terminator. */

#define SPDK_LVS_NAME_MAX	64

#define SPDK_LVOL_NAME_MAX	64
@@ -164,13 +172,15 @@ int spdk_lvs_destroy(struct spdk_lvol_store *lvol_store, 
 * \param name Name of lvol.

 * \param sz size of lvol in bytes.

 * \param thin_provisioned Enables thin provisioning.

 * \param clear_method Changes default data clusters clear method

 * \param cb_fn Completion callback.

 * \param cb_arg Completion callback custom arguments.

 *

 * \return 0 on success, negative errno on failure.

 */

int spdk_lvol_create(struct spdk_lvol_store *lvs, const char *name, uint64_t sz,

		     bool thin_provisioned, spdk_lvol_op_with_handle_complete cb_fn, void *cb_arg);

		     bool thin_provisioned, enum lvol_clear_method clear_method,

		     spdk_lvol_op_with_handle_complete cb_fn, void *cb_arg);

/**

 * Create snapshot of given lvol.

 *

include/spdk_internal/lvolstore.h

+1 −0
Original line number Diff line number Diff line
@@ -112,6 +112,7 @@ struct spdk_lvol { 
	struct spdk_bdev		*bdev;

	int				ref_count;

	bool				action_in_progress;

	enum blob_clear_method		clear_method;

	TAILQ_ENTRY(spdk_lvol) link;

};

lib/bdev/lvol/vbdev_lvol.c

+4 −2
Original line number Diff line number Diff line
@@ -1004,7 +1004,8 @@ end: 


int

vbdev_lvol_create(struct spdk_lvol_store *lvs, const char *name, uint64_t sz,

		  bool thin_provision, spdk_lvol_op_with_handle_complete cb_fn, void *cb_arg)

		  bool thin_provision, enum lvol_clear_method clear_method, spdk_lvol_op_with_handle_complete cb_fn,

		  void *cb_arg)

{

	struct spdk_lvol_with_handle_req *req;

	int rc;
@@ -1016,7 +1017,8 @@ vbdev_lvol_create(struct spdk_lvol_store *lvs, const char *name, uint64_t sz, 
	req->cb_fn = cb_fn;

	req->cb_arg = cb_arg;



	rc = spdk_lvol_create(lvs, name, sz, thin_provision, _vbdev_lvol_create_cb, req);

	rc = spdk_lvol_create(lvs, name, sz, thin_provision, clear_method,

			      _vbdev_lvol_create_cb, req);

	if (rc != 0) {

		free(req);

	}