Commit 8595ff7b authored by Tomasz Zawadzki's avatar Tomasz Zawadzki
Browse files

CHANGELOG: sort and format existing entries for 21.07 



Sorted current entries and typo/formatting errors in
preparation for SPDK 21.07.

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


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
parent 821d8e26

CHANGELOG.md

+29 −34
Original line number Diff line number Diff line
@@ -2,11 +2,6 @@ 


## v21.07: (Upcoming Release)



### json



Added API `spdk_json_write_named_uint128` and `spdk_json_write_uint128` to perform

the uint128 related data.



### accel_fw



Added API `spdk_accel_submit_copy_crc32c` to perform a CRC32C while copying data.
@@ -17,19 +12,24 @@ Added API `spdk_accel_submit_copy_crc32cv` to submit chained CRC32C + copy comma 


### bdev



Change `spdk_bdev_read_blocks_with_md` arg offset definiton from int64_t to uint64_t.

Change `spdk_bdev_read_blocks_with_md` arg offset definition from int64_t to uint64_t.



Red-black tree has been used to organize the bdev names and aliases uniformly

to provide faster lookup.



Removed ZCOPY emulation: The bdev module can be checked to see if it supports ZCOPY

and if not supported then use existing READ/WRITE commands.



Added iov to spdk_bdev_zcopy_start.



### dpdk



Updated DPDK submodule to DPDK 21.05.



### idxd



Remove the probe_cb parameter in spdk_idxd_probe function. And remove the definition

of spdk_idxd_probe_cb function pointer. It should be implemented in idxd_user.c.

Remove the `probe_cb` parameter in `spdk_idxd_probe` function. And remove the definition

of `spdk_idxd_probe_cb` function pointer. It should be implemented in idxd_user.c.



Added API `spdk_idxd_submit_copy_crc32c` to perform a CRC32C while copying data.
@@ -48,18 +48,10 @@ New parameters, `pdu_pool_size`, `immediate_data_pool_size`, and `data_out_pool_ 
were added to the RPC `iscsi_set_options` to run iSCSI target with varying amount of

available memory.



### util



`spdk_crc32c_iov_update` function was added to support calculating the crc32c of the

iovs.



### nvmf



Added `min_cntlid` and `max_cntlid` to `nvmf_create_subsystem` to limit the controller ID range.



`spdk_nvmf_request_get_buffers_multi` API is removed.

### json



Added the `nvmf_set_crdt` RPC for setting command retry delay times.

Added API `spdk_json_write_named_uint128` and `spdk_json_write_uint128` to perform

the uint128 related data.



### nvme
@@ -68,18 +60,18 @@ as vfio-user is the only user for the above two APIs. 


Added a new function `spdk_nvme_ns_cmd_copy` to submit a Simple Copy Command to a Namespace.



Update the spdk_nvme_generic_command_status_code structure with new status code

according to the definition in nvme 1.4 spec.

Update the `spdk_nvme_generic_command_status_code` structure with new status code

according to the definition in NVMe 1.4 spec.



spdk_nvme_ctrlr_get_default_ctrlr_opts now sets use_cmb_sqs to false. This means

`spdk_nvme_ctrlr_get_default_ctrlr_opts` now sets `use_cmb_sqs` to false. This means

that if a controller has a CMB and supports SQs in the CMB, SPDK will not use

the CMB for SQs by default - the user must set use_cmb_sqs to true in

the spdk_nvme_ctrlr_opts structure prior to controller attach.

the CMB for SQs by default - the user must set `use_cmb_sqs` to true in

the `spdk_nvme_ctrlr_opts` structure prior to controller attach.



Add a new function `spdk_nvme_detach_poll` to simplify a common use case to continue

polling until all detachments complete.



Added new argument 'timeout_admin_us' to 'spdk_nvme_ctrlr_register_timeout_callback' so callers

Added new argument `timeout_admin_us` to `spdk_nvme_ctrlr_register_timeout_callback` so callers

can specify a different timeout for admin commands vs. io commands.



An existing function `spdk_nvme_detach_async` was updated to add one or more detachments
@@ -99,19 +91,27 @@ reset a controller asynchronously. 


New RPC `bdev_nvme_reset_controller` was added, to reset an NVMe controller.



### nvmf



Added `min_cntlid` and `max_cntlid` to `nvmf_create_subsystem` to limit the controller ID range.



`spdk_nvmf_request_get_buffers_multi` API is removed.



Added the `nvmf_set_crdt` RPC for setting command retry delay times.



### rpc



New RPC `bdev_rbd_register_cluster` and `bdev_rbd_unregister_cluster` was added, it allows to create

and delete the rados object cluster, then users can choose the cluster to create related rbd

device.



Revised `bdev_rbd_create` parameter, it allows to use an optional parameter --cluster-name

Revised `bdev_rbd_create` parameter, it allows to use an optional parameter `--cluster-name`

to create a rbd bdev with  an already registered Rados Cluster Object.



New RPC `bdev_rbd_get_clusters_info` was added, it allows to get the info of the registered

Rados Cluster names.



New optional parameter, 'timeout_admin_us', added to the bdev_nvme_set_options RPC.

New optional parameter, `timeout_admin_us`, added to the bdev_nvme_set_options RPC.



Revised a parameter `--stripe-size_kb` to `--stripe-size-kb` of `bdev_raid_create` method

provided in `scripts/rpc.py` for consistency.
@@ -119,13 +119,6 @@ provided in `scripts/rpc.py` for consistency. 
An new optional parameter `config_kernel_mode` was added to the RPC `idxd_scan_accel_engine`,

and this is used to enable using the kernel mode IDXD driver.



### bdev



Removed ZCOPY emulation: The bdev module can be checked to see if it supports ZCOPY

and if not supported then use existing READ/WRITE commands.



Added iov to spdk_bdev_zcopy_start



### thread



Red-black tree has been used for timed pollers to provide faster insertion and deletion
@@ -138,6 +131,8 @@ under the same BSD license. 


Add an new macro `SPDK_SIZEOF_MEMBER` to get the size of a member of a struct.



`spdk_crc32c_iov_update` function was added to support calculating the crc32c of the iovs.



## v21.04:



### accel