2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
4 * Copyright (c) 2005 Topspin Communications. All rights reserved.
5 * Copyright (c) 2005 Intel Corporation. All rights reserved.
7 * This software is available to you under a choice of one of two
8 * licenses. You may choose to be licensed under the terms of the GNU
9 * General Public License (GPL) Version 2, available from the file
10 * COPYING in the main directory of this source tree, or the
11 * OpenIB.org BSD license below:
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
17 * - Redistributions of source code must retain the above
18 * copyright notice, this list of conditions and the following
21 * - Redistributions in binary form must reproduce the above
22 * copyright notice, this list of conditions and the following
23 * disclaimer in the documentation and/or other materials
24 * provided with the distribution.
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
29 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
30 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
31 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
32 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
39 #include <linux/completion.h>
41 #include <linux/module.h>
42 #include <linux/device.h>
43 #include <linux/err.h>
44 #include <linux/poll.h>
45 #include <linux/sched.h>
46 #include <linux/file.h>
47 #include <linux/cdev.h>
48 #include <linux/idr.h>
49 #include <linux/mutex.h>
50 #include <linux/slab.h>
52 #include <asm/uaccess.h>
55 #include <rdma/ib_cm.h>
56 #include <rdma/ib_user_cm.h>
57 #include <rdma/ib_marshall.h>
59 MODULE_AUTHOR("Libor Michalek");
60 MODULE_DESCRIPTION("InfiniBand userspace Connection Manager access");
61 MODULE_LICENSE("Dual BSD/GPL");
63 struct ib_ucm_device {
67 struct ib_device *ib_dev;
71 struct mutex file_mutex;
73 struct ib_ucm_device *device;
75 struct list_head ctxs;
76 struct list_head events;
77 wait_queue_head_t poll_wait;
80 struct ib_ucm_context {
82 struct completion comp;
86 struct ib_ucm_file *file;
87 struct ib_cm_id *cm_id;
90 struct list_head events; /* list of pending events. */
91 struct list_head file_list; /* member in file ctx list */
95 struct ib_ucm_context *ctx;
96 struct list_head file_list; /* member in file event list */
97 struct list_head ctx_list; /* member in ctx event list */
99 struct ib_cm_id *cm_id;
100 struct ib_ucm_event_resp resp;
109 IB_UCM_BASE_MINOR = 224,
110 IB_UCM_MAX_DEVICES = 32
113 #define IB_UCM_BASE_DEV MKDEV(IB_UCM_MAJOR, IB_UCM_BASE_MINOR)
115 static void ib_ucm_add_one(struct ib_device *device);
116 static void ib_ucm_remove_one(struct ib_device *device, void *client_data);
118 static struct ib_client ucm_client = {
120 .add = ib_ucm_add_one,
121 .remove = ib_ucm_remove_one
124 static DEFINE_MUTEX(ctx_id_mutex);
125 static DEFINE_IDR(ctx_id_table);
126 static DECLARE_BITMAP(dev_map, IB_UCM_MAX_DEVICES);
128 static struct ib_ucm_context *ib_ucm_ctx_get(struct ib_ucm_file *file, int id)
130 struct ib_ucm_context *ctx;
132 mutex_lock(&ctx_id_mutex);
133 ctx = idr_find(&ctx_id_table, id);
135 ctx = ERR_PTR(-ENOENT);
136 else if (ctx->file != file)
137 ctx = ERR_PTR(-EINVAL);
139 atomic_inc(&ctx->ref);
140 mutex_unlock(&ctx_id_mutex);
145 static void ib_ucm_ctx_put(struct ib_ucm_context *ctx)
147 if (atomic_dec_and_test(&ctx->ref))
148 complete(&ctx->comp);
151 static inline int ib_ucm_new_cm_id(int event)
153 return event == IB_CM_REQ_RECEIVED || event == IB_CM_SIDR_REQ_RECEIVED;
156 static void ib_ucm_cleanup_events(struct ib_ucm_context *ctx)
158 struct ib_ucm_event *uevent;
160 mutex_lock(&ctx->file->file_mutex);
161 list_del(&ctx->file_list);
162 while (!list_empty(&ctx->events)) {
164 uevent = list_entry(ctx->events.next,
165 struct ib_ucm_event, ctx_list);
166 list_del(&uevent->file_list);
167 list_del(&uevent->ctx_list);
168 mutex_unlock(&ctx->file->file_mutex);
170 /* clear incoming connections. */
171 if (ib_ucm_new_cm_id(uevent->resp.event))
172 ib_destroy_cm_id(uevent->cm_id);
175 mutex_lock(&ctx->file->file_mutex);
177 mutex_unlock(&ctx->file->file_mutex);
180 static struct ib_ucm_context *ib_ucm_ctx_alloc(struct ib_ucm_file *file)
182 struct ib_ucm_context *ctx;
184 ctx = kzalloc(sizeof *ctx, GFP_KERNEL);
188 atomic_set(&ctx->ref, 1);
189 init_completion(&ctx->comp);
191 INIT_LIST_HEAD(&ctx->events);
193 mutex_lock(&ctx_id_mutex);
194 ctx->id = idr_alloc(&ctx_id_table, ctx, 0, 0, GFP_KERNEL);
195 mutex_unlock(&ctx_id_mutex);
199 list_add_tail(&ctx->file_list, &file->ctxs);
207 static void ib_ucm_event_req_get(struct ib_ucm_req_event_resp *ureq,
208 struct ib_cm_req_event_param *kreq)
210 ureq->remote_ca_guid = kreq->remote_ca_guid;
211 ureq->remote_qkey = kreq->remote_qkey;
212 ureq->remote_qpn = kreq->remote_qpn;
213 ureq->qp_type = kreq->qp_type;
214 ureq->starting_psn = kreq->starting_psn;
215 ureq->responder_resources = kreq->responder_resources;
216 ureq->initiator_depth = kreq->initiator_depth;
217 ureq->local_cm_response_timeout = kreq->local_cm_response_timeout;
218 ureq->flow_control = kreq->flow_control;
219 ureq->remote_cm_response_timeout = kreq->remote_cm_response_timeout;
220 ureq->retry_count = kreq->retry_count;
221 ureq->rnr_retry_count = kreq->rnr_retry_count;
222 ureq->srq = kreq->srq;
223 ureq->port = kreq->port;
225 ib_copy_path_rec_to_user(&ureq->primary_path, kreq->primary_path);
226 if (kreq->alternate_path)
227 ib_copy_path_rec_to_user(&ureq->alternate_path,
228 kreq->alternate_path);
231 static void ib_ucm_event_rep_get(struct ib_ucm_rep_event_resp *urep,
232 struct ib_cm_rep_event_param *krep)
234 urep->remote_ca_guid = krep->remote_ca_guid;
235 urep->remote_qkey = krep->remote_qkey;
236 urep->remote_qpn = krep->remote_qpn;
237 urep->starting_psn = krep->starting_psn;
238 urep->responder_resources = krep->responder_resources;
239 urep->initiator_depth = krep->initiator_depth;
240 urep->target_ack_delay = krep->target_ack_delay;
241 urep->failover_accepted = krep->failover_accepted;
242 urep->flow_control = krep->flow_control;
243 urep->rnr_retry_count = krep->rnr_retry_count;
244 urep->srq = krep->srq;
247 static void ib_ucm_event_sidr_rep_get(struct ib_ucm_sidr_rep_event_resp *urep,
248 struct ib_cm_sidr_rep_event_param *krep)
250 urep->status = krep->status;
251 urep->qkey = krep->qkey;
252 urep->qpn = krep->qpn;
255 static int ib_ucm_event_process(struct ib_cm_event *evt,
256 struct ib_ucm_event *uvt)
260 switch (evt->event) {
261 case IB_CM_REQ_RECEIVED:
262 ib_ucm_event_req_get(&uvt->resp.u.req_resp,
263 &evt->param.req_rcvd);
264 uvt->data_len = IB_CM_REQ_PRIVATE_DATA_SIZE;
265 uvt->resp.present = IB_UCM_PRES_PRIMARY;
266 uvt->resp.present |= (evt->param.req_rcvd.alternate_path ?
267 IB_UCM_PRES_ALTERNATE : 0);
269 case IB_CM_REP_RECEIVED:
270 ib_ucm_event_rep_get(&uvt->resp.u.rep_resp,
271 &evt->param.rep_rcvd);
272 uvt->data_len = IB_CM_REP_PRIVATE_DATA_SIZE;
274 case IB_CM_RTU_RECEIVED:
275 uvt->data_len = IB_CM_RTU_PRIVATE_DATA_SIZE;
276 uvt->resp.u.send_status = evt->param.send_status;
278 case IB_CM_DREQ_RECEIVED:
279 uvt->data_len = IB_CM_DREQ_PRIVATE_DATA_SIZE;
280 uvt->resp.u.send_status = evt->param.send_status;
282 case IB_CM_DREP_RECEIVED:
283 uvt->data_len = IB_CM_DREP_PRIVATE_DATA_SIZE;
284 uvt->resp.u.send_status = evt->param.send_status;
286 case IB_CM_MRA_RECEIVED:
287 uvt->resp.u.mra_resp.timeout =
288 evt->param.mra_rcvd.service_timeout;
289 uvt->data_len = IB_CM_MRA_PRIVATE_DATA_SIZE;
291 case IB_CM_REJ_RECEIVED:
292 uvt->resp.u.rej_resp.reason = evt->param.rej_rcvd.reason;
293 uvt->data_len = IB_CM_REJ_PRIVATE_DATA_SIZE;
294 uvt->info_len = evt->param.rej_rcvd.ari_length;
295 info = evt->param.rej_rcvd.ari;
297 case IB_CM_LAP_RECEIVED:
298 ib_copy_path_rec_to_user(&uvt->resp.u.lap_resp.path,
299 evt->param.lap_rcvd.alternate_path);
300 uvt->data_len = IB_CM_LAP_PRIVATE_DATA_SIZE;
301 uvt->resp.present = IB_UCM_PRES_ALTERNATE;
303 case IB_CM_APR_RECEIVED:
304 uvt->resp.u.apr_resp.status = evt->param.apr_rcvd.ap_status;
305 uvt->data_len = IB_CM_APR_PRIVATE_DATA_SIZE;
306 uvt->info_len = evt->param.apr_rcvd.info_len;
307 info = evt->param.apr_rcvd.apr_info;
309 case IB_CM_SIDR_REQ_RECEIVED:
310 uvt->resp.u.sidr_req_resp.pkey =
311 evt->param.sidr_req_rcvd.pkey;
312 uvt->resp.u.sidr_req_resp.port =
313 evt->param.sidr_req_rcvd.port;
314 uvt->data_len = IB_CM_SIDR_REQ_PRIVATE_DATA_SIZE;
316 case IB_CM_SIDR_REP_RECEIVED:
317 ib_ucm_event_sidr_rep_get(&uvt->resp.u.sidr_rep_resp,
318 &evt->param.sidr_rep_rcvd);
319 uvt->data_len = IB_CM_SIDR_REP_PRIVATE_DATA_SIZE;
320 uvt->info_len = evt->param.sidr_rep_rcvd.info_len;
321 info = evt->param.sidr_rep_rcvd.info;
324 uvt->resp.u.send_status = evt->param.send_status;
329 uvt->data = kmemdup(evt->private_data, uvt->data_len, GFP_KERNEL);
333 uvt->resp.present |= IB_UCM_PRES_DATA;
337 uvt->info = kmemdup(info, uvt->info_len, GFP_KERNEL);
341 uvt->resp.present |= IB_UCM_PRES_INFO;
351 static int ib_ucm_event_handler(struct ib_cm_id *cm_id,
352 struct ib_cm_event *event)
354 struct ib_ucm_event *uevent;
355 struct ib_ucm_context *ctx;
358 ctx = cm_id->context;
360 uevent = kzalloc(sizeof *uevent, GFP_KERNEL);
365 uevent->cm_id = cm_id;
366 uevent->resp.uid = ctx->uid;
367 uevent->resp.id = ctx->id;
368 uevent->resp.event = event->event;
370 result = ib_ucm_event_process(event, uevent);
374 mutex_lock(&ctx->file->file_mutex);
375 list_add_tail(&uevent->file_list, &ctx->file->events);
376 list_add_tail(&uevent->ctx_list, &ctx->events);
377 wake_up_interruptible(&ctx->file->poll_wait);
378 mutex_unlock(&ctx->file->file_mutex);
384 /* Destroy new cm_id's */
385 return ib_ucm_new_cm_id(event->event);
388 static ssize_t ib_ucm_event(struct ib_ucm_file *file,
389 const char __user *inbuf,
390 int in_len, int out_len)
392 struct ib_ucm_context *ctx;
393 struct ib_ucm_event_get cmd;
394 struct ib_ucm_event *uevent;
397 if (out_len < sizeof(struct ib_ucm_event_resp))
400 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
403 mutex_lock(&file->file_mutex);
404 while (list_empty(&file->events)) {
405 mutex_unlock(&file->file_mutex);
407 if (file->filp->f_flags & O_NONBLOCK)
410 if (wait_event_interruptible(file->poll_wait,
411 !list_empty(&file->events)))
414 mutex_lock(&file->file_mutex);
417 uevent = list_entry(file->events.next, struct ib_ucm_event, file_list);
419 if (ib_ucm_new_cm_id(uevent->resp.event)) {
420 ctx = ib_ucm_ctx_alloc(file);
426 ctx->cm_id = uevent->cm_id;
427 ctx->cm_id->context = ctx;
428 uevent->resp.id = ctx->id;
431 if (copy_to_user((void __user *)(unsigned long)cmd.response,
432 &uevent->resp, sizeof(uevent->resp))) {
438 if (cmd.data_len < uevent->data_len) {
442 if (copy_to_user((void __user *)(unsigned long)cmd.data,
443 uevent->data, uevent->data_len)) {
450 if (cmd.info_len < uevent->info_len) {
454 if (copy_to_user((void __user *)(unsigned long)cmd.info,
455 uevent->info, uevent->info_len)) {
461 list_del(&uevent->file_list);
462 list_del(&uevent->ctx_list);
463 uevent->ctx->events_reported++;
469 mutex_unlock(&file->file_mutex);
473 static ssize_t ib_ucm_create_id(struct ib_ucm_file *file,
474 const char __user *inbuf,
475 int in_len, int out_len)
477 struct ib_ucm_create_id cmd;
478 struct ib_ucm_create_id_resp resp;
479 struct ib_ucm_context *ctx;
482 if (out_len < sizeof(resp))
485 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
488 mutex_lock(&file->file_mutex);
489 ctx = ib_ucm_ctx_alloc(file);
490 mutex_unlock(&file->file_mutex);
495 ctx->cm_id = ib_create_cm_id(file->device->ib_dev,
496 ib_ucm_event_handler, ctx);
497 if (IS_ERR(ctx->cm_id)) {
498 result = PTR_ERR(ctx->cm_id);
503 if (copy_to_user((void __user *)(unsigned long)cmd.response,
504 &resp, sizeof(resp))) {
511 ib_destroy_cm_id(ctx->cm_id);
513 mutex_lock(&ctx_id_mutex);
514 idr_remove(&ctx_id_table, ctx->id);
515 mutex_unlock(&ctx_id_mutex);
520 static ssize_t ib_ucm_destroy_id(struct ib_ucm_file *file,
521 const char __user *inbuf,
522 int in_len, int out_len)
524 struct ib_ucm_destroy_id cmd;
525 struct ib_ucm_destroy_id_resp resp;
526 struct ib_ucm_context *ctx;
529 if (out_len < sizeof(resp))
532 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
535 mutex_lock(&ctx_id_mutex);
536 ctx = idr_find(&ctx_id_table, cmd.id);
538 ctx = ERR_PTR(-ENOENT);
539 else if (ctx->file != file)
540 ctx = ERR_PTR(-EINVAL);
542 idr_remove(&ctx_id_table, ctx->id);
543 mutex_unlock(&ctx_id_mutex);
549 wait_for_completion(&ctx->comp);
551 /* No new events will be generated after destroying the cm_id. */
552 ib_destroy_cm_id(ctx->cm_id);
553 /* Cleanup events not yet reported to the user. */
554 ib_ucm_cleanup_events(ctx);
556 resp.events_reported = ctx->events_reported;
557 if (copy_to_user((void __user *)(unsigned long)cmd.response,
558 &resp, sizeof(resp)))
565 static ssize_t ib_ucm_attr_id(struct ib_ucm_file *file,
566 const char __user *inbuf,
567 int in_len, int out_len)
569 struct ib_ucm_attr_id_resp resp;
570 struct ib_ucm_attr_id cmd;
571 struct ib_ucm_context *ctx;
574 if (out_len < sizeof(resp))
577 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
580 ctx = ib_ucm_ctx_get(file, cmd.id);
584 resp.service_id = ctx->cm_id->service_id;
585 resp.service_mask = ctx->cm_id->service_mask;
586 resp.local_id = ctx->cm_id->local_id;
587 resp.remote_id = ctx->cm_id->remote_id;
589 if (copy_to_user((void __user *)(unsigned long)cmd.response,
590 &resp, sizeof(resp)))
597 static ssize_t ib_ucm_init_qp_attr(struct ib_ucm_file *file,
598 const char __user *inbuf,
599 int in_len, int out_len)
601 struct ib_uverbs_qp_attr resp;
602 struct ib_ucm_init_qp_attr cmd;
603 struct ib_ucm_context *ctx;
604 struct ib_qp_attr qp_attr;
607 if (out_len < sizeof(resp))
610 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
613 ctx = ib_ucm_ctx_get(file, cmd.id);
617 resp.qp_attr_mask = 0;
618 memset(&qp_attr, 0, sizeof qp_attr);
619 qp_attr.qp_state = cmd.qp_state;
620 result = ib_cm_init_qp_attr(ctx->cm_id, &qp_attr, &resp.qp_attr_mask);
624 ib_copy_qp_attr_to_user(&resp, &qp_attr);
626 if (copy_to_user((void __user *)(unsigned long)cmd.response,
627 &resp, sizeof(resp)))
635 static int ucm_validate_listen(__be64 service_id, __be64 service_mask)
637 service_id &= service_mask;
639 if (((service_id & IB_CMA_SERVICE_ID_MASK) == IB_CMA_SERVICE_ID) ||
640 ((service_id & IB_SDP_SERVICE_ID_MASK) == IB_SDP_SERVICE_ID))
646 static ssize_t ib_ucm_listen(struct ib_ucm_file *file,
647 const char __user *inbuf,
648 int in_len, int out_len)
650 struct ib_ucm_listen cmd;
651 struct ib_ucm_context *ctx;
654 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
657 ctx = ib_ucm_ctx_get(file, cmd.id);
661 result = ucm_validate_listen(cmd.service_id, cmd.service_mask);
665 result = ib_cm_listen(ctx->cm_id, cmd.service_id, cmd.service_mask);
671 static ssize_t ib_ucm_notify(struct ib_ucm_file *file,
672 const char __user *inbuf,
673 int in_len, int out_len)
675 struct ib_ucm_notify cmd;
676 struct ib_ucm_context *ctx;
679 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
682 ctx = ib_ucm_ctx_get(file, cmd.id);
686 result = ib_cm_notify(ctx->cm_id, (enum ib_event_type) cmd.event);
691 static int ib_ucm_alloc_data(const void **dest, u64 src, u32 len)
700 data = memdup_user((void __user *)(unsigned long)src, len);
702 return PTR_ERR(data);
708 static int ib_ucm_path_get(struct ib_sa_path_rec **path, u64 src)
710 struct ib_user_path_rec upath;
711 struct ib_sa_path_rec *sa_path;
718 sa_path = kmalloc(sizeof(*sa_path), GFP_KERNEL);
722 if (copy_from_user(&upath, (void __user *)(unsigned long)src,
729 ib_copy_path_rec_from_user(sa_path, &upath);
734 static ssize_t ib_ucm_send_req(struct ib_ucm_file *file,
735 const char __user *inbuf,
736 int in_len, int out_len)
738 struct ib_cm_req_param param;
739 struct ib_ucm_context *ctx;
740 struct ib_ucm_req cmd;
743 param.private_data = NULL;
744 param.primary_path = NULL;
745 param.alternate_path = NULL;
747 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
750 result = ib_ucm_alloc_data(¶m.private_data, cmd.data, cmd.len);
754 result = ib_ucm_path_get(¶m.primary_path, cmd.primary_path);
758 result = ib_ucm_path_get(¶m.alternate_path, cmd.alternate_path);
762 param.private_data_len = cmd.len;
763 param.service_id = cmd.sid;
764 param.qp_num = cmd.qpn;
765 param.qp_type = cmd.qp_type;
766 param.starting_psn = cmd.psn;
767 param.peer_to_peer = cmd.peer_to_peer;
768 param.responder_resources = cmd.responder_resources;
769 param.initiator_depth = cmd.initiator_depth;
770 param.remote_cm_response_timeout = cmd.remote_cm_response_timeout;
771 param.flow_control = cmd.flow_control;
772 param.local_cm_response_timeout = cmd.local_cm_response_timeout;
773 param.retry_count = cmd.retry_count;
774 param.rnr_retry_count = cmd.rnr_retry_count;
775 param.max_cm_retries = cmd.max_cm_retries;
778 ctx = ib_ucm_ctx_get(file, cmd.id);
780 result = ib_send_cm_req(ctx->cm_id, ¶m);
783 result = PTR_ERR(ctx);
786 kfree(param.private_data);
787 kfree(param.primary_path);
788 kfree(param.alternate_path);
792 static ssize_t ib_ucm_send_rep(struct ib_ucm_file *file,
793 const char __user *inbuf,
794 int in_len, int out_len)
796 struct ib_cm_rep_param param;
797 struct ib_ucm_context *ctx;
798 struct ib_ucm_rep cmd;
801 param.private_data = NULL;
803 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
806 result = ib_ucm_alloc_data(¶m.private_data, cmd.data, cmd.len);
810 param.qp_num = cmd.qpn;
811 param.starting_psn = cmd.psn;
812 param.private_data_len = cmd.len;
813 param.responder_resources = cmd.responder_resources;
814 param.initiator_depth = cmd.initiator_depth;
815 param.failover_accepted = cmd.failover_accepted;
816 param.flow_control = cmd.flow_control;
817 param.rnr_retry_count = cmd.rnr_retry_count;
820 ctx = ib_ucm_ctx_get(file, cmd.id);
823 result = ib_send_cm_rep(ctx->cm_id, ¶m);
826 result = PTR_ERR(ctx);
828 kfree(param.private_data);
832 static ssize_t ib_ucm_send_private_data(struct ib_ucm_file *file,
833 const char __user *inbuf, int in_len,
834 int (*func)(struct ib_cm_id *cm_id,
835 const void *private_data,
836 u8 private_data_len))
838 struct ib_ucm_private_data cmd;
839 struct ib_ucm_context *ctx;
840 const void *private_data = NULL;
843 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
846 result = ib_ucm_alloc_data(&private_data, cmd.data, cmd.len);
850 ctx = ib_ucm_ctx_get(file, cmd.id);
852 result = func(ctx->cm_id, private_data, cmd.len);
855 result = PTR_ERR(ctx);
861 static ssize_t ib_ucm_send_rtu(struct ib_ucm_file *file,
862 const char __user *inbuf,
863 int in_len, int out_len)
865 return ib_ucm_send_private_data(file, inbuf, in_len, ib_send_cm_rtu);
868 static ssize_t ib_ucm_send_dreq(struct ib_ucm_file *file,
869 const char __user *inbuf,
870 int in_len, int out_len)
872 return ib_ucm_send_private_data(file, inbuf, in_len, ib_send_cm_dreq);
875 static ssize_t ib_ucm_send_drep(struct ib_ucm_file *file,
876 const char __user *inbuf,
877 int in_len, int out_len)
879 return ib_ucm_send_private_data(file, inbuf, in_len, ib_send_cm_drep);
882 static ssize_t ib_ucm_send_info(struct ib_ucm_file *file,
883 const char __user *inbuf, int in_len,
884 int (*func)(struct ib_cm_id *cm_id,
891 struct ib_ucm_context *ctx;
892 struct ib_ucm_info cmd;
893 const void *data = NULL;
894 const void *info = NULL;
897 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
900 result = ib_ucm_alloc_data(&data, cmd.data, cmd.data_len);
904 result = ib_ucm_alloc_data(&info, cmd.info, cmd.info_len);
908 ctx = ib_ucm_ctx_get(file, cmd.id);
910 result = func(ctx->cm_id, cmd.status, info, cmd.info_len,
914 result = PTR_ERR(ctx);
922 static ssize_t ib_ucm_send_rej(struct ib_ucm_file *file,
923 const char __user *inbuf,
924 int in_len, int out_len)
926 return ib_ucm_send_info(file, inbuf, in_len, (void *)ib_send_cm_rej);
929 static ssize_t ib_ucm_send_apr(struct ib_ucm_file *file,
930 const char __user *inbuf,
931 int in_len, int out_len)
933 return ib_ucm_send_info(file, inbuf, in_len, (void *)ib_send_cm_apr);
936 static ssize_t ib_ucm_send_mra(struct ib_ucm_file *file,
937 const char __user *inbuf,
938 int in_len, int out_len)
940 struct ib_ucm_context *ctx;
941 struct ib_ucm_mra cmd;
942 const void *data = NULL;
945 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
948 result = ib_ucm_alloc_data(&data, cmd.data, cmd.len);
952 ctx = ib_ucm_ctx_get(file, cmd.id);
954 result = ib_send_cm_mra(ctx->cm_id, cmd.timeout, data, cmd.len);
957 result = PTR_ERR(ctx);
963 static ssize_t ib_ucm_send_lap(struct ib_ucm_file *file,
964 const char __user *inbuf,
965 int in_len, int out_len)
967 struct ib_ucm_context *ctx;
968 struct ib_sa_path_rec *path = NULL;
969 struct ib_ucm_lap cmd;
970 const void *data = NULL;
973 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
976 result = ib_ucm_alloc_data(&data, cmd.data, cmd.len);
980 result = ib_ucm_path_get(&path, cmd.path);
984 ctx = ib_ucm_ctx_get(file, cmd.id);
986 result = ib_send_cm_lap(ctx->cm_id, path, data, cmd.len);
989 result = PTR_ERR(ctx);
997 static ssize_t ib_ucm_send_sidr_req(struct ib_ucm_file *file,
998 const char __user *inbuf,
999 int in_len, int out_len)
1001 struct ib_cm_sidr_req_param param;
1002 struct ib_ucm_context *ctx;
1003 struct ib_ucm_sidr_req cmd;
1006 param.private_data = NULL;
1009 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
1012 result = ib_ucm_alloc_data(¶m.private_data, cmd.data, cmd.len);
1016 result = ib_ucm_path_get(¶m.path, cmd.path);
1020 param.private_data_len = cmd.len;
1021 param.service_id = cmd.sid;
1022 param.timeout_ms = cmd.timeout;
1023 param.max_cm_retries = cmd.max_cm_retries;
1025 ctx = ib_ucm_ctx_get(file, cmd.id);
1027 result = ib_send_cm_sidr_req(ctx->cm_id, ¶m);
1028 ib_ucm_ctx_put(ctx);
1030 result = PTR_ERR(ctx);
1033 kfree(param.private_data);
1038 static ssize_t ib_ucm_send_sidr_rep(struct ib_ucm_file *file,
1039 const char __user *inbuf,
1040 int in_len, int out_len)
1042 struct ib_cm_sidr_rep_param param;
1043 struct ib_ucm_sidr_rep cmd;
1044 struct ib_ucm_context *ctx;
1049 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
1052 result = ib_ucm_alloc_data(¶m.private_data,
1053 cmd.data, cmd.data_len);
1057 result = ib_ucm_alloc_data(¶m.info, cmd.info, cmd.info_len);
1061 param.qp_num = cmd.qpn;
1062 param.qkey = cmd.qkey;
1063 param.status = cmd.status;
1064 param.info_length = cmd.info_len;
1065 param.private_data_len = cmd.data_len;
1067 ctx = ib_ucm_ctx_get(file, cmd.id);
1069 result = ib_send_cm_sidr_rep(ctx->cm_id, ¶m);
1070 ib_ucm_ctx_put(ctx);
1072 result = PTR_ERR(ctx);
1075 kfree(param.private_data);
1080 static ssize_t (*ucm_cmd_table[])(struct ib_ucm_file *file,
1081 const char __user *inbuf,
1082 int in_len, int out_len) = {
1083 [IB_USER_CM_CMD_CREATE_ID] = ib_ucm_create_id,
1084 [IB_USER_CM_CMD_DESTROY_ID] = ib_ucm_destroy_id,
1085 [IB_USER_CM_CMD_ATTR_ID] = ib_ucm_attr_id,
1086 [IB_USER_CM_CMD_LISTEN] = ib_ucm_listen,
1087 [IB_USER_CM_CMD_NOTIFY] = ib_ucm_notify,
1088 [IB_USER_CM_CMD_SEND_REQ] = ib_ucm_send_req,
1089 [IB_USER_CM_CMD_SEND_REP] = ib_ucm_send_rep,
1090 [IB_USER_CM_CMD_SEND_RTU] = ib_ucm_send_rtu,
1091 [IB_USER_CM_CMD_SEND_DREQ] = ib_ucm_send_dreq,
1092 [IB_USER_CM_CMD_SEND_DREP] = ib_ucm_send_drep,
1093 [IB_USER_CM_CMD_SEND_REJ] = ib_ucm_send_rej,
1094 [IB_USER_CM_CMD_SEND_MRA] = ib_ucm_send_mra,
1095 [IB_USER_CM_CMD_SEND_LAP] = ib_ucm_send_lap,
1096 [IB_USER_CM_CMD_SEND_APR] = ib_ucm_send_apr,
1097 [IB_USER_CM_CMD_SEND_SIDR_REQ] = ib_ucm_send_sidr_req,
1098 [IB_USER_CM_CMD_SEND_SIDR_REP] = ib_ucm_send_sidr_rep,
1099 [IB_USER_CM_CMD_EVENT] = ib_ucm_event,
1100 [IB_USER_CM_CMD_INIT_QP_ATTR] = ib_ucm_init_qp_attr,
1103 static ssize_t ib_ucm_write(struct file *filp, const char __user *buf,
1104 size_t len, loff_t *pos)
1106 struct ib_ucm_file *file = filp->private_data;
1107 struct ib_ucm_cmd_hdr hdr;
1110 if (WARN_ON_ONCE(!ib_safe_file_access(filp)))
1113 if (len < sizeof(hdr))
1116 if (copy_from_user(&hdr, buf, sizeof(hdr)))
1119 if (hdr.cmd >= ARRAY_SIZE(ucm_cmd_table))
1122 if (hdr.in + sizeof(hdr) > len)
1125 result = ucm_cmd_table[hdr.cmd](file, buf + sizeof(hdr),
1133 static unsigned int ib_ucm_poll(struct file *filp,
1134 struct poll_table_struct *wait)
1136 struct ib_ucm_file *file = filp->private_data;
1137 unsigned int mask = 0;
1139 poll_wait(filp, &file->poll_wait, wait);
1141 if (!list_empty(&file->events))
1142 mask = POLLIN | POLLRDNORM;
1148 * ib_ucm_open() does not need the BKL:
1150 * - no global state is referred to;
1151 * - there is no ioctl method to race against;
1152 * - no further module initialization is required for open to work
1153 * after the device is registered.
1155 static int ib_ucm_open(struct inode *inode, struct file *filp)
1157 struct ib_ucm_file *file;
1159 file = kmalloc(sizeof(*file), GFP_KERNEL);
1163 INIT_LIST_HEAD(&file->events);
1164 INIT_LIST_HEAD(&file->ctxs);
1165 init_waitqueue_head(&file->poll_wait);
1167 mutex_init(&file->file_mutex);
1169 filp->private_data = file;
1171 file->device = container_of(inode->i_cdev->si_drv1, struct ib_ucm_device, cdev);
1173 return nonseekable_open(inode, filp);
1176 static int ib_ucm_close(struct inode *inode, struct file *filp)
1178 struct ib_ucm_file *file = filp->private_data;
1179 struct ib_ucm_context *ctx;
1181 mutex_lock(&file->file_mutex);
1182 while (!list_empty(&file->ctxs)) {
1183 ctx = list_entry(file->ctxs.next,
1184 struct ib_ucm_context, file_list);
1185 mutex_unlock(&file->file_mutex);
1187 mutex_lock(&ctx_id_mutex);
1188 idr_remove(&ctx_id_table, ctx->id);
1189 mutex_unlock(&ctx_id_mutex);
1191 ib_destroy_cm_id(ctx->cm_id);
1192 ib_ucm_cleanup_events(ctx);
1195 mutex_lock(&file->file_mutex);
1197 mutex_unlock(&file->file_mutex);
1202 static DECLARE_BITMAP(overflow_map, IB_UCM_MAX_DEVICES);
1203 static void ib_ucm_release_dev(struct device *dev)
1205 struct ib_ucm_device *ucm_dev;
1207 ucm_dev = container_of(dev, struct ib_ucm_device, dev);
1208 cdev_del(&ucm_dev->cdev);
1209 if (ucm_dev->devnum < IB_UCM_MAX_DEVICES)
1210 clear_bit(ucm_dev->devnum, dev_map);
1212 clear_bit(ucm_dev->devnum - IB_UCM_MAX_DEVICES, overflow_map);
1216 static const struct file_operations ucm_fops = {
1217 .owner = THIS_MODULE,
1218 .open = ib_ucm_open,
1219 .release = ib_ucm_close,
1220 .write = ib_ucm_write,
1221 .poll = ib_ucm_poll,
1222 .llseek = no_llseek,
1225 static ssize_t show_ibdev(struct device *dev, struct device_attribute *attr,
1228 struct ib_ucm_device *ucm_dev;
1230 ucm_dev = container_of(dev, struct ib_ucm_device, dev);
1231 return sprintf(buf, "%s\n", ucm_dev->ib_dev->name);
1233 static DEVICE_ATTR(ibdev, S_IRUGO, show_ibdev, NULL);
1235 static dev_t overflow_maj;
1236 static int find_overflow_devnum(void)
1240 if (!overflow_maj) {
1241 ret = alloc_chrdev_region(&overflow_maj, 0, IB_UCM_MAX_DEVICES,
1244 pr_err("ucm: couldn't register dynamic device number\n");
1249 ret = find_first_zero_bit(overflow_map, IB_UCM_MAX_DEVICES);
1250 if (ret >= IB_UCM_MAX_DEVICES)
1256 static void ib_ucm_add_one(struct ib_device *device)
1260 struct ib_ucm_device *ucm_dev;
1262 if (!device->alloc_ucontext || !rdma_cap_ib_cm(device, 1))
1265 ucm_dev = kzalloc(sizeof *ucm_dev, GFP_KERNEL);
1269 ucm_dev->ib_dev = device;
1271 devnum = find_first_zero_bit(dev_map, IB_UCM_MAX_DEVICES);
1272 if (devnum >= IB_UCM_MAX_DEVICES) {
1273 devnum = find_overflow_devnum();
1277 ucm_dev->devnum = devnum + IB_UCM_MAX_DEVICES;
1278 base = devnum + overflow_maj;
1279 set_bit(devnum, overflow_map);
1281 ucm_dev->devnum = devnum;
1282 base = devnum + IB_UCM_BASE_DEV;
1283 set_bit(devnum, dev_map);
1286 cdev_init(&ucm_dev->cdev, &ucm_fops);
1287 ucm_dev->cdev.owner = THIS_MODULE;
1288 kobject_set_name(&ucm_dev->cdev.kobj, "ucm%d", ucm_dev->devnum);
1289 if (cdev_add(&ucm_dev->cdev, base, 1))
1292 ucm_dev->dev.class = &cm_class;
1293 ucm_dev->dev.parent = device->dma_device;
1294 ucm_dev->dev.devt = ucm_dev->cdev.dev;
1295 ucm_dev->dev.release = ib_ucm_release_dev;
1296 dev_set_name(&ucm_dev->dev, "ucm%d", ucm_dev->devnum);
1297 if (device_register(&ucm_dev->dev))
1300 if (device_create_file(&ucm_dev->dev, &dev_attr_ibdev))
1303 ib_set_client_data(device, &ucm_client, ucm_dev);
1307 device_unregister(&ucm_dev->dev);
1309 cdev_del(&ucm_dev->cdev);
1310 if (ucm_dev->devnum < IB_UCM_MAX_DEVICES)
1311 clear_bit(devnum, dev_map);
1313 clear_bit(devnum, overflow_map);
1319 static void ib_ucm_remove_one(struct ib_device *device, void *client_data)
1321 struct ib_ucm_device *ucm_dev = client_data;
1326 device_unregister(&ucm_dev->dev);
1329 static CLASS_ATTR_STRING(abi_version, S_IRUGO,
1330 __stringify(IB_USER_CM_ABI_VERSION));
1332 static int __init ib_ucm_init(void)
1336 ret = register_chrdev_region(IB_UCM_BASE_DEV, IB_UCM_MAX_DEVICES,
1339 pr_err("ucm: couldn't register device number\n");
1343 ret = class_create_file(&cm_class, &class_attr_abi_version.attr);
1345 pr_err("ucm: couldn't create abi_version attribute\n");
1349 ret = ib_register_client(&ucm_client);
1351 pr_err("ucm: couldn't register client\n");
1357 class_remove_file(&cm_class, &class_attr_abi_version.attr);
1359 unregister_chrdev_region(IB_UCM_BASE_DEV, IB_UCM_MAX_DEVICES);
1364 static void __exit ib_ucm_cleanup(void)
1366 ib_unregister_client(&ucm_client);
1367 class_remove_file(&cm_class, &class_attr_abi_version.attr);
1368 unregister_chrdev_region(IB_UCM_BASE_DEV, IB_UCM_MAX_DEVICES);
1370 unregister_chrdev_region(overflow_maj, IB_UCM_MAX_DEVICES);
1371 idr_destroy(&ctx_id_table);
1374 module_init_order(ib_ucm_init, SI_ORDER_THIRD);
1375 module_exit(ib_ucm_cleanup);