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