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

doc/nvmf_tgt_pg: Update the description about assigning the created qpair to a poll group

Browse Source 
The operation to assign the created qpair to a poll group has been
moved from event library to nvmf library. Update the corresponding
part slightly.

Signed-off-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Change-Id: I80b9b8257b84ba92004baa36a057d1a8cee387bb
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3623
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Shuhei Matsumoto 2020-08-02 07:20:27 +09:00 committed by Jim Harris
parent 4ba5e90176
commit d49d316e63
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/nvmf_tgt_pg.md
View File

@ -91,13 +91,12 @@ spdk_nvmf_poll_group_create(). They automatically request to begin polling
upon creation on the thread from which they were created. Most importantly, *a upon creation on the thread from which they were created. Most importantly, *a
poll group may only be accessed from the thread on which it was created.* poll group may only be accessed from the thread on which it was created.*
When spdk_nvmf_tgt_accept() detects a new connection, it will construct a new When spdk_nvmf_tgt_accept() detects a new connection, it chooses an optimal
struct spdk_nvmf_qpair object and call the user provided `new_qpair_fn` poll group by first calling spdk_nvmf_get_optimal_poll_group(), which calls down
callback for each new qpair. In response to this callback, the user must into the transport, and then assigns the qpair to the optimal poll group by
assign the qpair to a poll group by calling spdk_nvmf_poll_group_add(). calling spdk_nvmf_poll_group_add(). This all happens within the NVMe-oF target
Remember, a poll group may only be accessed from the thread on which it was created, library and the NVMe-oF target application is not required to do anything other
so making a call to spdk_nvmf_poll_group_add() may require passing a message than continue to periodically poll spdk_nvmf_tgt_accept().
to the appropriate thread.
## Access Control ## Access Control