2 * Copyright (c) 2005 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005 Intel Corporation. All rights reserved.
5 * This software is available to you under a choice of one of two
6 * licenses. You may choose to be licensed under the terms of the GNU
7 * General Public License (GPL) Version 2, available from the file
8 * COPYING in the main directory of this source tree, or the
9 * OpenIB.org BSD license below:
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
15 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials
22 * provided with the distribution.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
34 #include <linux/completion.h>
35 #include <linux/init.h>
37 #include <linux/module.h>
38 #include <linux/device.h>
39 #include <linux/err.h>
40 #include <linux/poll.h>
41 #include <linux/sched.h>
42 #include <linux/file.h>
43 #include <linux/mount.h>
44 #include <linux/cdev.h>
45 #include <linux/idr.h>
46 #include <linux/mutex.h>
47 #include <linux/slab.h>
49 #include <linux/nospec.h>
51 #include <linux/uaccess.h>
54 #include <rdma/ib_cm.h>
55 #include <rdma/ib_user_cm.h>
56 #include <rdma/ib_marshall.h>
58 #include "core_priv.h"
60 MODULE_AUTHOR("Libor Michalek");
61 MODULE_DESCRIPTION("InfiniBand userspace Connection Manager access");
62 MODULE_LICENSE("Dual BSD/GPL");
64 struct ib_ucm_device {
68 struct ib_device *ib_dev;
72 struct mutex file_mutex;
74 struct ib_ucm_device *device;
76 struct list_head ctxs;
77 struct list_head events;
78 wait_queue_head_t poll_wait;
81 struct ib_ucm_context {
83 struct completion comp;
87 struct ib_ucm_file *file;
88 struct ib_cm_id *cm_id;
91 struct list_head events; /* list of pending events. */
92 struct list_head file_list; /* member in file ctx list */
96 struct ib_ucm_context *ctx;
97 struct list_head file_list; /* member in file event list */
98 struct list_head ctx_list; /* member in ctx event list */
100 struct ib_cm_id *cm_id;
101 struct ib_ucm_event_resp resp;
110 IB_UCM_BASE_MINOR = 224,
111 IB_UCM_MAX_DEVICES = RDMA_MAX_PORTS,
112 IB_UCM_NUM_FIXED_MINOR = 32,
113 IB_UCM_NUM_DYNAMIC_MINOR = IB_UCM_MAX_DEVICES - IB_UCM_NUM_FIXED_MINOR,
116 #define IB_UCM_BASE_DEV MKDEV(IB_UCM_MAJOR, IB_UCM_BASE_MINOR)
117 static dev_t dynamic_ucm_dev;
119 static void ib_ucm_add_one(struct ib_device *device);
120 static void ib_ucm_remove_one(struct ib_device *device, void *client_data);
122 static struct ib_client ucm_client = {
124 .add = ib_ucm_add_one,
125 .remove = ib_ucm_remove_one
128 static DEFINE_MUTEX(ctx_id_mutex);
129 static DEFINE_IDR(ctx_id_table);
130 static DECLARE_BITMAP(dev_map, IB_UCM_MAX_DEVICES);
132 static struct ib_ucm_context *ib_ucm_ctx_get(struct ib_ucm_file *file, int id)
134 struct ib_ucm_context *ctx;
136 mutex_lock(&ctx_id_mutex);
137 ctx = idr_find(&ctx_id_table, id);
139 ctx = ERR_PTR(-ENOENT);
140 else if (ctx->file != file)
141 ctx = ERR_PTR(-EINVAL);
143 atomic_inc(&ctx->ref);
144 mutex_unlock(&ctx_id_mutex);
149 static void ib_ucm_ctx_put(struct ib_ucm_context *ctx)
151 if (atomic_dec_and_test(&ctx->ref))
152 complete(&ctx->comp);
155 static inline int ib_ucm_new_cm_id(int event)
157 return event == IB_CM_REQ_RECEIVED || event == IB_CM_SIDR_REQ_RECEIVED;
160 static void ib_ucm_cleanup_events(struct ib_ucm_context *ctx)
162 struct ib_ucm_event *uevent;
164 mutex_lock(&ctx->file->file_mutex);
165 list_del(&ctx->file_list);
166 while (!list_empty(&ctx->events)) {
168 uevent = list_entry(ctx->events.next,
169 struct ib_ucm_event, ctx_list);
170 list_del(&uevent->file_list);
171 list_del(&uevent->ctx_list);
172 mutex_unlock(&ctx->file->file_mutex);
174 /* clear incoming connections. */
175 if (ib_ucm_new_cm_id(uevent->resp.event))
176 ib_destroy_cm_id(uevent->cm_id);
179 mutex_lock(&ctx->file->file_mutex);
181 mutex_unlock(&ctx->file->file_mutex);
184 static struct ib_ucm_context *ib_ucm_ctx_alloc(struct ib_ucm_file *file)
186 struct ib_ucm_context *ctx;
188 ctx = kzalloc(sizeof *ctx, GFP_KERNEL);
192 atomic_set(&ctx->ref, 1);
193 init_completion(&ctx->comp);
195 INIT_LIST_HEAD(&ctx->events);
197 mutex_lock(&ctx_id_mutex);
198 ctx->id = idr_alloc(&ctx_id_table, ctx, 0, 0, GFP_KERNEL);
199 mutex_unlock(&ctx_id_mutex);
203 list_add_tail(&ctx->file_list, &file->ctxs);
211 static void ib_ucm_event_req_get(struct ib_ucm_req_event_resp *ureq,
212 const struct ib_cm_req_event_param *kreq)
214 ureq->remote_ca_guid = kreq->remote_ca_guid;
215 ureq->remote_qkey = kreq->remote_qkey;
216 ureq->remote_qpn = kreq->remote_qpn;
217 ureq->qp_type = kreq->qp_type;
218 ureq->starting_psn = kreq->starting_psn;
219 ureq->responder_resources = kreq->responder_resources;
220 ureq->initiator_depth = kreq->initiator_depth;
221 ureq->local_cm_response_timeout = kreq->local_cm_response_timeout;
222 ureq->flow_control = kreq->flow_control;
223 ureq->remote_cm_response_timeout = kreq->remote_cm_response_timeout;
224 ureq->retry_count = kreq->retry_count;
225 ureq->rnr_retry_count = kreq->rnr_retry_count;
226 ureq->srq = kreq->srq;
227 ureq->port = kreq->port;
229 ib_copy_path_rec_to_user(&ureq->primary_path, kreq->primary_path);
230 if (kreq->alternate_path)
231 ib_copy_path_rec_to_user(&ureq->alternate_path,
232 kreq->alternate_path);
235 static void ib_ucm_event_rep_get(struct ib_ucm_rep_event_resp *urep,
236 const struct ib_cm_rep_event_param *krep)
238 urep->remote_ca_guid = krep->remote_ca_guid;
239 urep->remote_qkey = krep->remote_qkey;
240 urep->remote_qpn = krep->remote_qpn;
241 urep->starting_psn = krep->starting_psn;
242 urep->responder_resources = krep->responder_resources;
243 urep->initiator_depth = krep->initiator_depth;
244 urep->target_ack_delay = krep->target_ack_delay;
245 urep->failover_accepted = krep->failover_accepted;
246 urep->flow_control = krep->flow_control;
247 urep->rnr_retry_count = krep->rnr_retry_count;
248 urep->srq = krep->srq;
251 static void ib_ucm_event_sidr_rep_get(struct ib_ucm_sidr_rep_event_resp *urep,
252 const struct ib_cm_sidr_rep_event_param *krep)
254 urep->status = krep->status;
255 urep->qkey = krep->qkey;
256 urep->qpn = krep->qpn;
259 static int ib_ucm_event_process(const struct ib_cm_event *evt,
260 struct ib_ucm_event *uvt)
264 switch (evt->event) {
265 case IB_CM_REQ_RECEIVED:
266 ib_ucm_event_req_get(&uvt->resp.u.req_resp,
267 &evt->param.req_rcvd);
268 uvt->data_len = IB_CM_REQ_PRIVATE_DATA_SIZE;
269 uvt->resp.present = IB_UCM_PRES_PRIMARY;
270 uvt->resp.present |= (evt->param.req_rcvd.alternate_path ?
271 IB_UCM_PRES_ALTERNATE : 0);
273 case IB_CM_REP_RECEIVED:
274 ib_ucm_event_rep_get(&uvt->resp.u.rep_resp,
275 &evt->param.rep_rcvd);
276 uvt->data_len = IB_CM_REP_PRIVATE_DATA_SIZE;
278 case IB_CM_RTU_RECEIVED:
279 uvt->data_len = IB_CM_RTU_PRIVATE_DATA_SIZE;
280 uvt->resp.u.send_status = evt->param.send_status;
282 case IB_CM_DREQ_RECEIVED:
283 uvt->data_len = IB_CM_DREQ_PRIVATE_DATA_SIZE;
284 uvt->resp.u.send_status = evt->param.send_status;
286 case IB_CM_DREP_RECEIVED:
287 uvt->data_len = IB_CM_DREP_PRIVATE_DATA_SIZE;
288 uvt->resp.u.send_status = evt->param.send_status;
290 case IB_CM_MRA_RECEIVED:
291 uvt->resp.u.mra_resp.timeout =
292 evt->param.mra_rcvd.service_timeout;
293 uvt->data_len = IB_CM_MRA_PRIVATE_DATA_SIZE;
295 case IB_CM_REJ_RECEIVED:
296 uvt->resp.u.rej_resp.reason = evt->param.rej_rcvd.reason;
297 uvt->data_len = IB_CM_REJ_PRIVATE_DATA_SIZE;
298 uvt->info_len = evt->param.rej_rcvd.ari_length;
299 info = evt->param.rej_rcvd.ari;
301 case IB_CM_LAP_RECEIVED:
302 ib_copy_path_rec_to_user(&uvt->resp.u.lap_resp.path,
303 evt->param.lap_rcvd.alternate_path);
304 uvt->data_len = IB_CM_LAP_PRIVATE_DATA_SIZE;
305 uvt->resp.present = IB_UCM_PRES_ALTERNATE;
307 case IB_CM_APR_RECEIVED:
308 uvt->resp.u.apr_resp.status = evt->param.apr_rcvd.ap_status;
309 uvt->data_len = IB_CM_APR_PRIVATE_DATA_SIZE;
310 uvt->info_len = evt->param.apr_rcvd.info_len;
311 info = evt->param.apr_rcvd.apr_info;
313 case IB_CM_SIDR_REQ_RECEIVED:
314 uvt->resp.u.sidr_req_resp.pkey =
315 evt->param.sidr_req_rcvd.pkey;
316 uvt->resp.u.sidr_req_resp.port =
317 evt->param.sidr_req_rcvd.port;
318 uvt->data_len = IB_CM_SIDR_REQ_PRIVATE_DATA_SIZE;
320 case IB_CM_SIDR_REP_RECEIVED:
321 ib_ucm_event_sidr_rep_get(&uvt->resp.u.sidr_rep_resp,
322 &evt->param.sidr_rep_rcvd);
323 uvt->data_len = IB_CM_SIDR_REP_PRIVATE_DATA_SIZE;
324 uvt->info_len = evt->param.sidr_rep_rcvd.info_len;
325 info = evt->param.sidr_rep_rcvd.info;
328 uvt->resp.u.send_status = evt->param.send_status;
333 uvt->data = kmemdup(evt->private_data, uvt->data_len, GFP_KERNEL);
337 uvt->resp.present |= IB_UCM_PRES_DATA;
341 uvt->info = kmemdup(info, uvt->info_len, GFP_KERNEL);
345 uvt->resp.present |= IB_UCM_PRES_INFO;
355 static int ib_ucm_event_handler(struct ib_cm_id *cm_id,
356 const struct ib_cm_event *event)
358 struct ib_ucm_event *uevent;
359 struct ib_ucm_context *ctx;
362 ctx = cm_id->context;
364 uevent = kzalloc(sizeof *uevent, GFP_KERNEL);
369 uevent->cm_id = cm_id;
370 uevent->resp.uid = ctx->uid;
371 uevent->resp.id = ctx->id;
372 uevent->resp.event = event->event;
374 result = ib_ucm_event_process(event, uevent);
378 mutex_lock(&ctx->file->file_mutex);
379 list_add_tail(&uevent->file_list, &ctx->file->events);
380 list_add_tail(&uevent->ctx_list, &ctx->events);
381 wake_up_interruptible(&ctx->file->poll_wait);
382 mutex_unlock(&ctx->file->file_mutex);
388 /* Destroy new cm_id's */
389 return ib_ucm_new_cm_id(event->event);
392 static ssize_t ib_ucm_event(struct ib_ucm_file *file,
393 const char __user *inbuf,
394 int in_len, int out_len)
396 struct ib_ucm_context *ctx;
397 struct ib_ucm_event_get cmd;
398 struct ib_ucm_event *uevent;
401 if (out_len < sizeof(struct ib_ucm_event_resp))
404 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
407 mutex_lock(&file->file_mutex);
408 while (list_empty(&file->events)) {
409 mutex_unlock(&file->file_mutex);
411 if (file->filp->f_flags & O_NONBLOCK)
414 if (wait_event_interruptible(file->poll_wait,
415 !list_empty(&file->events)))
418 mutex_lock(&file->file_mutex);
421 uevent = list_entry(file->events.next, struct ib_ucm_event, file_list);
423 if (ib_ucm_new_cm_id(uevent->resp.event)) {
424 ctx = ib_ucm_ctx_alloc(file);
430 ctx->cm_id = uevent->cm_id;
431 ctx->cm_id->context = ctx;
432 uevent->resp.id = ctx->id;
435 if (copy_to_user(u64_to_user_ptr(cmd.response),
436 &uevent->resp, sizeof(uevent->resp))) {
442 if (cmd.data_len < uevent->data_len) {
446 if (copy_to_user(u64_to_user_ptr(cmd.data),
447 uevent->data, uevent->data_len)) {
454 if (cmd.info_len < uevent->info_len) {
458 if (copy_to_user(u64_to_user_ptr(cmd.info),
459 uevent->info, uevent->info_len)) {
465 list_del(&uevent->file_list);
466 list_del(&uevent->ctx_list);
467 uevent->ctx->events_reported++;
473 mutex_unlock(&file->file_mutex);
477 static ssize_t ib_ucm_create_id(struct ib_ucm_file *file,
478 const char __user *inbuf,
479 int in_len, int out_len)
481 struct ib_ucm_create_id cmd;
482 struct ib_ucm_create_id_resp resp;
483 struct ib_ucm_context *ctx;
486 if (out_len < sizeof(resp))
489 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
492 mutex_lock(&file->file_mutex);
493 ctx = ib_ucm_ctx_alloc(file);
494 mutex_unlock(&file->file_mutex);
499 ctx->cm_id = ib_create_cm_id(file->device->ib_dev,
500 ib_ucm_event_handler, ctx);
501 if (IS_ERR(ctx->cm_id)) {
502 result = PTR_ERR(ctx->cm_id);
507 if (copy_to_user(u64_to_user_ptr(cmd.response),
508 &resp, sizeof(resp))) {
515 ib_destroy_cm_id(ctx->cm_id);
517 mutex_lock(&ctx_id_mutex);
518 idr_remove(&ctx_id_table, ctx->id);
519 mutex_unlock(&ctx_id_mutex);
524 static ssize_t ib_ucm_destroy_id(struct ib_ucm_file *file,
525 const char __user *inbuf,
526 int in_len, int out_len)
528 struct ib_ucm_destroy_id cmd;
529 struct ib_ucm_destroy_id_resp resp;
530 struct ib_ucm_context *ctx;
533 if (out_len < sizeof(resp))
536 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
539 mutex_lock(&ctx_id_mutex);
540 ctx = idr_find(&ctx_id_table, cmd.id);
542 ctx = ERR_PTR(-ENOENT);
543 else if (ctx->file != file)
544 ctx = ERR_PTR(-EINVAL);
546 idr_remove(&ctx_id_table, ctx->id);
547 mutex_unlock(&ctx_id_mutex);
553 wait_for_completion(&ctx->comp);
555 /* No new events will be generated after destroying the cm_id. */
556 ib_destroy_cm_id(ctx->cm_id);
557 /* Cleanup events not yet reported to the user. */
558 ib_ucm_cleanup_events(ctx);
560 resp.events_reported = ctx->events_reported;
561 if (copy_to_user(u64_to_user_ptr(cmd.response),
562 &resp, sizeof(resp)))
569 static ssize_t ib_ucm_attr_id(struct ib_ucm_file *file,
570 const char __user *inbuf,
571 int in_len, int out_len)
573 struct ib_ucm_attr_id_resp resp;
574 struct ib_ucm_attr_id cmd;
575 struct ib_ucm_context *ctx;
578 if (out_len < sizeof(resp))
581 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
584 ctx = ib_ucm_ctx_get(file, cmd.id);
588 resp.service_id = ctx->cm_id->service_id;
589 resp.service_mask = ctx->cm_id->service_mask;
590 resp.local_id = ctx->cm_id->local_id;
591 resp.remote_id = ctx->cm_id->remote_id;
593 if (copy_to_user(u64_to_user_ptr(cmd.response),
594 &resp, sizeof(resp)))
601 static ssize_t ib_ucm_init_qp_attr(struct ib_ucm_file *file,
602 const char __user *inbuf,
603 int in_len, int out_len)
605 struct ib_uverbs_qp_attr resp;
606 struct ib_ucm_init_qp_attr cmd;
607 struct ib_ucm_context *ctx;
608 struct ib_qp_attr qp_attr;
611 if (out_len < sizeof(resp))
614 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
617 ctx = ib_ucm_ctx_get(file, cmd.id);
621 resp.qp_attr_mask = 0;
622 memset(&qp_attr, 0, sizeof qp_attr);
623 qp_attr.qp_state = cmd.qp_state;
624 result = ib_cm_init_qp_attr(ctx->cm_id, &qp_attr, &resp.qp_attr_mask);
628 ib_copy_qp_attr_to_user(ctx->cm_id->device, &resp, &qp_attr);
630 if (copy_to_user(u64_to_user_ptr(cmd.response),
631 &resp, sizeof(resp)))
639 static int ucm_validate_listen(__be64 service_id, __be64 service_mask)
641 service_id &= service_mask;
643 if (((service_id & IB_CMA_SERVICE_ID_MASK) == IB_CMA_SERVICE_ID) ||
644 ((service_id & IB_SDP_SERVICE_ID_MASK) == IB_SDP_SERVICE_ID))
650 static ssize_t ib_ucm_listen(struct ib_ucm_file *file,
651 const char __user *inbuf,
652 int in_len, int out_len)
654 struct ib_ucm_listen cmd;
655 struct ib_ucm_context *ctx;
658 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
661 ctx = ib_ucm_ctx_get(file, cmd.id);
665 result = ucm_validate_listen(cmd.service_id, cmd.service_mask);
669 result = ib_cm_listen(ctx->cm_id, cmd.service_id, cmd.service_mask);
675 static ssize_t ib_ucm_notify(struct ib_ucm_file *file,
676 const char __user *inbuf,
677 int in_len, int out_len)
679 struct ib_ucm_notify cmd;
680 struct ib_ucm_context *ctx;
683 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
686 ctx = ib_ucm_ctx_get(file, cmd.id);
690 result = ib_cm_notify(ctx->cm_id, (enum ib_event_type) cmd.event);
695 static int ib_ucm_alloc_data(const void **dest, u64 src, u32 len)
704 data = memdup_user(u64_to_user_ptr(src), len);
706 return PTR_ERR(data);
712 static int ib_ucm_path_get(struct sa_path_rec **path, u64 src)
714 struct ib_user_path_rec upath;
715 struct sa_path_rec *sa_path;
722 sa_path = kmalloc(sizeof(*sa_path), GFP_KERNEL);
726 if (copy_from_user(&upath, u64_to_user_ptr(src),
733 ib_copy_path_rec_from_user(sa_path, &upath);
738 static ssize_t ib_ucm_send_req(struct ib_ucm_file *file,
739 const char __user *inbuf,
740 int in_len, int out_len)
742 struct ib_cm_req_param param;
743 struct ib_ucm_context *ctx;
744 struct ib_ucm_req cmd;
747 param.private_data = NULL;
748 param.primary_path = NULL;
749 param.alternate_path = NULL;
751 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
754 result = ib_ucm_alloc_data(¶m.private_data, cmd.data, cmd.len);
758 result = ib_ucm_path_get(¶m.primary_path, cmd.primary_path);
762 result = ib_ucm_path_get(¶m.alternate_path, cmd.alternate_path);
766 param.private_data_len = cmd.len;
767 param.service_id = cmd.sid;
768 param.qp_num = cmd.qpn;
769 param.qp_type = cmd.qp_type;
770 param.starting_psn = cmd.psn;
771 param.peer_to_peer = cmd.peer_to_peer;
772 param.responder_resources = cmd.responder_resources;
773 param.initiator_depth = cmd.initiator_depth;
774 param.remote_cm_response_timeout = cmd.remote_cm_response_timeout;
775 param.flow_control = cmd.flow_control;
776 param.local_cm_response_timeout = cmd.local_cm_response_timeout;
777 param.retry_count = cmd.retry_count;
778 param.rnr_retry_count = cmd.rnr_retry_count;
779 param.max_cm_retries = cmd.max_cm_retries;
782 ctx = ib_ucm_ctx_get(file, cmd.id);
784 result = ib_send_cm_req(ctx->cm_id, ¶m);
787 result = PTR_ERR(ctx);
790 kfree(param.private_data);
791 kfree(param.primary_path);
792 kfree(param.alternate_path);
796 static ssize_t ib_ucm_send_rep(struct ib_ucm_file *file,
797 const char __user *inbuf,
798 int in_len, int out_len)
800 struct ib_cm_rep_param param;
801 struct ib_ucm_context *ctx;
802 struct ib_ucm_rep cmd;
805 param.private_data = NULL;
807 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
810 result = ib_ucm_alloc_data(¶m.private_data, cmd.data, cmd.len);
814 param.qp_num = cmd.qpn;
815 param.starting_psn = cmd.psn;
816 param.private_data_len = cmd.len;
817 param.responder_resources = cmd.responder_resources;
818 param.initiator_depth = cmd.initiator_depth;
819 param.failover_accepted = cmd.failover_accepted;
820 param.flow_control = cmd.flow_control;
821 param.rnr_retry_count = cmd.rnr_retry_count;
824 ctx = ib_ucm_ctx_get(file, cmd.id);
827 result = ib_send_cm_rep(ctx->cm_id, ¶m);
830 result = PTR_ERR(ctx);
832 kfree(param.private_data);
836 static ssize_t ib_ucm_send_private_data(struct ib_ucm_file *file,
837 const char __user *inbuf, int in_len,
838 int (*func)(struct ib_cm_id *cm_id,
839 const void *private_data,
840 u8 private_data_len))
842 struct ib_ucm_private_data cmd;
843 struct ib_ucm_context *ctx;
844 const void *private_data = NULL;
847 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
850 result = ib_ucm_alloc_data(&private_data, cmd.data, cmd.len);
854 ctx = ib_ucm_ctx_get(file, cmd.id);
856 result = func(ctx->cm_id, private_data, cmd.len);
859 result = PTR_ERR(ctx);
865 static ssize_t ib_ucm_send_rtu(struct ib_ucm_file *file,
866 const char __user *inbuf,
867 int in_len, int out_len)
869 return ib_ucm_send_private_data(file, inbuf, in_len, ib_send_cm_rtu);
872 static ssize_t ib_ucm_send_dreq(struct ib_ucm_file *file,
873 const char __user *inbuf,
874 int in_len, int out_len)
876 return ib_ucm_send_private_data(file, inbuf, in_len, ib_send_cm_dreq);
879 static ssize_t ib_ucm_send_drep(struct ib_ucm_file *file,
880 const char __user *inbuf,
881 int in_len, int out_len)
883 return ib_ucm_send_private_data(file, inbuf, in_len, ib_send_cm_drep);
886 static ssize_t ib_ucm_send_info(struct ib_ucm_file *file,
887 const char __user *inbuf, int in_len,
888 int (*func)(struct ib_cm_id *cm_id,
895 struct ib_ucm_context *ctx;
896 struct ib_ucm_info cmd;
897 const void *data = NULL;
898 const void *info = NULL;
901 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
904 result = ib_ucm_alloc_data(&data, cmd.data, cmd.data_len);
908 result = ib_ucm_alloc_data(&info, cmd.info, cmd.info_len);
912 ctx = ib_ucm_ctx_get(file, cmd.id);
914 result = func(ctx->cm_id, cmd.status, info, cmd.info_len,
918 result = PTR_ERR(ctx);
926 static ssize_t ib_ucm_send_rej(struct ib_ucm_file *file,
927 const char __user *inbuf,
928 int in_len, int out_len)
930 return ib_ucm_send_info(file, inbuf, in_len, (void *)ib_send_cm_rej);
933 static ssize_t ib_ucm_send_apr(struct ib_ucm_file *file,
934 const char __user *inbuf,
935 int in_len, int out_len)
937 return ib_ucm_send_info(file, inbuf, in_len, (void *)ib_send_cm_apr);
940 static ssize_t ib_ucm_send_mra(struct ib_ucm_file *file,
941 const char __user *inbuf,
942 int in_len, int out_len)
944 struct ib_ucm_context *ctx;
945 struct ib_ucm_mra cmd;
946 const void *data = NULL;
949 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
952 result = ib_ucm_alloc_data(&data, cmd.data, cmd.len);
956 ctx = ib_ucm_ctx_get(file, cmd.id);
958 result = ib_send_cm_mra(ctx->cm_id, cmd.timeout, data, cmd.len);
961 result = PTR_ERR(ctx);
967 static ssize_t ib_ucm_send_lap(struct ib_ucm_file *file,
968 const char __user *inbuf,
969 int in_len, int out_len)
971 struct ib_ucm_context *ctx;
972 struct sa_path_rec *path = NULL;
973 struct ib_ucm_lap cmd;
974 const void *data = NULL;
977 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
980 result = ib_ucm_alloc_data(&data, cmd.data, cmd.len);
984 result = ib_ucm_path_get(&path, cmd.path);
988 ctx = ib_ucm_ctx_get(file, cmd.id);
990 result = ib_send_cm_lap(ctx->cm_id, path, data, cmd.len);
993 result = PTR_ERR(ctx);
1001 static ssize_t ib_ucm_send_sidr_req(struct ib_ucm_file *file,
1002 const char __user *inbuf,
1003 int in_len, int out_len)
1005 struct ib_cm_sidr_req_param param = {};
1006 struct ib_ucm_context *ctx;
1007 struct ib_ucm_sidr_req cmd;
1010 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
1013 result = ib_ucm_alloc_data(¶m.private_data, cmd.data, cmd.len);
1017 result = ib_ucm_path_get(¶m.path, cmd.path);
1021 param.private_data_len = cmd.len;
1022 param.service_id = cmd.sid;
1023 param.timeout_ms = cmd.timeout;
1024 param.max_cm_retries = cmd.max_cm_retries;
1026 ctx = ib_ucm_ctx_get(file, cmd.id);
1028 result = ib_send_cm_sidr_req(ctx->cm_id, ¶m);
1029 ib_ucm_ctx_put(ctx);
1031 result = PTR_ERR(ctx);
1034 kfree(param.private_data);
1039 static ssize_t ib_ucm_send_sidr_rep(struct ib_ucm_file *file,
1040 const char __user *inbuf,
1041 int in_len, int out_len)
1043 struct ib_cm_sidr_rep_param param;
1044 struct ib_ucm_sidr_rep cmd;
1045 struct ib_ucm_context *ctx;
1050 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
1053 result = ib_ucm_alloc_data(¶m.private_data,
1054 cmd.data, cmd.data_len);
1058 result = ib_ucm_alloc_data(¶m.info, cmd.info, cmd.info_len);
1062 param.qp_num = cmd.qpn;
1063 param.qkey = cmd.qkey;
1064 param.status = cmd.status;
1065 param.info_length = cmd.info_len;
1066 param.private_data_len = cmd.data_len;
1068 ctx = ib_ucm_ctx_get(file, cmd.id);
1070 result = ib_send_cm_sidr_rep(ctx->cm_id, ¶m);
1071 ib_ucm_ctx_put(ctx);
1073 result = PTR_ERR(ctx);
1076 kfree(param.private_data);
1081 static ssize_t (*ucm_cmd_table[])(struct ib_ucm_file *file,
1082 const char __user *inbuf,
1083 int in_len, int out_len) = {
1084 [IB_USER_CM_CMD_CREATE_ID] = ib_ucm_create_id,
1085 [IB_USER_CM_CMD_DESTROY_ID] = ib_ucm_destroy_id,
1086 [IB_USER_CM_CMD_ATTR_ID] = ib_ucm_attr_id,
1087 [IB_USER_CM_CMD_LISTEN] = ib_ucm_listen,
1088 [IB_USER_CM_CMD_NOTIFY] = ib_ucm_notify,
1089 [IB_USER_CM_CMD_SEND_REQ] = ib_ucm_send_req,
1090 [IB_USER_CM_CMD_SEND_REP] = ib_ucm_send_rep,
1091 [IB_USER_CM_CMD_SEND_RTU] = ib_ucm_send_rtu,
1092 [IB_USER_CM_CMD_SEND_DREQ] = ib_ucm_send_dreq,
1093 [IB_USER_CM_CMD_SEND_DREP] = ib_ucm_send_drep,
1094 [IB_USER_CM_CMD_SEND_REJ] = ib_ucm_send_rej,
1095 [IB_USER_CM_CMD_SEND_MRA] = ib_ucm_send_mra,
1096 [IB_USER_CM_CMD_SEND_LAP] = ib_ucm_send_lap,
1097 [IB_USER_CM_CMD_SEND_APR] = ib_ucm_send_apr,
1098 [IB_USER_CM_CMD_SEND_SIDR_REQ] = ib_ucm_send_sidr_req,
1099 [IB_USER_CM_CMD_SEND_SIDR_REP] = ib_ucm_send_sidr_rep,
1100 [IB_USER_CM_CMD_EVENT] = ib_ucm_event,
1101 [IB_USER_CM_CMD_INIT_QP_ATTR] = ib_ucm_init_qp_attr,
1104 static ssize_t ib_ucm_write(struct file *filp, const char __user *buf,
1105 size_t len, loff_t *pos)
1107 struct ib_ucm_file *file = filp->private_data;
1108 struct ib_ucm_cmd_hdr hdr;
1111 if (!ib_safe_file_access(filp)) {
1112 pr_err_once("ucm_write: process %d (%s) changed security contexts after opening file descriptor, this is not allowed.\n",
1113 task_tgid_vnr(current), current->comm);
1117 if (len < sizeof(hdr))
1120 if (copy_from_user(&hdr, buf, sizeof(hdr)))
1123 if (hdr.cmd >= ARRAY_SIZE(ucm_cmd_table))
1125 hdr.cmd = array_index_nospec(hdr.cmd, ARRAY_SIZE(ucm_cmd_table));
1127 if (hdr.in + sizeof(hdr) > len)
1130 result = ucm_cmd_table[hdr.cmd](file, buf + sizeof(hdr),
1138 static __poll_t ib_ucm_poll(struct file *filp,
1139 struct poll_table_struct *wait)
1141 struct ib_ucm_file *file = filp->private_data;
1144 poll_wait(filp, &file->poll_wait, wait);
1146 if (!list_empty(&file->events))
1147 mask = EPOLLIN | EPOLLRDNORM;
1153 * ib_ucm_open() does not need the BKL:
1155 * - no global state is referred to;
1156 * - there is no ioctl method to race against;
1157 * - no further module initialization is required for open to work
1158 * after the device is registered.
1160 static int ib_ucm_open(struct inode *inode, struct file *filp)
1162 struct ib_ucm_file *file;
1164 file = kmalloc(sizeof(*file), GFP_KERNEL);
1168 INIT_LIST_HEAD(&file->events);
1169 INIT_LIST_HEAD(&file->ctxs);
1170 init_waitqueue_head(&file->poll_wait);
1172 mutex_init(&file->file_mutex);
1174 filp->private_data = file;
1176 file->device = container_of(inode->i_cdev, struct ib_ucm_device, cdev);
1178 return nonseekable_open(inode, filp);
1181 static int ib_ucm_close(struct inode *inode, struct file *filp)
1183 struct ib_ucm_file *file = filp->private_data;
1184 struct ib_ucm_context *ctx;
1186 mutex_lock(&file->file_mutex);
1187 while (!list_empty(&file->ctxs)) {
1188 ctx = list_entry(file->ctxs.next,
1189 struct ib_ucm_context, file_list);
1190 mutex_unlock(&file->file_mutex);
1192 mutex_lock(&ctx_id_mutex);
1193 idr_remove(&ctx_id_table, ctx->id);
1194 mutex_unlock(&ctx_id_mutex);
1196 ib_destroy_cm_id(ctx->cm_id);
1197 ib_ucm_cleanup_events(ctx);
1200 mutex_lock(&file->file_mutex);
1202 mutex_unlock(&file->file_mutex);
1207 static void ib_ucm_release_dev(struct device *dev)
1209 struct ib_ucm_device *ucm_dev;
1211 ucm_dev = container_of(dev, struct ib_ucm_device, dev);
1215 static void ib_ucm_free_dev(struct ib_ucm_device *ucm_dev)
1217 clear_bit(ucm_dev->devnum, dev_map);
1220 static const struct file_operations ucm_fops = {
1221 .owner = THIS_MODULE,
1222 .open = ib_ucm_open,
1223 .release = ib_ucm_close,
1224 .write = ib_ucm_write,
1225 .poll = ib_ucm_poll,
1226 .llseek = no_llseek,
1229 static ssize_t show_ibdev(struct device *dev, struct device_attribute *attr,
1232 struct ib_ucm_device *ucm_dev;
1234 ucm_dev = container_of(dev, struct ib_ucm_device, dev);
1235 return sprintf(buf, "%s\n", ucm_dev->ib_dev->name);
1237 static DEVICE_ATTR(ibdev, S_IRUGO, show_ibdev, NULL);
1239 static void ib_ucm_add_one(struct ib_device *device)
1243 struct ib_ucm_device *ucm_dev;
1245 if (!device->alloc_ucontext || !rdma_cap_ib_cm(device, 1))
1248 ucm_dev = kzalloc(sizeof *ucm_dev, GFP_KERNEL);
1252 device_initialize(&ucm_dev->dev);
1253 ucm_dev->ib_dev = device;
1254 ucm_dev->dev.release = ib_ucm_release_dev;
1256 devnum = find_first_zero_bit(dev_map, IB_UCM_MAX_DEVICES);
1257 if (devnum >= IB_UCM_MAX_DEVICES)
1259 ucm_dev->devnum = devnum;
1260 set_bit(devnum, dev_map);
1261 if (devnum >= IB_UCM_NUM_FIXED_MINOR)
1262 base = dynamic_ucm_dev + devnum - IB_UCM_NUM_FIXED_MINOR;
1264 base = IB_UCM_BASE_DEV + devnum;
1266 cdev_init(&ucm_dev->cdev, &ucm_fops);
1267 ucm_dev->cdev.owner = THIS_MODULE;
1268 kobject_set_name(&ucm_dev->cdev.kobj, "ucm%d", ucm_dev->devnum);
1270 ucm_dev->dev.class = &cm_class;
1271 ucm_dev->dev.parent = device->dev.parent;
1272 ucm_dev->dev.devt = base;
1274 dev_set_name(&ucm_dev->dev, "ucm%d", ucm_dev->devnum);
1275 if (cdev_device_add(&ucm_dev->cdev, &ucm_dev->dev))
1278 if (device_create_file(&ucm_dev->dev, &dev_attr_ibdev))
1281 ib_set_client_data(device, &ucm_client, ucm_dev);
1285 cdev_device_del(&ucm_dev->cdev, &ucm_dev->dev);
1287 ib_ucm_free_dev(ucm_dev);
1289 put_device(&ucm_dev->dev);
1293 static void ib_ucm_remove_one(struct ib_device *device, void *client_data)
1295 struct ib_ucm_device *ucm_dev = client_data;
1300 cdev_device_del(&ucm_dev->cdev, &ucm_dev->dev);
1301 ib_ucm_free_dev(ucm_dev);
1302 put_device(&ucm_dev->dev);
1305 static CLASS_ATTR_STRING(abi_version, S_IRUGO,
1306 __stringify(IB_USER_CM_ABI_VERSION));
1308 static int __init ib_ucm_init(void)
1312 ret = register_chrdev_region(IB_UCM_BASE_DEV, IB_UCM_NUM_FIXED_MINOR,
1315 pr_err("ucm: couldn't register device number\n");
1319 ret = alloc_chrdev_region(&dynamic_ucm_dev, 0, IB_UCM_NUM_DYNAMIC_MINOR,
1322 pr_err("ucm: couldn't register dynamic device number\n");
1326 ret = class_create_file(&cm_class, &class_attr_abi_version.attr);
1328 pr_err("ucm: couldn't create abi_version attribute\n");
1332 ret = ib_register_client(&ucm_client);
1334 pr_err("ucm: couldn't register client\n");
1340 class_remove_file(&cm_class, &class_attr_abi_version.attr);
1342 unregister_chrdev_region(dynamic_ucm_dev, IB_UCM_NUM_DYNAMIC_MINOR);
1344 unregister_chrdev_region(IB_UCM_BASE_DEV, IB_UCM_NUM_FIXED_MINOR);
1349 static void __exit ib_ucm_cleanup(void)
1351 ib_unregister_client(&ucm_client);
1352 class_remove_file(&cm_class, &class_attr_abi_version.attr);
1353 unregister_chrdev_region(IB_UCM_BASE_DEV, IB_UCM_NUM_FIXED_MINOR);
1354 unregister_chrdev_region(dynamic_ucm_dev, IB_UCM_NUM_DYNAMIC_MINOR);
1355 idr_destroy(&ctx_id_table);
1358 module_init(ib_ucm_init);
1359 module_exit(ib_ucm_cleanup);