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