Commit cc25bd4a authored by Tomasz Zawadzki's avatar Tomasz Zawadzki
Browse files

changelog: consolidated sections for SPDK 19.10 



There were couple sections that were duplicated, so they
are now consolidated.

Moved around sections so that relevant ones are closer
to each other.

No change in content of section/entry was done in this patch.

Change-Id: I1838d9057548c5f65f7304f783ee81e21d3b624c
Signed-off-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/472731


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent 1ef8449f

CHANGELOG.md

+92 −96
Original line number Diff line number Diff line
@@ -9,6 +9,41 @@ Added new parameter `cdw0` to `spdk_bdev_io_complete_nvme_status()` and 
the NVMe completion queue DW0 entry. This allows vendor specific IO commands

to return commmand specific completion info back to the initiator.



Added `spdk_bdev_get_write_unit_size()` function for retrieving required number

of logical blocks for write operation.



New zone-related fields were added to the result of the `get_bdevs` RPC call:

 - `zoned`: indicates whether the device is zoned or a regular

   block device

 - `zone_size`: number of blocks in a single zone

 - `max_open_zones`: maximum number of open zones

 - `optimal_open_zones`: optimal number of open zones

The `zoned` field is a boolean and is always present, while the rest is only available for zoned

bdevs.



A new spdk_bdev_open_ext function has been added and spdk_bdev_open function has been deprecated.

The new open function introduces requirement to provide callback function that will be called by

asynchronous event such as bdev removal. spdk_bdev_open_ext function takes bdev name as

an argument instead of bdev structure to avoid a race condition that can happen when the bdev

is being removed between a call to get its structure based on a name and actually openning it.



New 'resize' event has been added to notify about change of block count property of block device.

Event is delivered only if block device was opened with spdk_bdev_open_ext function.



### bdev zone



Added new public header for zoned bdev. Zoned bdev is an extension

of the bdev interface.



`spdk_bdev_get_zone_size()`, `spdk_bdev_get_max_open_zones()`, `spdk_bdev_get_optimal_open_zones()`

APIs were added for retrieving zoned device information.

`spdk_bdev_get_zone_info()` API was added for retrieving information about zones in zoned

device.

Added `spdk_bdev_zone_management()` API for changing zone state.

`spdk_bdev_zone_append()` and `spdk_bdev_zone_append_with_md()` APIs were added for

appending data to a zone.

Added `spdk_bdev_io_get_append location()` function for retrieving append location for I/O.



### bdev opal



EXPERIMENTAL: A new opal bdev has been added to support management of
@@ -23,33 +58,58 @@ It does not yet support recreating the opal bdevs after application restart. 
This bdev module should be considered very experimental, and the RPCs may

change significantly in future releases.



### bdev zone

### delay bdev



Added new public header for zoned bdev. Zoned bdev is an extension

of the bdev interface.

The `bdev_delay_update_latency` has been added to allow users to update

a latency value for a given delay bdev.



`spdk_bdev_get_zone_size()`, `spdk_bdev_get_max_open_zones()`, `spdk_bdev_get_optimal_open_zones()`

APIs were added for retrieving zoned device information.

`spdk_bdev_get_zone_info()` API was added for retrieving information about zones in zoned

device.

Added `spdk_bdev_zone_management()` API for changing zone state.

`spdk_bdev_zone_append()` and `spdk_bdev_zone_append_with_md()` APIs were added for

appending data to a zone.

Added `spdk_bdev_io_get_append location()` function for retrieving append location for I/O.

### compress bdev



### bdev

A new RPC `bdev_compress_get_orphans` has been added to list compress bdevs

that were not loaded due to a missing pm metadata file. In this state they

can only be deleted.



Added `spdk_bdev_get_write_unit_size()` function for retrieving required number

of logical blocks for write operation.

### null bdev



New zone-related fields were added to the result of the `get_bdevs` RPC call:

 - `zoned`: indicates whether the device is zoned or a regular

   block device

 - `zone_size`: number of blocks in a single zone

 - `max_open_zones`: maximum number of open zones

 - `optimal_open_zones`: optimal number of open zones

The `zoned` field is a boolean and is always present, while the rest is only available for zoned

bdevs.

Metadata support has been added to Null bdev module.



Protection information support has been added to Null bdev module.



### nvme



Added `no_shn_notification` to NVMe controller initialization options, users can enable

it for NVMe controllers.  When the option is enabled, the controller will not do the

shutdown process and just disable the controller, users can start their application

later again to initialize the controller to the ready state.



A controller flag `SPDK_NVME_CTRLR_WRR_SUPPORTED` was added to indicate the controller

can support weighted round robin arbitration feature with submission queue.



Added `arbitration_burst` option for arbitration feature, and added three

`low/medium/high_priority_weight` options for weighted round robin arbitration.



Added `spdk_nvme_ns_cmd_write_uncorrectable`.



Added new error handling and reporting functionality. This includes several

new API functions to facilitate applications recovering when a qpair or

controller fails.



`spdk_nvme_ctrlr_reconnect_io_qpair` - Reconnects a failed I/O qpair.

`spdk_nvme_ctrlr_set_trid` - Sets the trid of an existing controller. Can be used to

change the trid for failover cases.

