diff options
| author | Chuck Lever <chuck.lever@oracle.com> | 2018-09-04 11:45:14 -0400 |
|---|---|---|
| committer | Jason Gunthorpe <jgg@mellanox.com> | 2018-09-11 09:21:36 -0600 |
| commit | 4269024639f6ff9a1967c4bfa5a2ba7d9853384a (patch) | |
| tree | dcf92dc11bc62b23deb07b0ef0738e2b62acd5fd /include/rdma | |
| parent | 273993509f05623934dda14a56237738149b2906 (diff) | |
| download | linux-4269024639f6ff9a1967c4bfa5a2ba7d9853384a.tar.gz linux-4269024639f6ff9a1967c4bfa5a2ba7d9853384a.tar.bz2 linux-4269024639f6ff9a1967c4bfa5a2ba7d9853384a.zip | |
RDMA/core: Document CM @event_handler function
Code audit suggests that the RDMA CM event handler callback function is
_always_ invoked in a context that is safe to block. That's important for
consumer implementers to know, so document that in the comment before
rdma_create_id (where the handler function is set up by the consumer).
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
Signed-off-by: Jason Gunthorpe <jgg@mellanox.com>
Diffstat (limited to 'include/rdma')
| -rw-r--r-- | include/rdma/rdma_cm.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/include/rdma/rdma_cm.h b/include/rdma/rdma_cm.h index 5d71a7f51a9f..53d93c7d8e01 100644 --- a/include/rdma/rdma_cm.h +++ b/include/rdma/rdma_cm.h @@ -152,7 +152,11 @@ struct rdma_cm_id *__rdma_create_id(struct net *net, * @ps: RDMA port space. * @qp_type: type of queue pair associated with the id. * - * The id holds a reference on the network namespace until it is destroyed. + * Returns a new rdma_cm_id. The id holds a reference on the network + * namespace until it is destroyed. + * + * The event handler callback serializes on the id's mutex and is + * allowed to sleep. */ #define rdma_create_id(net, event_handler, context, ps, qp_type) \ __rdma_create_id((net), (event_handler), (context), (ps), (qp_type), \ |