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