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 static inline void 51 ib_uverbs_init_udata(struct ib_udata *udata, 52 const void __user *ibuf, 53 void __user *obuf, 54 size_t ilen, size_t olen) 55 { 56 udata->inbuf = ibuf; 57 udata->outbuf = obuf; 58 udata->inlen = ilen; 59 udata->outlen = olen; 60 } 61 62 static inline void 63 ib_uverbs_init_udata_buf_or_null(struct ib_udata *udata, 64 const void __user *ibuf, 65 void __user *obuf, 66 size_t ilen, size_t olen) 67 { 68 ib_uverbs_init_udata(udata, 69 ilen ? ibuf : NULL, olen ? obuf : NULL, 70 ilen, olen); 71 } 72 73 /* 74 * Our lifetime rules for these structs are the following: 75 * 76 * struct ib_uverbs_device: One reference is held by the module and 77 * released in ib_uverbs_remove_one(). Another reference is taken by 78 * ib_uverbs_open() each time the character special file is opened, 79 * and released in ib_uverbs_release_file() when the file is released. 80 * 81 * struct ib_uverbs_file: One reference is held by the VFS and 82 * released when the file is closed. Another reference is taken when 83 * an asynchronous event queue file is created and released when the 84 * event file is closed. 85 * 86 * struct ib_uverbs_event_queue: Base structure for 87 * struct ib_uverbs_async_event_file and struct ib_uverbs_completion_event_file. 88 * One reference is held by the VFS and released when the file is closed. 89 * For asynchronous event files, another reference is held by the corresponding 90 * main context file and released when that file is closed. For completion 91 * event files, a reference is taken when a CQ is created that uses the file, 92 * and released when the CQ is destroyed. 93 */ 94 95 struct ib_uverbs_device { 96 atomic_t refcount; 97 int num_comp_vectors; 98 struct completion comp; 99 struct device *dev; 100 struct ib_device __rcu *ib_dev; 101 int devnum; 102 struct cdev cdev; 103 struct rb_root xrcd_tree; 104 struct mutex xrcd_tree_mutex; 105 struct kobject kobj; 106 struct srcu_struct disassociate_srcu; 107 struct mutex lists_mutex; /* protect lists */ 108 struct list_head uverbs_file_list; 109 struct list_head uverbs_events_file_list; 110 struct uverbs_root_spec *specs_root; 111 }; 112 113 struct ib_uverbs_event_queue { 114 spinlock_t lock; 115 int is_closed; 116 wait_queue_head_t poll_wait; 117 struct fasync_struct *async_queue; 118 struct list_head event_list; 119 }; 120 121 struct ib_uverbs_async_event_file { 122 struct ib_uverbs_event_queue ev_queue; 123 struct ib_uverbs_file *uverbs_file; 124 struct kref ref; 125 struct list_head list; 126 }; 127 128 struct ib_uverbs_completion_event_file { 129 struct ib_uobject_file uobj_file; 130 struct ib_uverbs_event_queue ev_queue; 131 }; 132 133 struct ib_uverbs_file { 134 struct kref ref; 135 struct mutex mutex; 136 struct mutex cleanup_mutex; /* protect cleanup */ 137 struct ib_uverbs_device *device; 138 struct ib_ucontext *ucontext; 139 struct ib_event_handler event_handler; 140 struct ib_uverbs_async_event_file *async_file; 141 struct list_head list; 142 int is_closed; 143 144 struct idr idr; 145 /* spinlock protects write access to idr */ 146 spinlock_t idr_lock; 147 }; 148 149 struct ib_uverbs_event { 150 union { 151 struct ib_uverbs_async_event_desc async; 152 struct ib_uverbs_comp_event_desc comp; 153 } desc; 154 struct list_head list; 155 struct list_head obj_list; 156 u32 *counter; 157 }; 158 159 struct ib_uverbs_mcast_entry { 160 struct list_head list; 161 union ib_gid gid; 162 u16 lid; 163 }; 164 165 struct ib_uevent_object { 166 struct ib_uobject uobject; 167 struct list_head event_list; 168 u32 events_reported; 169 }; 170 171 struct ib_uxrcd_object { 172 struct ib_uobject uobject; 173 atomic_t refcnt; 174 }; 175 176 struct ib_usrq_object { 177 struct ib_uevent_object uevent; 178 struct ib_uxrcd_object *uxrcd; 179 }; 180 181 struct ib_uqp_object { 182 struct ib_uevent_object uevent; 183 /* lock for mcast list */ 184 struct mutex mcast_lock; 185 struct list_head mcast_list; 186 struct ib_uxrcd_object *uxrcd; 187 }; 188 189 struct ib_uwq_object { 190 struct ib_uevent_object uevent; 191 }; 192 193 struct ib_ucq_object { 194 struct ib_uobject uobject; 195 struct ib_uverbs_file *uverbs_file; 196 struct list_head comp_list; 197 struct list_head async_list; 198 u32 comp_events_reported; 199 u32 async_events_reported; 200 }; 201 202 extern const struct file_operations uverbs_event_fops; 203 void ib_uverbs_init_event_queue(struct ib_uverbs_event_queue *ev_queue); 204 struct file *ib_uverbs_alloc_async_event_file(struct ib_uverbs_file *uverbs_file, 205 struct ib_device *ib_dev); 206 void ib_uverbs_free_async_event_file(struct ib_uverbs_file *uverbs_file); 207 208 void ib_uverbs_release_ucq(struct ib_uverbs_file *file, 209 struct ib_uverbs_completion_event_file *ev_file, 210 struct ib_ucq_object *uobj); 211 void ib_uverbs_release_uevent(struct ib_uverbs_file *file, 212 struct ib_uevent_object *uobj); 213 void ib_uverbs_release_file(struct kref *ref); 214 215 void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context); 216 void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr); 217 void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr); 218 void ib_uverbs_wq_event_handler(struct ib_event *event, void *context_ptr); 219 void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr); 220 void ib_uverbs_event_handler(struct ib_event_handler *handler, 221 struct ib_event *event); 222 int ib_uverbs_dealloc_xrcd(struct ib_uverbs_device *dev, struct ib_xrcd *xrcd, 223 enum rdma_remove_reason why); 224 225 int uverbs_dealloc_mw(struct ib_mw *mw); 226 void ib_uverbs_detach_umcast(struct ib_qp *qp, 227 struct ib_uqp_object *uobj); 228 229 long ib_uverbs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg); 230 231 struct ib_uverbs_flow_spec { 232 union { 233 union { 234 struct ib_uverbs_flow_spec_hdr hdr; 235 struct { 236 __u32 type; 237 __u16 size; 238 __u16 reserved; 239 }; 240 }; 241 struct ib_uverbs_flow_spec_eth eth; 242 struct ib_uverbs_flow_spec_ipv4 ipv4; 243 struct ib_uverbs_flow_spec_tcp_udp tcp_udp; 244 struct ib_uverbs_flow_spec_ipv6 ipv6; 245 struct ib_uverbs_flow_spec_action_tag flow_tag; 246 struct ib_uverbs_flow_spec_action_drop drop; 247 }; 248 }; 249 250 #define IB_UVERBS_DECLARE_CMD(name) \ 251 ssize_t ib_uverbs_##name(struct ib_uverbs_file *file, \ 252 struct ib_device *ib_dev, \ 253 const char __user *buf, int in_len, \ 254 int out_len) 255 256 IB_UVERBS_DECLARE_CMD(get_context); 257 IB_UVERBS_DECLARE_CMD(query_device); 258 IB_UVERBS_DECLARE_CMD(query_port); 259 IB_UVERBS_DECLARE_CMD(alloc_pd); 260 IB_UVERBS_DECLARE_CMD(dealloc_pd); 261 IB_UVERBS_DECLARE_CMD(reg_mr); 262 IB_UVERBS_DECLARE_CMD(rereg_mr); 263 IB_UVERBS_DECLARE_CMD(dereg_mr); 264 IB_UVERBS_DECLARE_CMD(alloc_mw); 265 IB_UVERBS_DECLARE_CMD(dealloc_mw); 266 IB_UVERBS_DECLARE_CMD(create_comp_channel); 267 IB_UVERBS_DECLARE_CMD(create_cq); 268 IB_UVERBS_DECLARE_CMD(resize_cq); 269 IB_UVERBS_DECLARE_CMD(poll_cq); 270 IB_UVERBS_DECLARE_CMD(req_notify_cq); 271 IB_UVERBS_DECLARE_CMD(destroy_cq); 272 IB_UVERBS_DECLARE_CMD(create_qp); 273 IB_UVERBS_DECLARE_CMD(open_qp); 274 IB_UVERBS_DECLARE_CMD(query_qp); 275 IB_UVERBS_DECLARE_CMD(modify_qp); 276 IB_UVERBS_DECLARE_CMD(destroy_qp); 277 IB_UVERBS_DECLARE_CMD(post_send); 278 IB_UVERBS_DECLARE_CMD(post_recv); 279 IB_UVERBS_DECLARE_CMD(post_srq_recv); 280 IB_UVERBS_DECLARE_CMD(create_ah); 281 IB_UVERBS_DECLARE_CMD(destroy_ah); 282 IB_UVERBS_DECLARE_CMD(attach_mcast); 283 IB_UVERBS_DECLARE_CMD(detach_mcast); 284 IB_UVERBS_DECLARE_CMD(create_srq); 285 IB_UVERBS_DECLARE_CMD(modify_srq); 286 IB_UVERBS_DECLARE_CMD(query_srq); 287 IB_UVERBS_DECLARE_CMD(destroy_srq); 288 IB_UVERBS_DECLARE_CMD(create_xsrq); 289 IB_UVERBS_DECLARE_CMD(open_xrcd); 290 IB_UVERBS_DECLARE_CMD(close_xrcd); 291 292 #define IB_UVERBS_DECLARE_EX_CMD(name) \ 293 int ib_uverbs_ex_##name(struct ib_uverbs_file *file, \ 294 struct ib_device *ib_dev, \ 295 struct ib_udata *ucore, \ 296 struct ib_udata *uhw) 297 298 IB_UVERBS_DECLARE_EX_CMD(create_flow); 299 IB_UVERBS_DECLARE_EX_CMD(destroy_flow); 300 IB_UVERBS_DECLARE_EX_CMD(query_device); 301 IB_UVERBS_DECLARE_EX_CMD(create_cq); 302 IB_UVERBS_DECLARE_EX_CMD(create_qp); 303 IB_UVERBS_DECLARE_EX_CMD(create_wq); 304 IB_UVERBS_DECLARE_EX_CMD(modify_wq); 305 IB_UVERBS_DECLARE_EX_CMD(destroy_wq); 306 IB_UVERBS_DECLARE_EX_CMD(create_rwq_ind_table); 307 IB_UVERBS_DECLARE_EX_CMD(destroy_rwq_ind_table); 308 IB_UVERBS_DECLARE_EX_CMD(modify_qp); 309 IB_UVERBS_DECLARE_EX_CMD(modify_cq); 310 311 #endif /* UVERBS_H */ 312