1 /* 2 * Copyright (c) 2005 Topspin Communications. All rights reserved. 3 * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved. 4 * Copyright (c) 2005 Mellanox Technologies. All rights reserved. 5 * Copyright (c) 2005 Voltaire, Inc. All rights reserved. 6 * Copyright (c) 2005 PathScale, Inc. All rights reserved. 7 * 8 * This software is available to you under a choice of one of two 9 * licenses. You may choose to be licensed under the terms of the GNU 10 * General Public License (GPL) Version 2, available from the file 11 * COPYING in the main directory of this source tree, or the 12 * OpenIB.org BSD license below: 13 * 14 * Redistribution and use in source and binary forms, with or 15 * without modification, are permitted provided that the following 16 * conditions are met: 17 * 18 * - Redistributions of source code must retain the above 19 * copyright notice, this list of conditions and the following 20 * disclaimer. 21 * 22 * - Redistributions in binary form must reproduce the above 23 * copyright notice, this list of conditions and the following 24 * disclaimer in the documentation and/or other materials 25 * provided with the distribution. 26 * 27 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 28 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 29 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 30 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 31 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 32 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 33 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 34 * SOFTWARE. 35 */ 36 37 #ifndef UVERBS_H 38 #define UVERBS_H 39 40 #include <linux/kref.h> 41 #include <linux/idr.h> 42 #include <linux/mutex.h> 43 #include <linux/completion.h> 44 #include <linux/cdev.h> 45 46 #include <rdma/ib_verbs.h> 47 #include <rdma/ib_umem.h> 48 #include <rdma/ib_user_verbs.h> 49 50 #define INIT_UDATA(udata, ibuf, obuf, ilen, olen) \ 51 do { \ 52 (udata)->inbuf = (void __user *) (ibuf); \ 53 (udata)->outbuf = (void __user *) (obuf); \ 54 (udata)->inlen = (ilen); \ 55 (udata)->outlen = (olen); \ 56 } while (0) 57 58 /* 59 * Our lifetime rules for these structs are the following: 60 * 61 * struct ib_uverbs_device: One reference is held by the module and 62 * released in ib_uverbs_remove_one(). Another reference is taken by 63 * ib_uverbs_open() each time the character special file is opened, 64 * and released in ib_uverbs_release_file() when the file is released. 65 * 66 * struct ib_uverbs_file: One reference is held by the VFS and 67 * released when the file is closed. Another reference is taken when 68 * an asynchronous event queue file is created and released when the 69 * event file is closed. 70 * 71 * struct ib_uverbs_event_file: One reference is held by the VFS and 72 * released when the file is closed. For asynchronous event files, 73 * another reference is held by the corresponding main context file 74 * and released when that file is closed. For completion event files, 75 * a reference is taken when a CQ is created that uses the file, and 76 * released when the CQ is destroyed. 77 */ 78 79 struct ib_uverbs_device { 80 struct kref ref; 81 int num_comp_vectors; 82 struct completion comp; 83 struct device *dev; 84 struct ib_device *ib_dev; 85 int devnum; 86 struct cdev cdev; 87 struct rb_root xrcd_tree; 88 struct mutex xrcd_tree_mutex; 89 }; 90 91 struct ib_uverbs_event_file { 92 struct kref ref; 93 int is_async; 94 struct ib_uverbs_file *uverbs_file; 95 spinlock_t lock; 96 int is_closed; 97 wait_queue_head_t poll_wait; 98 struct fasync_struct *async_queue; 99 struct list_head event_list; 100 }; 101 102 struct ib_uverbs_file { 103 struct kref ref; 104 struct mutex mutex; 105 struct ib_uverbs_device *device; 106 struct ib_ucontext *ucontext; 107 struct ib_event_handler event_handler; 108 struct ib_uverbs_event_file *async_file; 109 }; 110 111 struct ib_uverbs_event { 112 union { 113 struct ib_uverbs_async_event_desc async; 114 struct ib_uverbs_comp_event_desc comp; 115 } desc; 116 struct list_head list; 117 struct list_head obj_list; 118 u32 *counter; 119 }; 120 121 struct ib_uverbs_mcast_entry { 122 struct list_head list; 123 union ib_gid gid; 124 u16 lid; 125 }; 126 127 struct ib_uevent_object { 128 struct ib_uobject uobject; 129 struct list_head event_list; 130 u32 events_reported; 131 }; 132 133 struct ib_uxrcd_object { 134 struct ib_uobject uobject; 135 atomic_t refcnt; 136 }; 137 138 struct ib_usrq_object { 139 struct ib_uevent_object uevent; 140 struct ib_uxrcd_object *uxrcd; 141 }; 142 143 struct ib_uqp_object { 144 struct ib_uevent_object uevent; 145 struct list_head mcast_list; 146 struct ib_uxrcd_object *uxrcd; 147 }; 148 149 struct ib_ucq_object { 150 struct ib_uobject uobject; 151 struct ib_uverbs_file *uverbs_file; 152 struct list_head comp_list; 153 struct list_head async_list; 154 u32 comp_events_reported; 155 u32 async_events_reported; 156 }; 157 158 extern spinlock_t ib_uverbs_idr_lock; 159 extern struct idr ib_uverbs_pd_idr; 160 extern struct idr ib_uverbs_mr_idr; 161 extern struct idr ib_uverbs_mw_idr; 162 extern struct idr ib_uverbs_ah_idr; 163 extern struct idr ib_uverbs_cq_idr; 164 extern struct idr ib_uverbs_qp_idr; 165 extern struct idr ib_uverbs_srq_idr; 166 extern struct idr ib_uverbs_xrcd_idr; 167 extern struct idr ib_uverbs_rule_idr; 168 169 void idr_remove_uobj(struct idr *idp, struct ib_uobject *uobj); 170 171 struct file *ib_uverbs_alloc_event_file(struct ib_uverbs_file *uverbs_file, 172 int is_async); 173 struct ib_uverbs_event_file *ib_uverbs_lookup_comp_file(int fd); 174 175 void ib_uverbs_release_ucq(struct ib_uverbs_file *file, 176 struct ib_uverbs_event_file *ev_file, 177 struct ib_ucq_object *uobj); 178 void ib_uverbs_release_uevent(struct ib_uverbs_file *file, 179 struct ib_uevent_object *uobj); 180 181 void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context); 182 void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr); 183 void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr); 184 void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr); 185 void ib_uverbs_event_handler(struct ib_event_handler *handler, 186 struct ib_event *event); 187 void ib_uverbs_dealloc_xrcd(struct ib_uverbs_device *dev, struct ib_xrcd *xrcd); 188 189 struct ib_uverbs_flow_spec { 190 union { 191 union { 192 struct ib_uverbs_flow_spec_hdr hdr; 193 struct { 194 __u32 type; 195 __u16 size; 196 __u16 reserved; 197 }; 198 }; 199 struct ib_uverbs_flow_spec_eth eth; 200 struct ib_uverbs_flow_spec_ipv4 ipv4; 201 struct ib_uverbs_flow_spec_tcp_udp tcp_udp; 202 }; 203 }; 204 205 #define IB_UVERBS_DECLARE_CMD(name) \ 206 ssize_t ib_uverbs_##name(struct ib_uverbs_file *file, \ 207 const char __user *buf, int in_len, \ 208 int out_len) 209 210 IB_UVERBS_DECLARE_CMD(get_context); 211 IB_UVERBS_DECLARE_CMD(query_device); 212 IB_UVERBS_DECLARE_CMD(query_port); 213 IB_UVERBS_DECLARE_CMD(alloc_pd); 214 IB_UVERBS_DECLARE_CMD(dealloc_pd); 215 IB_UVERBS_DECLARE_CMD(reg_mr); 216 IB_UVERBS_DECLARE_CMD(dereg_mr); 217 IB_UVERBS_DECLARE_CMD(alloc_mw); 218 IB_UVERBS_DECLARE_CMD(dealloc_mw); 219 IB_UVERBS_DECLARE_CMD(create_comp_channel); 220 IB_UVERBS_DECLARE_CMD(create_cq); 221 IB_UVERBS_DECLARE_CMD(resize_cq); 222 IB_UVERBS_DECLARE_CMD(poll_cq); 223 IB_UVERBS_DECLARE_CMD(req_notify_cq); 224 IB_UVERBS_DECLARE_CMD(destroy_cq); 225 IB_UVERBS_DECLARE_CMD(create_qp); 226 IB_UVERBS_DECLARE_CMD(open_qp); 227 IB_UVERBS_DECLARE_CMD(query_qp); 228 IB_UVERBS_DECLARE_CMD(modify_qp); 229 IB_UVERBS_DECLARE_CMD(destroy_qp); 230 IB_UVERBS_DECLARE_CMD(post_send); 231 IB_UVERBS_DECLARE_CMD(post_recv); 232 IB_UVERBS_DECLARE_CMD(post_srq_recv); 233 IB_UVERBS_DECLARE_CMD(create_ah); 234 IB_UVERBS_DECLARE_CMD(destroy_ah); 235 IB_UVERBS_DECLARE_CMD(attach_mcast); 236 IB_UVERBS_DECLARE_CMD(detach_mcast); 237 IB_UVERBS_DECLARE_CMD(create_srq); 238 IB_UVERBS_DECLARE_CMD(modify_srq); 239 IB_UVERBS_DECLARE_CMD(query_srq); 240 IB_UVERBS_DECLARE_CMD(destroy_srq); 241 IB_UVERBS_DECLARE_CMD(create_xsrq); 242 IB_UVERBS_DECLARE_CMD(open_xrcd); 243 IB_UVERBS_DECLARE_CMD(close_xrcd); 244 245 #define IB_UVERBS_DECLARE_EX_CMD(name) \ 246 int ib_uverbs_ex_##name(struct ib_uverbs_file *file, \ 247 struct ib_udata *ucore, \ 248 struct ib_udata *uhw) 249 250 IB_UVERBS_DECLARE_EX_CMD(create_flow); 251 IB_UVERBS_DECLARE_EX_CMD(destroy_flow); 252 253 #endif /* UVERBS_H */ 254