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