`spdk_nvme_ctrlr_is_failed` - Returns the failed state of a controller.

`spdk_nvme_ctrlr_fail` - Forces a controller into a failed state.



Modified the return behavior of several API functions to better indicate to

applications when a qpair is failed. This list of functions includes:



`spdk_nvme_qpair_process_completions`

`spdk_nvme_ns_cmd_*`

`spdk_nvme_ctrlr_process_admin_completions`

`spdk_nvme_ctrlr_cmd_*`



These functions now return -ENXIO when the qpair or controller on which they

operate is failed.



### nvmf
@@ -80,17 +140,6 @@ The `spdk_nvmf_tgt_accept` takes additional argument allowing to pass arbitrary 
information to the `new_qpair` callback. This will simplify the code when having multiple

nvmf targets or when retrieving the context information from globals is not suitable.



### bdev



A new spdk_bdev_open_ext function has been added and spdk_bdev_open function has been deprecated.

The new open function introduces requirement to provide callback function that will be called by

asynchronous event such as bdev removal. spdk_bdev_open_ext function takes bdev name as

an argument instead of bdev structure to avoid a race condition that can happen when the bdev

is being removed between a call to get its structure based on a name and actually openning it.



New 'resize' event has been added to notify about change of block count property of block device.

Event is delivered only if block device was opened with spdk_bdev_open_ext function.



### blobstore



A new spdk_bdev_create_bs_dev_from_desc function has been added and spdk_bdev_create_bs_dev
@@ -98,10 +147,6 @@ function has been deprecated. 
The new create function can cowork with spdk_bdev_open_ext function, which provides callback

function that will be called by asynchronous event such as bdev removal.



### DPDK



Updated DPDK submodule to DPDK 19.08.



### blobfs_bdev



A new blobfs module `bdev` has been added to simplify the operations of blobfs on bdev.
@@ -120,42 +165,6 @@ Option to build FUSE components into blobfs_bdev module for mounting a blobfs fi 
It requires the installation of libfuse3. By default, it is disabled. And it will be

enabled if run `./configure` with `--with-fuse` option.



### nvme



Added `no_shn_notification` to NVMe controller initialization options, users can enable

it for NVMe controllers.  When the option is enabled, the controller will not do the

shutdown process and just disable the controller, users can start their application

later again to initialize the controller to the ready state.



A controller flag `SPDK_NVME_CTRLR_WRR_SUPPORTED` was added to indicate the controller

can support weighted round robin arbitration feature with submission queue.



Added `arbitration_burst` option for arbitration feature, and added three

`low/medium/high_priority_weight` options for weighted round robin arbitration.



Added `spdk_nvme_ns_cmd_write_uncorrectable`.



Added new error handling and reporting functionality. This includes several

new API functions to facilitate applications recovering when a qpair or

controller fails.



`spdk_nvme_ctrlr_reconnect_io_qpair` - Reconnects a failed I/O qpair.

`spdk_nvme_ctrlr_set_trid` - Sets the trid of an existing controller. Can be used to

change the trid for failover cases.

`spdk_nvme_ctrlr_is_failed` - Returns the failed state of a controller.

`spdk_nvme_ctrlr_fail` - Forces a controller into a failed state.



Modified the return behavior of several API functions to better indicate to

applications when a qpair is failed. This list of functions includes:



`spdk_nvme_qpair_process_completions`

`spdk_nvme_ns_cmd_*`

`spdk_nvme_ctrlr_process_admin_completions`

`spdk_nvme_ctrlr_cmd_*`



These functions now return -ENXIO when the qpair or controller on which they

operate is failed.



### iSCSI



Portals may no longer be associated with a cpumask. The scheduling of
@@ -165,27 +174,24 @@ An new RPC `iscsi_portal_group_set_auth` has been added to set CHAP authenticati 
for discovery sessions specific for the existing iSCSI portal group. This RPC overwrites

the setting by the global parameters for the iSCSI portal group.



### delay bdev

### event



The `bdev_delay_update_latency` has been added to allow users to update

a latency value for a given delay bdev.

start_subsystem_init RPC no longer stops the application on error during

initialization.



### compress bdev

### DPDK



A new RPC `bdev_compress_get_orphans` has been added to list compress bdevs

that were not loaded due to a missing pm metadata file. In this state they

can only be deleted.

Updated DPDK submodule to DPDK 19.08.



### null bdev

### ocf



Metadata support has been added to Null bdev module.

Updated OCF submodule to OCF v19.06



Protection information support has been added to Null bdev module.

Along with update, new cache mode 'write only' was added.



### event

New cache modes added to use via RPC, wi - write invalidate and wa - write around.



start_subsystem_init RPC no longer stops the application on error during

initialization.

New version of OCF provides fully asynchronous management API.



### rpc
@@ -205,16 +211,6 @@ Added `blobfs_mount` RPC method to mount blobfs on given bdev to a host path by 
Then on the host path, user can directly do some file operations which will be mapped

to blobfs.



### ocf



Updated OCF submodule to OCF v19.06



Along with update, new cache mode 'write only' was added.



New cache modes added to use via RPC, wi - write invalidate and wa - write around.



New version of OCF provides fully asynchronous management API.



## v19.07:



### ftl