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