Linux 4.2.1
[linux/fpc-iii.git] / drivers / infiniband / core / uverbs.h
blobba365b6d1e8d561d891f358da5f3f05e54800740
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.
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:
14 * Redistribution and use in source and binary forms, with or
15 * without modification, are permitted provided that the following
16 * conditions are met:
18 * - Redistributions of source code must retain the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer.
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.
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.
37 #ifndef UVERBS_H
38 #define UVERBS_H
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>
46 #include <rdma/ib_verbs.h>
47 #include <rdma/ib_umem.h>
48 #include <rdma/ib_user_verbs.h>
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)
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)
67 * Our lifetime rules for these structs are the following:
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.
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.
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.
87 struct ib_uverbs_device {
88 struct kref ref;
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;
99 struct ib_uverbs_event_file {
100 struct kref ref;
101 int is_async;
102 struct ib_uverbs_file *uverbs_file;
103 spinlock_t lock;
104 int is_closed;
105 wait_queue_head_t poll_wait;
106 struct fasync_struct *async_queue;
107 struct list_head event_list;
110 struct ib_uverbs_file {
111 struct kref ref;
112 struct mutex mutex;
113 struct ib_uverbs_device *device;
114 struct ib_ucontext *ucontext;
115 struct ib_event_handler event_handler;
116 struct ib_uverbs_event_file *async_file;
119 struct ib_uverbs_event {
120 union {
121 struct ib_uverbs_async_event_desc async;
122 struct ib_uverbs_comp_event_desc comp;
123 } desc;
124 struct list_head list;
125 struct list_head obj_list;
126 u32 *counter;
129 struct ib_uverbs_mcast_entry {
130 struct list_head list;
131 union ib_gid gid;
132 u16 lid;
135 struct ib_uevent_object {
136 struct ib_uobject uobject;
137 struct list_head event_list;
138 u32 events_reported;
141 struct ib_uxrcd_object {
142 struct ib_uobject uobject;
143 atomic_t refcnt;
146 struct ib_usrq_object {
147 struct ib_uevent_object uevent;
148 struct ib_uxrcd_object *uxrcd;
151 struct ib_uqp_object {
152 struct ib_uevent_object uevent;
153 struct list_head mcast_list;
154 struct ib_uxrcd_object *uxrcd;
157 struct ib_ucq_object {
158 struct ib_uobject uobject;
159 struct ib_uverbs_file *uverbs_file;
160 struct list_head comp_list;
161 struct list_head async_list;
162 u32 comp_events_reported;
163 u32 async_events_reported;
166 extern spinlock_t ib_uverbs_idr_lock;
167 extern struct idr ib_uverbs_pd_idr;
168 extern struct idr ib_uverbs_mr_idr;
169 extern struct idr ib_uverbs_mw_idr;
170 extern struct idr ib_uverbs_ah_idr;
171 extern struct idr ib_uverbs_cq_idr;
172 extern struct idr ib_uverbs_qp_idr;
173 extern struct idr ib_uverbs_srq_idr;
174 extern struct idr ib_uverbs_xrcd_idr;
175 extern struct idr ib_uverbs_rule_idr;
177 void idr_remove_uobj(struct idr *idp, struct ib_uobject *uobj);
179 struct file *ib_uverbs_alloc_event_file(struct ib_uverbs_file *uverbs_file,
180 int is_async);
181 struct ib_uverbs_event_file *ib_uverbs_lookup_comp_file(int fd);
183 void ib_uverbs_release_ucq(struct ib_uverbs_file *file,
184 struct ib_uverbs_event_file *ev_file,
185 struct ib_ucq_object *uobj);
186 void ib_uverbs_release_uevent(struct ib_uverbs_file *file,
187 struct ib_uevent_object *uobj);
189 void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
190 void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
191 void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
192 void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
193 void ib_uverbs_event_handler(struct ib_event_handler *handler,
194 struct ib_event *event);
195 void ib_uverbs_dealloc_xrcd(struct ib_uverbs_device *dev, struct ib_xrcd *xrcd);
197 struct ib_uverbs_flow_spec {
198 union {
199 union {
200 struct ib_uverbs_flow_spec_hdr hdr;
201 struct {
202 __u32 type;
203 __u16 size;
204 __u16 reserved;
207 struct ib_uverbs_flow_spec_eth eth;
208 struct ib_uverbs_flow_spec_ipv4 ipv4;
209 struct ib_uverbs_flow_spec_tcp_udp tcp_udp;
213 #define IB_UVERBS_DECLARE_CMD(name) \
214 ssize_t ib_uverbs_##name(struct ib_uverbs_file *file, \
215 const char __user *buf, int in_len, \
216 int out_len)
218 IB_UVERBS_DECLARE_CMD(get_context);
219 IB_UVERBS_DECLARE_CMD(query_device);
220 IB_UVERBS_DECLARE_CMD(query_port);
221 IB_UVERBS_DECLARE_CMD(alloc_pd);
222 IB_UVERBS_DECLARE_CMD(dealloc_pd);
223 IB_UVERBS_DECLARE_CMD(reg_mr);
224 IB_UVERBS_DECLARE_CMD(rereg_mr);
225 IB_UVERBS_DECLARE_CMD(dereg_mr);
226 IB_UVERBS_DECLARE_CMD(alloc_mw);
227 IB_UVERBS_DECLARE_CMD(dealloc_mw);
228 IB_UVERBS_DECLARE_CMD(create_comp_channel);
229 IB_UVERBS_DECLARE_CMD(create_cq);
230 IB_UVERBS_DECLARE_CMD(resize_cq);
231 IB_UVERBS_DECLARE_CMD(poll_cq);
232 IB_UVERBS_DECLARE_CMD(req_notify_cq);
233 IB_UVERBS_DECLARE_CMD(destroy_cq);
234 IB_UVERBS_DECLARE_CMD(create_qp);
235 IB_UVERBS_DECLARE_CMD(open_qp);
236 IB_UVERBS_DECLARE_CMD(query_qp);
237 IB_UVERBS_DECLARE_CMD(modify_qp);
238 IB_UVERBS_DECLARE_CMD(destroy_qp);
239 IB_UVERBS_DECLARE_CMD(post_send);
240 IB_UVERBS_DECLARE_CMD(post_recv);
241 IB_UVERBS_DECLARE_CMD(post_srq_recv);
242 IB_UVERBS_DECLARE_CMD(create_ah);
243 IB_UVERBS_DECLARE_CMD(destroy_ah);
244 IB_UVERBS_DECLARE_CMD(attach_mcast);
245 IB_UVERBS_DECLARE_CMD(detach_mcast);
246 IB_UVERBS_DECLARE_CMD(create_srq);
247 IB_UVERBS_DECLARE_CMD(modify_srq);
248 IB_UVERBS_DECLARE_CMD(query_srq);
249 IB_UVERBS_DECLARE_CMD(destroy_srq);
250 IB_UVERBS_DECLARE_CMD(create_xsrq);
251 IB_UVERBS_DECLARE_CMD(open_xrcd);
252 IB_UVERBS_DECLARE_CMD(close_xrcd);
254 #define IB_UVERBS_DECLARE_EX_CMD(name) \
255 int ib_uverbs_ex_##name(struct ib_uverbs_file *file, \
256 struct ib_udata *ucore, \
257 struct ib_udata *uhw)
259 IB_UVERBS_DECLARE_EX_CMD(create_flow);
260 IB_UVERBS_DECLARE_EX_CMD(destroy_flow);
261 IB_UVERBS_DECLARE_EX_CMD(query_device);
262 IB_UVERBS_DECLARE_EX_CMD(create_cq);
264 #endif /* UVERBS_H */