2 * Copyright (c) 2005-2006 Intel Corporation. All rights reserved.
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 #include <linux/completion.h>
34 #include <linux/mutex.h>
35 #include <linux/poll.h>
36 #include <linux/idr.h>
38 #include <linux/in6.h>
39 #include <linux/miscdevice.h>
41 #include <rdma/rdma_user_cm.h>
42 #include <rdma/ib_marshall.h>
43 #include <rdma/rdma_cm.h>
45 MODULE_AUTHOR("Sean Hefty");
46 MODULE_DESCRIPTION("RDMA Userspace Connection Manager Access");
47 MODULE_LICENSE("Dual BSD/GPL");
50 UCMA_MAX_BACKLOG = 128
56 struct list_head ctx_list;
57 struct list_head event_list;
58 wait_queue_head_t poll_wait;
63 struct completion comp;
68 struct ucma_file *file;
69 struct rdma_cm_id *cm_id;
72 struct list_head list;
76 struct ucma_context *ctx;
77 struct list_head list;
78 struct rdma_cm_id *cm_id;
79 struct rdma_ucm_event_resp resp;
82 static DEFINE_MUTEX(mut);
83 static DEFINE_IDR(ctx_idr);
85 static inline struct ucma_context *_ucma_find_context(int id,
86 struct ucma_file *file)
88 struct ucma_context *ctx;
90 ctx = idr_find(&ctx_idr, id);
92 ctx = ERR_PTR(-ENOENT);
93 else if (ctx->file != file)
94 ctx = ERR_PTR(-EINVAL);
98 static struct ucma_context *ucma_get_ctx(struct ucma_file *file, int id)
100 struct ucma_context *ctx;
103 ctx = _ucma_find_context(id, file);
105 atomic_inc(&ctx->ref);
110 static void ucma_put_ctx(struct ucma_context *ctx)
112 if (atomic_dec_and_test(&ctx->ref))
113 complete(&ctx->comp);
116 static struct ucma_context *ucma_alloc_ctx(struct ucma_file *file)
118 struct ucma_context *ctx;
121 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
125 atomic_set(&ctx->ref, 1);
126 init_completion(&ctx->comp);
130 ret = idr_pre_get(&ctx_idr, GFP_KERNEL);
135 ret = idr_get_new(&ctx_idr, ctx, &ctx->id);
137 } while (ret == -EAGAIN);
142 list_add_tail(&ctx->list, &file->ctx_list);
150 static void ucma_copy_conn_event(struct rdma_ucm_conn_param *dst,
151 struct rdma_conn_param *src)
153 if (src->private_data_len)
154 memcpy(dst->private_data, src->private_data,
155 src->private_data_len);
156 dst->private_data_len = src->private_data_len;
157 dst->responder_resources =src->responder_resources;
158 dst->initiator_depth = src->initiator_depth;
159 dst->flow_control = src->flow_control;
160 dst->retry_count = src->retry_count;
161 dst->rnr_retry_count = src->rnr_retry_count;
163 dst->qp_num = src->qp_num;
166 static void ucma_copy_ud_event(struct rdma_ucm_ud_param *dst,
167 struct rdma_ud_param *src)
169 if (src->private_data_len)
170 memcpy(dst->private_data, src->private_data,
171 src->private_data_len);
172 dst->private_data_len = src->private_data_len;
173 ib_copy_ah_attr_to_user(&dst->ah_attr, &src->ah_attr);
174 dst->qp_num = src->qp_num;
175 dst->qkey = src->qkey;
178 static void ucma_set_event_context(struct ucma_context *ctx,
179 struct rdma_cm_event *event,
180 struct ucma_event *uevent)
183 uevent->resp.uid = ctx->uid;
184 uevent->resp.id = ctx->id;
187 static int ucma_event_handler(struct rdma_cm_id *cm_id,
188 struct rdma_cm_event *event)
190 struct ucma_event *uevent;
191 struct ucma_context *ctx = cm_id->context;
194 uevent = kzalloc(sizeof(*uevent), GFP_KERNEL);
196 return event->event == RDMA_CM_EVENT_CONNECT_REQUEST;
198 uevent->cm_id = cm_id;
199 ucma_set_event_context(ctx, event, uevent);
200 uevent->resp.event = event->event;
201 uevent->resp.status = event->status;
202 if (cm_id->ps == RDMA_PS_UDP)
203 ucma_copy_ud_event(&uevent->resp.param.ud, &event->param.ud);
205 ucma_copy_conn_event(&uevent->resp.param.conn,
208 mutex_lock(&ctx->file->mut);
209 if (event->event == RDMA_CM_EVENT_CONNECT_REQUEST) {
217 list_add_tail(&uevent->list, &ctx->file->event_list);
218 wake_up_interruptible(&ctx->file->poll_wait);
220 mutex_unlock(&ctx->file->mut);
224 static ssize_t ucma_get_event(struct ucma_file *file, const char __user *inbuf,
225 int in_len, int out_len)
227 struct ucma_context *ctx;
228 struct rdma_ucm_get_event cmd;
229 struct ucma_event *uevent;
233 if (out_len < sizeof uevent->resp)
236 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
239 mutex_lock(&file->mut);
240 while (list_empty(&file->event_list)) {
241 if (file->filp->f_flags & O_NONBLOCK) {
246 if (signal_pending(current)) {
251 prepare_to_wait(&file->poll_wait, &wait, TASK_INTERRUPTIBLE);
252 mutex_unlock(&file->mut);
254 mutex_lock(&file->mut);
255 finish_wait(&file->poll_wait, &wait);
261 uevent = list_entry(file->event_list.next, struct ucma_event, list);
263 if (uevent->resp.event == RDMA_CM_EVENT_CONNECT_REQUEST) {
264 ctx = ucma_alloc_ctx(file);
269 uevent->ctx->backlog++;
270 ctx->cm_id = uevent->cm_id;
271 ctx->cm_id->context = ctx;
272 uevent->resp.id = ctx->id;
275 if (copy_to_user((void __user *)(unsigned long)cmd.response,
276 &uevent->resp, sizeof uevent->resp)) {
281 list_del(&uevent->list);
282 uevent->ctx->events_reported++;
285 mutex_unlock(&file->mut);
289 static ssize_t ucma_create_id(struct ucma_file *file,
290 const char __user *inbuf,
291 int in_len, int out_len)
293 struct rdma_ucm_create_id cmd;
294 struct rdma_ucm_create_id_resp resp;
295 struct ucma_context *ctx;
298 if (out_len < sizeof(resp))
301 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
304 mutex_lock(&file->mut);
305 ctx = ucma_alloc_ctx(file);
306 mutex_unlock(&file->mut);
311 ctx->cm_id = rdma_create_id(ucma_event_handler, ctx, cmd.ps);
312 if (IS_ERR(ctx->cm_id)) {
313 ret = PTR_ERR(ctx->cm_id);
318 if (copy_to_user((void __user *)(unsigned long)cmd.response,
319 &resp, sizeof(resp))) {
326 rdma_destroy_id(ctx->cm_id);
329 idr_remove(&ctx_idr, ctx->id);
335 static void ucma_cleanup_events(struct ucma_context *ctx)
337 struct ucma_event *uevent, *tmp;
339 list_for_each_entry_safe(uevent, tmp, &ctx->file->event_list, list) {
340 if (uevent->ctx != ctx)
343 list_del(&uevent->list);
345 /* clear incoming connections. */
346 if (uevent->resp.event == RDMA_CM_EVENT_CONNECT_REQUEST)
347 rdma_destroy_id(uevent->cm_id);
353 static int ucma_free_ctx(struct ucma_context *ctx)
357 /* No new events will be generated after destroying the id. */
358 rdma_destroy_id(ctx->cm_id);
360 /* Cleanup events not yet reported to the user. */
361 mutex_lock(&ctx->file->mut);
362 ucma_cleanup_events(ctx);
363 list_del(&ctx->list);
364 mutex_unlock(&ctx->file->mut);
366 events_reported = ctx->events_reported;
368 return events_reported;
371 static ssize_t ucma_destroy_id(struct ucma_file *file, const char __user *inbuf,
372 int in_len, int out_len)
374 struct rdma_ucm_destroy_id cmd;
375 struct rdma_ucm_destroy_id_resp resp;
376 struct ucma_context *ctx;
379 if (out_len < sizeof(resp))
382 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
386 ctx = _ucma_find_context(cmd.id, file);
388 idr_remove(&ctx_idr, ctx->id);
395 wait_for_completion(&ctx->comp);
396 resp.events_reported = ucma_free_ctx(ctx);
398 if (copy_to_user((void __user *)(unsigned long)cmd.response,
399 &resp, sizeof(resp)))
405 static ssize_t ucma_bind_addr(struct ucma_file *file, const char __user *inbuf,
406 int in_len, int out_len)
408 struct rdma_ucm_bind_addr cmd;
409 struct ucma_context *ctx;
412 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
415 ctx = ucma_get_ctx(file, cmd.id);
419 ret = rdma_bind_addr(ctx->cm_id, (struct sockaddr *) &cmd.addr);
424 static ssize_t ucma_resolve_addr(struct ucma_file *file,
425 const char __user *inbuf,
426 int in_len, int out_len)
428 struct rdma_ucm_resolve_addr cmd;
429 struct ucma_context *ctx;
432 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
435 ctx = ucma_get_ctx(file, cmd.id);
439 ret = rdma_resolve_addr(ctx->cm_id, (struct sockaddr *) &cmd.src_addr,
440 (struct sockaddr *) &cmd.dst_addr,
446 static ssize_t ucma_resolve_route(struct ucma_file *file,
447 const char __user *inbuf,
448 int in_len, int out_len)
450 struct rdma_ucm_resolve_route cmd;
451 struct ucma_context *ctx;
454 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
457 ctx = ucma_get_ctx(file, cmd.id);
461 ret = rdma_resolve_route(ctx->cm_id, cmd.timeout_ms);
466 static void ucma_copy_ib_route(struct rdma_ucm_query_route_resp *resp,
467 struct rdma_route *route)
469 struct rdma_dev_addr *dev_addr;
471 resp->num_paths = route->num_paths;
472 switch (route->num_paths) {
474 dev_addr = &route->addr.dev_addr;
475 ib_addr_get_dgid(dev_addr,
476 (union ib_gid *) &resp->ib_route[0].dgid);
477 ib_addr_get_sgid(dev_addr,
478 (union ib_gid *) &resp->ib_route[0].sgid);
479 resp->ib_route[0].pkey = cpu_to_be16(ib_addr_get_pkey(dev_addr));
482 ib_copy_path_rec_to_user(&resp->ib_route[1],
483 &route->path_rec[1]);
486 ib_copy_path_rec_to_user(&resp->ib_route[0],
487 &route->path_rec[0]);
494 static ssize_t ucma_query_route(struct ucma_file *file,
495 const char __user *inbuf,
496 int in_len, int out_len)
498 struct rdma_ucm_query_route cmd;
499 struct rdma_ucm_query_route_resp resp;
500 struct ucma_context *ctx;
501 struct sockaddr *addr;
504 if (out_len < sizeof(resp))
507 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
510 ctx = ucma_get_ctx(file, cmd.id);
514 memset(&resp, 0, sizeof resp);
515 addr = &ctx->cm_id->route.addr.src_addr;
516 memcpy(&resp.src_addr, addr, addr->sa_family == AF_INET ?
517 sizeof(struct sockaddr_in) :
518 sizeof(struct sockaddr_in6));
519 addr = &ctx->cm_id->route.addr.dst_addr;
520 memcpy(&resp.dst_addr, addr, addr->sa_family == AF_INET ?
521 sizeof(struct sockaddr_in) :
522 sizeof(struct sockaddr_in6));
523 if (!ctx->cm_id->device)
526 resp.node_guid = ctx->cm_id->device->node_guid;
527 resp.port_num = ctx->cm_id->port_num;
528 switch (rdma_node_get_transport(ctx->cm_id->device->node_type)) {
529 case RDMA_TRANSPORT_IB:
530 ucma_copy_ib_route(&resp, &ctx->cm_id->route);
537 if (copy_to_user((void __user *)(unsigned long)cmd.response,
538 &resp, sizeof(resp)))
545 static void ucma_copy_conn_param(struct rdma_conn_param *dst,
546 struct rdma_ucm_conn_param *src)
548 dst->private_data = src->private_data;
549 dst->private_data_len = src->private_data_len;
550 dst->responder_resources =src->responder_resources;
551 dst->initiator_depth = src->initiator_depth;
552 dst->flow_control = src->flow_control;
553 dst->retry_count = src->retry_count;
554 dst->rnr_retry_count = src->rnr_retry_count;
556 dst->qp_num = src->qp_num;
559 static ssize_t ucma_connect(struct ucma_file *file, const char __user *inbuf,
560 int in_len, int out_len)
562 struct rdma_ucm_connect cmd;
563 struct rdma_conn_param conn_param;
564 struct ucma_context *ctx;
567 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
570 if (!cmd.conn_param.valid)
573 ctx = ucma_get_ctx(file, cmd.id);
577 ucma_copy_conn_param(&conn_param, &cmd.conn_param);
578 ret = rdma_connect(ctx->cm_id, &conn_param);
583 static ssize_t ucma_listen(struct ucma_file *file, const char __user *inbuf,
584 int in_len, int out_len)
586 struct rdma_ucm_listen cmd;
587 struct ucma_context *ctx;
590 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
593 ctx = ucma_get_ctx(file, cmd.id);
597 ctx->backlog = cmd.backlog > 0 && cmd.backlog < UCMA_MAX_BACKLOG ?
598 cmd.backlog : UCMA_MAX_BACKLOG;
599 ret = rdma_listen(ctx->cm_id, ctx->backlog);
604 static ssize_t ucma_accept(struct ucma_file *file, const char __user *inbuf,
605 int in_len, int out_len)
607 struct rdma_ucm_accept cmd;
608 struct rdma_conn_param conn_param;
609 struct ucma_context *ctx;
612 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
615 ctx = ucma_get_ctx(file, cmd.id);
619 if (cmd.conn_param.valid) {
621 ucma_copy_conn_param(&conn_param, &cmd.conn_param);
622 ret = rdma_accept(ctx->cm_id, &conn_param);
624 ret = rdma_accept(ctx->cm_id, NULL);
630 static ssize_t ucma_reject(struct ucma_file *file, const char __user *inbuf,
631 int in_len, int out_len)
633 struct rdma_ucm_reject cmd;
634 struct ucma_context *ctx;
637 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
640 ctx = ucma_get_ctx(file, cmd.id);
644 ret = rdma_reject(ctx->cm_id, cmd.private_data, cmd.private_data_len);
649 static ssize_t ucma_disconnect(struct ucma_file *file, const char __user *inbuf,
650 int in_len, int out_len)
652 struct rdma_ucm_disconnect cmd;
653 struct ucma_context *ctx;
656 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
659 ctx = ucma_get_ctx(file, cmd.id);
663 ret = rdma_disconnect(ctx->cm_id);
668 static ssize_t ucma_init_qp_attr(struct ucma_file *file,
669 const char __user *inbuf,
670 int in_len, int out_len)
672 struct rdma_ucm_init_qp_attr cmd;
673 struct ib_uverbs_qp_attr resp;
674 struct ucma_context *ctx;
675 struct ib_qp_attr qp_attr;
678 if (out_len < sizeof(resp))
681 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
684 ctx = ucma_get_ctx(file, cmd.id);
688 resp.qp_attr_mask = 0;
689 memset(&qp_attr, 0, sizeof qp_attr);
690 qp_attr.qp_state = cmd.qp_state;
691 ret = rdma_init_qp_attr(ctx->cm_id, &qp_attr, &resp.qp_attr_mask);
695 ib_copy_qp_attr_to_user(&resp, &qp_attr);
696 if (copy_to_user((void __user *)(unsigned long)cmd.response,
697 &resp, sizeof(resp)))
705 static ssize_t ucma_notify(struct ucma_file *file, const char __user *inbuf,
706 int in_len, int out_len)
708 struct rdma_ucm_notify cmd;
709 struct ucma_context *ctx;
712 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
715 ctx = ucma_get_ctx(file, cmd.id);
719 ret = rdma_notify(ctx->cm_id, (enum ib_event_type) cmd.event);
724 static ssize_t (*ucma_cmd_table[])(struct ucma_file *file,
725 const char __user *inbuf,
726 int in_len, int out_len) = {
727 [RDMA_USER_CM_CMD_CREATE_ID] = ucma_create_id,
728 [RDMA_USER_CM_CMD_DESTROY_ID] = ucma_destroy_id,
729 [RDMA_USER_CM_CMD_BIND_ADDR] = ucma_bind_addr,
730 [RDMA_USER_CM_CMD_RESOLVE_ADDR] = ucma_resolve_addr,
731 [RDMA_USER_CM_CMD_RESOLVE_ROUTE]= ucma_resolve_route,
732 [RDMA_USER_CM_CMD_QUERY_ROUTE] = ucma_query_route,
733 [RDMA_USER_CM_CMD_CONNECT] = ucma_connect,
734 [RDMA_USER_CM_CMD_LISTEN] = ucma_listen,
735 [RDMA_USER_CM_CMD_ACCEPT] = ucma_accept,
736 [RDMA_USER_CM_CMD_REJECT] = ucma_reject,
737 [RDMA_USER_CM_CMD_DISCONNECT] = ucma_disconnect,
738 [RDMA_USER_CM_CMD_INIT_QP_ATTR] = ucma_init_qp_attr,
739 [RDMA_USER_CM_CMD_GET_EVENT] = ucma_get_event,
740 [RDMA_USER_CM_CMD_GET_OPTION] = NULL,
741 [RDMA_USER_CM_CMD_SET_OPTION] = NULL,
742 [RDMA_USER_CM_CMD_NOTIFY] = ucma_notify,
745 static ssize_t ucma_write(struct file *filp, const char __user *buf,
746 size_t len, loff_t *pos)
748 struct ucma_file *file = filp->private_data;
749 struct rdma_ucm_cmd_hdr hdr;
752 if (len < sizeof(hdr))
755 if (copy_from_user(&hdr, buf, sizeof(hdr)))
758 if (hdr.cmd < 0 || hdr.cmd >= ARRAY_SIZE(ucma_cmd_table))
761 if (hdr.in + sizeof(hdr) > len)
764 if (!ucma_cmd_table[hdr.cmd])
767 ret = ucma_cmd_table[hdr.cmd](file, buf + sizeof(hdr), hdr.in, hdr.out);
774 static unsigned int ucma_poll(struct file *filp, struct poll_table_struct *wait)
776 struct ucma_file *file = filp->private_data;
777 unsigned int mask = 0;
779 poll_wait(filp, &file->poll_wait, wait);
781 if (!list_empty(&file->event_list))
782 mask = POLLIN | POLLRDNORM;
787 static int ucma_open(struct inode *inode, struct file *filp)
789 struct ucma_file *file;
791 file = kmalloc(sizeof *file, GFP_KERNEL);
795 INIT_LIST_HEAD(&file->event_list);
796 INIT_LIST_HEAD(&file->ctx_list);
797 init_waitqueue_head(&file->poll_wait);
798 mutex_init(&file->mut);
800 filp->private_data = file;
805 static int ucma_close(struct inode *inode, struct file *filp)
807 struct ucma_file *file = filp->private_data;
808 struct ucma_context *ctx, *tmp;
810 mutex_lock(&file->mut);
811 list_for_each_entry_safe(ctx, tmp, &file->ctx_list, list) {
812 mutex_unlock(&file->mut);
815 idr_remove(&ctx_idr, ctx->id);
819 mutex_lock(&file->mut);
821 mutex_unlock(&file->mut);
826 static struct file_operations ucma_fops = {
827 .owner = THIS_MODULE,
829 .release = ucma_close,
834 static struct miscdevice ucma_misc = {
835 .minor = MISC_DYNAMIC_MINOR,
840 static ssize_t show_abi_version(struct device *dev,
841 struct device_attribute *attr,
844 return sprintf(buf, "%d\n", RDMA_USER_CM_ABI_VERSION);
846 static DEVICE_ATTR(abi_version, S_IRUGO, show_abi_version, NULL);
848 static int __init ucma_init(void)
852 ret = misc_register(&ucma_misc);
856 ret = device_create_file(ucma_misc.this_device, &dev_attr_abi_version);
858 printk(KERN_ERR "rdma_ucm: couldn't create abi_version attr\n");
863 misc_deregister(&ucma_misc);
867 static void __exit ucma_cleanup(void)
869 device_remove_file(ucma_misc.this_device, &dev_attr_abi_version);
870 misc_deregister(&ucma_misc);
871 idr_destroy(&ctx_idr);
874 module_init(ucma_init);
875 module_exit(ucma_cleanup);