diff --git a/CHANGELOG.md b/CHANGELOG.md index 0e9c2895a7..7dd1841a40 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -173,6 +173,7 @@ Added the `nvmf_set_crdt` RPC for setting command retry delay times. Expanded `spdk_nvmf_poll_group_stat` with current qpair count statistics. Removed following deprecated APIs: + - `spdk_nvmf_poll_group_get_stat` (function in `nvmf.h`), - `spdk_nvmf_transport_poll_group_get_stat` (function in `nvmf.h`), - `spdk_nvmf_transport_poll_group_free_stat`(function in `nvmf.h`), @@ -405,6 +406,7 @@ use `disable-zerocopy-send-server` or `disable-zerocopy-send-client` instead. Added cmd_parser.py used to parse the args from argparse. There are two benefit to use command parser: + - Simplify the definition of rpc method. It will reduce the rpc method code. - Make the rpc call more versatile. User can add private args into rpc method. diff --git a/doc/bdevperf.md b/doc/bdevperf.md index 8c5c5828c2..601f6cf66e 100644 --- a/doc/bdevperf.md +++ b/doc/bdevperf.md @@ -73,6 +73,7 @@ length | 100% of bdev size | End I/O at `offset`+`length` on the bdev rw | | Type of I/O pattern Available rw types: + - read - randread - write diff --git a/doc/libraries.md b/doc/libraries.md index 10bb5c0a0f..d509bb74b6 100644 --- a/doc/libraries.md +++ b/doc/libraries.md @@ -22,19 +22,19 @@ are contained in the `module` directory. The libraries in the `lib` directory can be readily divided into four categories: - Utility Libraries: These libraries contain basic, commonly used functions that make more complex -libraries easier to implement. For example, `spdk_log` contains macro definitions that provide a -consistent logging paradigm and `spdk_json` is a general purpose JSON parsing library. + libraries easier to implement. For example, `spdk_log` contains macro definitions that provide a + consistent logging paradigm and `spdk_json` is a general purpose JSON parsing library. - Protocol Libraries: These libraries contain the building blocks for a specific service. For example, -`spdk_nvmf` and `spdk_vhost` each define the storage protocols after which they are named. + `spdk_nvmf` and `spdk_vhost` each define the storage protocols after which they are named. - Storage Service Libraries: These libraries provide a specific abstraction that can be mapped to somewhere -between the physical drive and the filesystem level of your typical storage stack. For example `spdk_bdev` -provides a general block device abstraction layer, `spdk_lvol` provides a logical volume abstraction, -`spdk_blobfs` provides a filesystem abstraction, and `spdk_ftl` provides a flash translation layer -abstraction. + between the physical drive and the filesystem level of your typical storage stack. For example `spdk_bdev` + provides a general block device abstraction layer, `spdk_lvol` provides a logical volume abstraction, + `spdk_blobfs` provides a filesystem abstraction, and `spdk_ftl` provides a flash translation layer + abstraction. - System Libraries: These libraries provide system level services such as a JSON based RPC service -(see `spdk_jsonrpc`) and thread abstractions (see `spdk_thread`). The most notable library in this category -is the `spdk_env_dpdk` library which provides a shim for the underlying Data Plane Development Kit (DPDK) -environment and provides services like memory management. + (see `spdk_jsonrpc`) and thread abstractions (see `spdk_thread`). The most notable library in this category + is the `spdk_env_dpdk` library which provides a shim for the underlying Data Plane Development Kit (DPDK) + environment and provides services like memory management. The one library in the `lib` directory that doesn't fit into the above classification is the `spdk_event` library. This library defines a framework used by the applications contained in the `app` and `example` directories. Much @@ -58,10 +58,10 @@ There are seven sub-directories in the `module` directory which each hold a diff sub-directories can be divided into two types. - plug-in libraries: These libraries are explicitly tied to one of the libraries in the `lib` directory and -are registered with that library at runtime by way of a specific constructor function. The parent library in -the `lib` directory then manages the module directly. These types of libraries each implement a function table -defined by their parent library. The following table shows these directories and their corresponding parent -libraries: + are registered with that library at runtime by way of a specific constructor function. The parent library in + the `lib` directory then manages the module directly. These types of libraries each implement a function table + defined by their parent library. The following table shows these directories and their corresponding parent + libraries: