ecb830127865d5ef96f534c62351be697d90fbb5
[linux-2.6.git] / drivers / infiniband / core / uverbs.h
1 /*
2  * Copyright (c) 2005 Topspin Communications.  All rights reserved.
3  * Copyright (c) 2005 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  * $Id: uverbs.h 2559 2005-06-06 19:43:16Z roland $
37  */
38
39 #ifndef UVERBS_H
40 #define UVERBS_H
41
42 #include <linux/kref.h>
43 #include <linux/idr.h>
44
45 #include <rdma/ib_verbs.h>
46 #include <rdma/ib_user_verbs.h>
47
48 /*
49  * Our lifetime rules for these structs are the following:
50  *
51  * struct ib_uverbs_device: One reference is held by the module and
52  * released in ib_uverbs_remove_one().  Another reference is taken by
53  * ib_uverbs_open() each time the character special file is opened,
54  * and released in ib_uverbs_release_file() when the file is released.
55  *
56  * struct ib_uverbs_file: One reference is held by the VFS and
57  * released when the file is closed.  Another reference is taken when
58  * an asynchronous event queue file is created and released when the
59  * event file is closed.
60  *
61  * struct ib_uverbs_event_file: One reference is held by the VFS and
62  * released when the file is closed.  For asynchronous event files,
63  * another reference is held by the corresponding main context file
64  * and released when that file is closed.  For completion event files,
65  * a reference is taken when a CQ is created that uses the file, and
66  * released when the CQ is destroyed.
67  */
68
69 struct ib_uverbs_device {
70         struct kref                             ref;
71         int                                     devnum;
72         struct cdev                            *dev;
73         struct class_device                    *class_dev;
74         struct ib_device                       *ib_dev;
75         int                                     num_comp_vectors;
76 };
77
78 struct ib_uverbs_event_file {
79         struct kref                             ref;
80         struct file                            *file;
81         struct ib_uverbs_file                  *uverbs_file;
82         spinlock_t                              lock;
83         int                                     is_async;
84         wait_queue_head_t                       poll_wait;
85         struct fasync_struct                   *async_queue;
86         struct list_head                        event_list;
87 };
88
89 struct ib_uverbs_file {
90         struct kref                             ref;
91         struct semaphore                        mutex;
92         struct ib_uverbs_device                *device;
93         struct ib_ucontext                     *ucontext;
94         struct ib_event_handler                 event_handler;
95         struct ib_uverbs_event_file            *async_file;
96 };
97
98 struct ib_uverbs_event {
99         union {
100                 struct ib_uverbs_async_event_desc       async;
101                 struct ib_uverbs_comp_event_desc        comp;
102         }                                       desc;
103         struct list_head                        list;
104         struct list_head                        obj_list;
105         u32                                    *counter;
106 };
107
108 struct ib_uevent_object {
109         struct ib_uobject       uobject;
110         struct list_head        event_list;
111         u32                     events_reported;
112 };
113
114 struct ib_ucq_object {
115         struct ib_uobject       uobject;
116         struct ib_uverbs_file  *uverbs_file;
117         struct list_head        comp_list;
118         struct list_head        async_list;
119         u32                     comp_events_reported;
120         u32                     async_events_reported;
121 };
122
123 extern struct semaphore ib_uverbs_idr_mutex;
124 extern struct idr ib_uverbs_pd_idr;
125 extern struct idr ib_uverbs_mr_idr;
126 extern struct idr ib_uverbs_mw_idr;
127 extern struct idr ib_uverbs_ah_idr;
128 extern struct idr ib_uverbs_cq_idr;
129 extern struct idr ib_uverbs_qp_idr;
130 extern struct idr ib_uverbs_srq_idr;
131
132 struct file *ib_uverbs_alloc_event_file(struct ib_uverbs_file *uverbs_file,
133                                         int is_async, int *fd);
134 void ib_uverbs_release_event_file(struct kref *ref);
135 struct ib_uverbs_event_file *ib_uverbs_lookup_comp_file(int fd);
136
137 void ib_uverbs_release_ucq(struct ib_uverbs_file *file,
138                            struct ib_uverbs_event_file *ev_file,
139                            struct ib_ucq_object *uobj);
140 void ib_uverbs_release_uevent(struct ib_uverbs_file *file,
141                               struct ib_uevent_object *uobj);
142
143 void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
144 void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
145 void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
146 void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
147 void ib_uverbs_event_handler(struct ib_event_handler *handler,
148                              struct ib_event *event);
149
150 int ib_umem_get(struct ib_device *dev, struct ib_umem *mem,
151                 void *addr, size_t size, int write);
152 void ib_umem_release(struct ib_device *dev, struct ib_umem *umem);
153 void ib_umem_release_on_close(struct ib_device *dev, struct ib_umem *umem);
154
155 #define IB_UVERBS_DECLARE_CMD(name)                                     \
156         ssize_t ib_uverbs_##name(struct ib_uverbs_file *file,           \
157                                  const char __user *buf, int in_len,    \
158                                  int out_len)
159
160 IB_UVERBS_DECLARE_CMD(get_context);
161 IB_UVERBS_DECLARE_CMD(query_device);
162 IB_UVERBS_DECLARE_CMD(query_port);
163 IB_UVERBS_DECLARE_CMD(alloc_pd);
164 IB_UVERBS_DECLARE_CMD(dealloc_pd);
165 IB_UVERBS_DECLARE_CMD(reg_mr);
166 IB_UVERBS_DECLARE_CMD(dereg_mr);
167 IB_UVERBS_DECLARE_CMD(create_comp_channel);
168 IB_UVERBS_DECLARE_CMD(create_cq);
169 IB_UVERBS_DECLARE_CMD(poll_cq);
170 IB_UVERBS_DECLARE_CMD(req_notify_cq);
171 IB_UVERBS_DECLARE_CMD(destroy_cq);
172 IB_UVERBS_DECLARE_CMD(create_qp);
173 IB_UVERBS_DECLARE_CMD(modify_qp);
174 IB_UVERBS_DECLARE_CMD(destroy_qp);
175 IB_UVERBS_DECLARE_CMD(post_send);
176 IB_UVERBS_DECLARE_CMD(post_recv);
177 IB_UVERBS_DECLARE_CMD(post_srq_recv);
178 IB_UVERBS_DECLARE_CMD(create_ah);
179 IB_UVERBS_DECLARE_CMD(destroy_ah);
180 IB_UVERBS_DECLARE_CMD(attach_mcast);
181 IB_UVERBS_DECLARE_CMD(detach_mcast);
182 IB_UVERBS_DECLARE_CMD(create_srq);
183 IB_UVERBS_DECLARE_CMD(modify_srq);
184 IB_UVERBS_DECLARE_CMD(destroy_srq);
185
186 #endif /* UVERBS_H */