linux/include/rdma/uverbs_types.h
<<
>>
Prefs
   1/*
   2 * Copyright (c) 2017, Mellanox Technologies inc.  All rights reserved.
   3 *
   4 * This software is available to you under a choice of one of two
   5 * licenses.  You may choose to be licensed under the terms of the GNU
   6 * General Public License (GPL) Version 2, available from the file
   7 * COPYING in the main directory of this source tree, or the
   8 * OpenIB.org BSD license below:
   9 *
  10 *     Redistribution and use in source and binary forms, with or
  11 *     without modification, are permitted provided that the following
  12 *     conditions are met:
  13 *
  14 *      - Redistributions of source code must retain the above
  15 *        copyright notice, this list of conditions and the following
  16 *        disclaimer.
  17 *
  18 *      - Redistributions in binary form must reproduce the above
  19 *        copyright notice, this list of conditions and the following
  20 *        disclaimer in the documentation and/or other materials
  21 *        provided with the distribution.
  22 *
  23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30 * SOFTWARE.
  31 */
  32
  33#ifndef _UVERBS_TYPES_
  34#define _UVERBS_TYPES_
  35
  36#include <linux/kernel.h>
  37#include <rdma/ib_verbs.h>
  38
  39struct uverbs_obj_type;
  40struct uverbs_api_object;
  41
  42enum rdma_lookup_mode {
  43        UVERBS_LOOKUP_READ,
  44        UVERBS_LOOKUP_WRITE,
  45        /*
  46         * Destroy is like LOOKUP_WRITE, except that the uobject is not
  47         * locked.  uobj_destroy is used to convert a LOOKUP_DESTROY lock into
  48         * a LOOKUP_WRITE lock.
  49         */
  50        UVERBS_LOOKUP_DESTROY,
  51};
  52
  53/*
  54 * The following sequences are valid:
  55 * Success flow:
  56 *   alloc_begin
  57 *   alloc_commit
  58 *    [..]
  59 * Access flow:
  60 *   lookup_get(exclusive=false) & uverbs_try_lock_object
  61 *   lookup_put(exclusive=false) via rdma_lookup_put_uobject
  62 * Destruction flow:
  63 *   lookup_get(exclusive=true) & uverbs_try_lock_object
  64 *   remove_commit
  65 *   remove_handle (optional)
  66 *   lookup_put(exclusive=true) via rdma_lookup_put_uobject
  67 *
  68 * Allocate Error flow #1
  69 *   alloc_begin
  70 *   alloc_abort
  71 * Allocate Error flow #2
  72 *   alloc_begin
  73 *   remove_commit
  74 *   alloc_abort
  75 * Allocate Error flow #3
  76 *   alloc_begin
  77 *   alloc_commit (fails)
  78 *   remove_commit
  79 *   alloc_abort
  80 *
  81 * In all cases the caller must hold the ufile kref until alloc_commit or
  82 * alloc_abort returns.
  83 */
  84struct uverbs_obj_type_class {
  85        struct ib_uobject *(*alloc_begin)(const struct uverbs_api_object *obj,
  86                                          struct ib_uverbs_file *ufile);
  87        /* This consumes the kref on uobj */
  88        int (*alloc_commit)(struct ib_uobject *uobj);
  89        /* This does not consume the kref on uobj */
  90        void (*alloc_abort)(struct ib_uobject *uobj);
  91
  92        struct ib_uobject *(*lookup_get)(const struct uverbs_api_object *obj,
  93                                         struct ib_uverbs_file *ufile, s64 id,
  94                                         enum rdma_lookup_mode mode);
  95        void (*lookup_put)(struct ib_uobject *uobj, enum rdma_lookup_mode mode);
  96        /* This does not consume the kref on uobj */
  97        int __must_check (*destroy_hw)(struct ib_uobject *uobj,
  98                                       enum rdma_remove_reason why,
  99                                       struct uverbs_attr_bundle *attrs);
 100        void (*remove_handle)(struct ib_uobject *uobj);
 101        u8    needs_kfree_rcu;
 102};
 103
 104struct uverbs_obj_type {
 105        const struct uverbs_obj_type_class * const type_class;
 106        size_t       obj_size;
 107};
 108
 109/*
 110 * Objects type classes which support a detach state (object is still alive but
 111 * it's not attached to any context need to make sure:
 112 * (a) no call through to a driver after a detach is called
 113 * (b) detach isn't called concurrently with context_cleanup
 114 */
 115
 116struct uverbs_obj_idr_type {
 117        /*
 118         * In idr based objects, uverbs_obj_type_class points to a generic
 119         * idr operations. In order to specialize the underlying types (e.g. CQ,
 120         * QPs, etc.), we add destroy_object specific callbacks.
 121         */
 122        struct uverbs_obj_type  type;
 123
 124        /* Free driver resources from the uobject, make the driver uncallable,
 125         * and move the uobject to the detached state. If the object was
 126         * destroyed by the user's request, a failure should leave the uobject
 127         * completely unchanged.
 128         */
 129        int __must_check (*destroy_object)(struct ib_uobject *uobj,
 130                                           enum rdma_remove_reason why,
 131                                           struct uverbs_attr_bundle *attrs);
 132};
 133
 134struct ib_uobject *rdma_lookup_get_uobject(const struct uverbs_api_object *obj,
 135                                           struct ib_uverbs_file *ufile, s64 id,
 136                                           enum rdma_lookup_mode mode,
 137                                           struct uverbs_attr_bundle *attrs);
 138void rdma_lookup_put_uobject(struct ib_uobject *uobj,
 139                             enum rdma_lookup_mode mode);
 140struct ib_uobject *rdma_alloc_begin_uobject(const struct uverbs_api_object *obj,
 141                                            struct ib_uverbs_file *ufile,
 142                                            struct uverbs_attr_bundle *attrs);
 143void rdma_alloc_abort_uobject(struct ib_uobject *uobj,
 144                              struct uverbs_attr_bundle *attrs);
 145int __must_check rdma_alloc_commit_uobject(struct ib_uobject *uobj,
 146                                           struct uverbs_attr_bundle *attrs);
 147
 148struct uverbs_obj_fd_type {
 149        /*
 150         * In fd based objects, uverbs_obj_type_ops points to generic
 151         * fd operations. In order to specialize the underlying types (e.g.
 152         * completion_channel), we use fops, name and flags for fd creation.
 153         * context_closed is called when the context is closed either when
 154         * the driver is removed or the process terminated.
 155         */
 156        struct uverbs_obj_type  type;
 157        int (*context_closed)(struct ib_uobject *uobj,
 158                              enum rdma_remove_reason why);
 159        const struct file_operations    *fops;
 160        const char                      *name;
 161        int                             flags;
 162};
 163
 164extern const struct uverbs_obj_type_class uverbs_idr_class;
 165extern const struct uverbs_obj_type_class uverbs_fd_class;
 166void uverbs_close_fd(struct file *f);
 167
 168#define UVERBS_BUILD_BUG_ON(cond) (sizeof(char[1 - 2 * !!(cond)]) -     \
 169                                   sizeof(char))
 170#define UVERBS_TYPE_ALLOC_FD(_obj_size, _context_closed, _fops, _name, _flags)\
 171        ((&((const struct uverbs_obj_fd_type)                           \
 172         {.type = {                                                     \
 173                .type_class = &uverbs_fd_class,                         \
 174                .obj_size = (_obj_size) +                               \
 175                        UVERBS_BUILD_BUG_ON((_obj_size) <               \
 176                                            sizeof(struct ib_uobject)), \
 177         },                                                             \
 178         .context_closed = _context_closed,                             \
 179         .fops = _fops,                                                 \
 180         .name = _name,                                                 \
 181         .flags = _flags}))->type)
 182#define UVERBS_TYPE_ALLOC_IDR_SZ(_size, _destroy_object)        \
 183        ((&((const struct uverbs_obj_idr_type)                          \
 184         {.type = {                                                     \
 185                .type_class = &uverbs_idr_class,                        \
 186                .obj_size = (_size) +                                   \
 187                        UVERBS_BUILD_BUG_ON((_size) <                   \
 188                                            sizeof(struct ib_uobject))  \
 189         },                                                             \
 190         .destroy_object = _destroy_object,}))->type)
 191#define UVERBS_TYPE_ALLOC_IDR(_destroy_object)                  \
 192         UVERBS_TYPE_ALLOC_IDR_SZ(sizeof(struct ib_uobject),    \
 193                                  _destroy_object)
 194
 195#endif
 196