ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

bdev: clarify the config_json methods

Browse Source 
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Ie2b0e24000665fd95a7c21298c86f4889a03650a

Reviewed-on: https://review.gerrithub.io/424583
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
This commit is contained in:
Jim Harris 2018-09-04 10:06:11 -07:00 committed by Ben Walker
parent 30dc6a1893
commit a7bafb6121
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
include/spdk/bdev_module.h
View File

@ -91,8 +91,16 @@ struct spdk_bdev_module {
void (*config_text)(FILE *fp); void (*config_text)(FILE *fp);
/** /**
* Function called to return a text string representing the * Function called to return a text string representing the module-level
* module's configuration options for inclusion in a configuration file. * JSON RPCs required to regenerate the current configuration. This will
* include module-level configuration options, or methods to construct
* bdevs when one RPC may generate multiple bdevs (for example, an NVMe
* controller with multiple namespaces).
*
* Per-bdev JSON RPCs (where one "construct" RPC always creates one bdev)
* may be implemented here, or by the bdev's write_config_json function -
* but not both. Bdev module implementers may choose which mechanism to
* use based on the module's design.
* *
* \return 0 on success or Bdev specific negative error code. * \return 0 on success or Bdev specific negative error code.
*/ */
@ -185,7 +193,14 @@ struct spdk_bdev_fn_table {
int (*dump_info_json)(void *ctx, struct spdk_json_write_ctx *w); int (*dump_info_json)(void *ctx, struct spdk_json_write_ctx *w);
/** /**
* Output bdev-specific configuration to a JSON stream. Optional - may be NULL. * Output bdev-specific RPC configuration to a JSON stream. Optional - may be NULL.
*
* This function should only be implemented for bdevs which can be configured
* independently of other bdevs. For example, RPCs to create a bdev for an NVMe
* namespace may not be generated by this function, since enumerating an NVMe
* namespace requires attaching to an NVMe controller, and that controller may
* contain multiple namespaces. The spdk_bdev_module's config_json function should
* be used instead for these cases.
* *
* The JSON write context will be initialized with an open object, so the bdev * The JSON write context will be initialized with an open object, so the bdev
* driver should write all data necessary to recreate this bdev by invoking * driver should write all data necessary to recreate this bdev by invoking