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

doc: add rpc example to bdev doc for crypto

Browse Source 
Initial patch left out example rpc commands to create/delete

Change-Id: I2e705b041bf7f6524625f88625234327a38bfc45
Signed-off-by: paul luse <paul.e.luse@intel.com>
Reviewed-on: https://review.gerrithub.io/425872
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
This commit is contained in:
paul luse 2018-09-17 17:39:10 -04:00 committed by Jim Harris
parent 33aa994855
commit 5968bd6242
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/bdev.md
View File

@ -105,16 +105,6 @@ time the SPDK virtual bdev module supports cipher only as follows:
(Note: QAT is functional however is marked as experimental until the hardware has (Note: QAT is functional however is marked as experimental until the hardware has
been fully integrated with the SPDK CI system.) been fully integrated with the SPDK CI system.)
Support for other DPDK drivers and capabilities may be added programmatically. Existing
functionality is configured through a .conf file as shown here:
[crypto]<br>
\# CRY \<bdev name\> \<vbdev name\> \<key\> \<PMD\><br>
\# key size depends on cipher<br>
\# supported PMD names: crypto_aesni_mb, crypto_qat<br>
\# Note: QAT is experimental while test HW is being setup<br>
CRY Malloc4 crypto_ram 0123456789123456 crypto_aesni_mb
In order to support using the bdev block offset (LBA) as the initialization vector (IV), In order to support using the bdev block offset (LBA) as the initialization vector (IV),
the crypto module break up all I/O into crypto operations of a size equal to the block the crypto module break up all I/O into crypto operations of a size equal to the block
size of the underlying bdev. For example, a 4K I/O to a bdev with a 512B block size, size of the underlying bdev. For example, a 4K I/O to a bdev with a 512B block size,
@ -126,6 +116,18 @@ destination buffer for encryption which is then passed on to the underlying bdev
write buffer. This is done to avoid encrypting the data in the original source buffer which write buffer. This is done to avoid encrypting the data in the original source buffer which
may cause problems in some use cases. may cause problems in some use cases.
Example command
`rpc.py construct_crypto_bdev -b NVMe1n1 -c CryNvmeA -d crypto_aesni_mb -k 0123456789123456`
This command will create a crypto vbdev called 'CryNvmeA' on top of the NVMe bdev
'NVMe1n1' and will use the DPDK software driver 'crypto_aesni_mb' and the key
'0123456789123456'.
To remove the vbdev use the delete_crypto_bdev command.
`rpc.py delete_crypto_bdev CryNvmeA`
# GPT (GUID Partition Table) {#bdev_config_gpt} # GPT (GUID Partition Table) {#bdev_config_gpt}
The GPT virtual bdev driver is enabled by default and does not require any configuration. The GPT virtual bdev driver is enabled by default and does not require any configuration.