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
  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
  46 #include <rdma/ib_verbs.h>
  47 #include <rdma/ib_umem.h>
  48 #include <rdma/ib_user_verbs.h>
  49 #include <rdma/uverbs_std_types.h>
  50
  51 #define UVERBS_MODULE_NAME ib_uverbs
  52 #include <rdma/uverbs_named_ioctl.h>
  53
  54 static inline void
  55 ib_uverbs_init_udata(struct ib_udata *udata,
  56                      const void __user *ibuf,
  57                      void __user *obuf,
  58                      size_t ilen, size_t olen)
  59 {
  60         udata->inbuf  = ibuf;
  61         udata->outbuf = obuf;
  62         udata->inlen  = ilen;
  63         udata->outlen = olen;
  64 }
  65
  66 static inline void
  67 ib_uverbs_init_udata_buf_or_null(struct ib_udata *udata,
  68                                  const void __user *ibuf,
  69                                  void __user *obuf,
  70                                  size_t ilen, size_t olen)
  71 {
  72         ib_uverbs_init_udata(udata,
  73                              ilen ? ibuf : NULL, olen ? obuf : NULL,
  74                              ilen, olen);
  75 }
  76
  77 /*
  78  * Our lifetime rules for these structs are the following:
  79  *
  80  * struct ib_uverbs_device: One reference is held by the module and
  81  * released in ib_uverbs_remove_one().  Another reference is taken by
  82  * ib_uverbs_open() each time the character special file is opened,
  83  * and released in ib_uverbs_release_file() when the file is released.
  84  *
  85  * struct ib_uverbs_file: One reference is held by the VFS and
  86  * released when the file is closed.  Another reference is taken when
  87  * an asynchronous event queue file is created and released when the
  88  * event file is closed.
  89  *
  90  * struct ib_uverbs_event_queue: Base structure for
  91  * struct ib_uverbs_async_event_file and struct ib_uverbs_completion_event_file.
  92  * One reference is held by the VFS and released when the file is closed.
  93  * For asynchronous event files, another reference is held by the corresponding
  94  * main context file and released when that file is closed.  For completion
  95  * event files, a reference is taken when a CQ is created that uses the file,
  96  * and released when the CQ is destroyed.
  97  */
  98
  99 struct ib_uverbs_device {
 100         atomic_t                                refcount;
 101         u32                                     num_comp_vectors;
 102         struct completion                       comp;
 103         struct device                          *dev;
 104         struct ib_device        __rcu          *ib_dev;
 105         int                                     devnum;
 106         struct cdev                             cdev;
 107         struct rb_root                          xrcd_tree;
 108         struct mutex                            xrcd_tree_mutex;
 109         struct kobject                          kobj;
 110         struct srcu_struct                      disassociate_srcu;
 111         struct mutex                            lists_mutex; /* protect lists */
 112         struct list_head                        uverbs_file_list;
 113         struct list_head                        uverbs_events_file_list;
 114         struct uverbs_api                       *uapi;
 115 };
 116
 117 struct ib_uverbs_event_queue {
 118         spinlock_t                              lock;
 119         int                                     is_closed;
 120         wait_queue_head_t                       poll_wait;
 121         struct fasync_struct                   *async_queue;
 122         struct list_head                        event_list;
 123 };
 124
 125 struct ib_uverbs_async_event_file {
 126         struct ib_uverbs_event_queue            ev_queue;
 127         struct ib_uverbs_file                  *uverbs_file;
 128         struct kref                             ref;
 129         struct list_head                        list;
 130 };
 131
 132 struct ib_uverbs_completion_event_file {
 133         struct ib_uobject                       uobj;
 134         struct ib_uverbs_event_queue            ev_queue;
 135 };
 136
 137 struct ib_uverbs_file {
 138         struct kref                             ref;
 139         struct ib_uverbs_device                *device;
 140         struct mutex                            ucontext_lock;
 141         /*
 142          * ucontext must be accessed via ib_uverbs_get_ucontext() or with
 143          * ucontext_lock held
 144          */
 145         struct ib_ucontext                     *ucontext;
 146         struct ib_event_handler                 event_handler;
 147         struct ib_uverbs_async_event_file       *async_file;
 148         struct list_head                        list;
 149         int                                     is_closed;
 150
 151         /*
 152          * To access the uobjects list hw_destroy_rwsem must be held for write
 153          * OR hw_destroy_rwsem held for read AND uobjects_lock held.
 154          * hw_destroy_rwsem should be called across any destruction of the HW
 155          * object of an associated uobject.
 156          */
 157         struct rw_semaphore     hw_destroy_rwsem;
 158         spinlock_t              uobjects_lock;
 159         struct list_head        uobjects;
 160
 161         u64 uverbs_cmd_mask;
 162         u64 uverbs_ex_cmd_mask;
 163
 164         struct idr              idr;
 165         /* spinlock protects write access to idr */
 166         spinlock_t              idr_lock;
 167 };
 168
 169 struct ib_uverbs_event {
 170         union {
 171                 struct ib_uverbs_async_event_desc       async;
 172                 struct ib_uverbs_comp_event_desc        comp;
 173         }                                       desc;
 174         struct list_head                        list;
 175         struct list_head                        obj_list;
 176         u32                                    *counter;
 177 };
 178
 179 struct ib_uverbs_mcast_entry {
 180         struct list_head        list;
 181         union ib_gid            gid;
 182         u16                     lid;
 183 };
 184
 185 struct ib_uevent_object {
 186         struct ib_uobject       uobject;
 187         struct list_head        event_list;
 188         u32                     events_reported;
 189 };
 190
 191 struct ib_uxrcd_object {
 192         struct ib_uobject       uobject;
 193         atomic_t                refcnt;
 194 };
 195
 196 struct ib_usrq_object {
 197         struct ib_uevent_object uevent;
 198         struct ib_uxrcd_object *uxrcd;
 199 };
 200
 201 struct ib_uqp_object {
 202         struct ib_uevent_object uevent;
 203         /* lock for mcast list */
 204         struct mutex            mcast_lock;
 205         struct list_head        mcast_list;
 206         struct ib_uxrcd_object *uxrcd;
 207 };
 208
 209 struct ib_uwq_object {
 210         struct ib_uevent_object uevent;
 211 };
 212
 213 struct ib_ucq_object {
 214         struct ib_uobject       uobject;
 215         struct list_head        comp_list;
 216         struct list_head        async_list;
 217         u32                     comp_events_reported;
 218         u32                     async_events_reported;
 219 };
 220
 221 struct ib_uflow_resources;
 222 struct ib_uflow_object {
 223         struct ib_uobject               uobject;
 224         struct ib_uflow_resources       *resources;
 225 };
 226
 227 extern const struct file_operations uverbs_event_fops;
 228 void ib_uverbs_init_event_queue(struct ib_uverbs_event_queue *ev_queue);
 229 struct file *ib_uverbs_alloc_async_event_file(struct ib_uverbs_file *uverbs_file,
 230                                               struct ib_device *ib_dev);
 231 void ib_uverbs_free_async_event_file(struct ib_uverbs_file *uverbs_file);
 232 void ib_uverbs_flow_resources_free(struct ib_uflow_resources *uflow_res);
 233
 234 void ib_uverbs_release_ucq(struct ib_uverbs_file *file,
 235                            struct ib_uverbs_completion_event_file *ev_file,
 236                            struct ib_ucq_object *uobj);
 237 void ib_uverbs_release_uevent(struct ib_uverbs_file *file,
 238                               struct ib_uevent_object *uobj);
 239 void ib_uverbs_release_file(struct kref *ref);
 240
 241 void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
 242 void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
 243 void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
 244 void ib_uverbs_wq_event_handler(struct ib_event *event, void *context_ptr);
 245 void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
 246 void ib_uverbs_event_handler(struct ib_event_handler *handler,
 247                              struct ib_event *event);
 248 int ib_uverbs_dealloc_xrcd(struct ib_uobject *uobject, struct ib_xrcd *xrcd,
 249                            enum rdma_remove_reason why);
 250
 251 int uverbs_dealloc_mw(struct ib_mw *mw);
 252 void ib_uverbs_detach_umcast(struct ib_qp *qp,
 253                              struct ib_uqp_object *uobj);
 254
 255 void create_udata(struct uverbs_attr_bundle *ctx, struct ib_udata *udata);
 256 long ib_uverbs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
 257
 258 struct ib_uverbs_flow_spec {
 259         union {
 260                 union {
 261                         struct ib_uverbs_flow_spec_hdr hdr;
 262                         struct {
 263                                 __u32 type;
 264                                 __u16 size;
 265                                 __u16 reserved;
 266                         };
 267                 };
 268                 struct ib_uverbs_flow_spec_eth     eth;
 269                 struct ib_uverbs_flow_spec_ipv4    ipv4;
 270                 struct ib_uverbs_flow_spec_esp     esp;
 271                 struct ib_uverbs_flow_spec_tcp_udp tcp_udp;
 272                 struct ib_uverbs_flow_spec_ipv6    ipv6;
 273                 struct ib_uverbs_flow_spec_action_tag   flow_tag;
 274                 struct ib_uverbs_flow_spec_action_drop  drop;
 275                 struct ib_uverbs_flow_spec_action_handle action;
 276                 struct ib_uverbs_flow_spec_action_count flow_count;
 277         };
 278 };
 279
 280 int ib_uverbs_kern_spec_to_ib_spec_filter(enum ib_flow_spec_type type,
 281                                           const void *kern_spec_mask,
 282                                           const void *kern_spec_val,
 283                                           size_t kern_filter_sz,
 284                                           union ib_flow_spec *ib_spec);
 285
 286 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_DEVICE);
 287 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_PD);
 288 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_MR);
 289 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_COMP_CHANNEL);
 290 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_CQ);
 291 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_QP);
 292 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_AH);
 293 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_MW);
 294 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_SRQ);
 295 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_FLOW);
 296 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_WQ);
 297 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_RWQ_IND_TBL);
 298 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_XRCD);
 299 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_FLOW_ACTION);
 300 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_DM);
 301 extern const struct uverbs_object_def UVERBS_OBJECT(UVERBS_OBJECT_COUNTERS);
 302
 303 #define IB_UVERBS_DECLARE_CMD(name)                                     \
 304         ssize_t ib_uverbs_##name(struct ib_uverbs_file *file,           \
 305                                  const char __user *buf, int in_len,    \
 306                                  int out_len)
 307
 308 IB_UVERBS_DECLARE_CMD(get_context);
 309 IB_UVERBS_DECLARE_CMD(query_device);
 310 IB_UVERBS_DECLARE_CMD(query_port);
 311 IB_UVERBS_DECLARE_CMD(alloc_pd);
 312 IB_UVERBS_DECLARE_CMD(dealloc_pd);
 313 IB_UVERBS_DECLARE_CMD(reg_mr);
 314 IB_UVERBS_DECLARE_CMD(rereg_mr);
 315 IB_UVERBS_DECLARE_CMD(dereg_mr);
 316 IB_UVERBS_DECLARE_CMD(alloc_mw);
 317 IB_UVERBS_DECLARE_CMD(dealloc_mw);
 318 IB_UVERBS_DECLARE_CMD(create_comp_channel);
 319 IB_UVERBS_DECLARE_CMD(create_cq);
 320 IB_UVERBS_DECLARE_CMD(resize_cq);
 321 IB_UVERBS_DECLARE_CMD(poll_cq);
 322 IB_UVERBS_DECLARE_CMD(req_notify_cq);
 323 IB_UVERBS_DECLARE_CMD(destroy_cq);
 324 IB_UVERBS_DECLARE_CMD(create_qp);
 325 IB_UVERBS_DECLARE_CMD(open_qp);
 326 IB_UVERBS_DECLARE_CMD(query_qp);
 327 IB_UVERBS_DECLARE_CMD(modify_qp);
 328 IB_UVERBS_DECLARE_CMD(destroy_qp);
 329 IB_UVERBS_DECLARE_CMD(post_send);
 330 IB_UVERBS_DECLARE_CMD(post_recv);
 331 IB_UVERBS_DECLARE_CMD(post_srq_recv);
 332 IB_UVERBS_DECLARE_CMD(create_ah);
 333 IB_UVERBS_DECLARE_CMD(destroy_ah);
 334 IB_UVERBS_DECLARE_CMD(attach_mcast);
 335 IB_UVERBS_DECLARE_CMD(detach_mcast);
 336 IB_UVERBS_DECLARE_CMD(create_srq);
 337 IB_UVERBS_DECLARE_CMD(modify_srq);
 338 IB_UVERBS_DECLARE_CMD(query_srq);
 339 IB_UVERBS_DECLARE_CMD(destroy_srq);
 340 IB_UVERBS_DECLARE_CMD(create_xsrq);
 341 IB_UVERBS_DECLARE_CMD(open_xrcd);
 342 IB_UVERBS_DECLARE_CMD(close_xrcd);
 343
 344 #define IB_UVERBS_DECLARE_EX_CMD(name)                          \
 345         int ib_uverbs_ex_##name(struct ib_uverbs_file *file,    \
 346                                 struct ib_udata *ucore,         \
 347                                 struct ib_udata *uhw)
 348
 349 IB_UVERBS_DECLARE_EX_CMD(create_flow);
 350 IB_UVERBS_DECLARE_EX_CMD(destroy_flow);
 351 IB_UVERBS_DECLARE_EX_CMD(query_device);
 352 IB_UVERBS_DECLARE_EX_CMD(create_cq);
 353 IB_UVERBS_DECLARE_EX_CMD(create_qp);
 354 IB_UVERBS_DECLARE_EX_CMD(create_wq);
 355 IB_UVERBS_DECLARE_EX_CMD(modify_wq);
 356 IB_UVERBS_DECLARE_EX_CMD(destroy_wq);
 357 IB_UVERBS_DECLARE_EX_CMD(create_rwq_ind_table);
 358 IB_UVERBS_DECLARE_EX_CMD(destroy_rwq_ind_table);
 359 IB_UVERBS_DECLARE_EX_CMD(modify_qp);
 360 IB_UVERBS_DECLARE_EX_CMD(modify_cq);
 361
 362 #endif /* UVERBS_H */