include/rdma/uverbs_std_types.h

   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_STD_TYPES__
  34 #define _UVERBS_STD_TYPES__
  35
  36 #include <rdma/uverbs_types.h>
  37 #include <rdma/uverbs_ioctl.h>
  38 #include <rdma/ib_user_ioctl_verbs.h>
  39
  40 /* Returns _id, or causes a compile error if _id is not a u32.
  41  *
  42  * The uobj APIs should only be used with the write based uAPI to access
  43  * object IDs. The write API must use a u32 for the object handle, which is
  44  * checked by this macro.
  45  */
  46 #define _uobj_check_id(_id) ((_id) * typecheck(u32, _id))
  47
  48 #define uobj_get_type(_attrs, _object)                                         \
  49         uapi_get_object((_attrs)->ufile->device->uapi, _object)
  50
  51 struct ib_uobject *_uobj_get_read(enum uverbs_default_objects type,
  52                                   u32 object_id,
  53                                   struct uverbs_attr_bundle *attrs);
  54
  55 #define uobj_get_read(_type, _id, _attrs)                                      \
  56         _uobj_get_read(_type, _uobj_check_id(_id), _attrs)
  57
  58 #define ufd_get_read(_type, _fdnum, _attrs)                                    \
  59         rdma_lookup_get_uobject(uobj_get_type(_attrs, _type), (_attrs)->ufile, \
  60                                 (_fdnum)*typecheck(s32, _fdnum),               \
  61                                 UVERBS_LOOKUP_READ)
  62
  63 static inline void *_uobj_get_obj_read(struct ib_uobject *uobj)
  64 {
  65         if (IS_ERR(uobj))
  66                 return NULL;
  67         return uobj->object;
  68 }
  69 #define uobj_get_obj_read(_object, _type, _id, _attrs)                         \
  70         ((struct ib_##_object *)_uobj_get_obj_read(                            \
  71                 uobj_get_read(_type, _id, _attrs)))
  72
  73 struct ib_uobject *_uobj_get_write(enum uverbs_default_objects type,
  74                                    u32 object_id,
  75                                    struct uverbs_attr_bundle *attrs);
  76
  77 #define uobj_get_write(_type, _id, _attrs)                                     \
  78         _uobj_get_write(_type, _uobj_check_id(_id), _attrs)
  79
  80 int __uobj_perform_destroy(const struct uverbs_api_object *obj, u32 id,
  81                            const struct uverbs_attr_bundle *attrs);
  82 #define uobj_perform_destroy(_type, _id, _attrs)                               \
  83         __uobj_perform_destroy(uobj_get_type(_attrs, _type),                   \
  84                                _uobj_check_id(_id), _attrs)
  85
  86 struct ib_uobject *__uobj_get_destroy(const struct uverbs_api_object *obj,
  87                                       u32 id,
  88                                       const struct uverbs_attr_bundle *attrs);
  89
  90 #define uobj_get_destroy(_type, _id, _attrs)                                   \
  91         __uobj_get_destroy(uobj_get_type(_attrs, _type), _uobj_check_id(_id),  \
  92                            _attrs)
  93
  94 static inline void uobj_put_destroy(struct ib_uobject *uobj)
  95 {
  96         rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_WRITE);
  97 }
  98
  99 static inline void uobj_put_read(struct ib_uobject *uobj)
 100 {
 101         rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_READ);
 102 }
 103
 104 #define uobj_put_obj_read(_obj)                                 \
 105         uobj_put_read((_obj)->uobject)
 106
 107 static inline void uobj_put_write(struct ib_uobject *uobj)
 108 {
 109         rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_WRITE);
 110 }
 111
 112 static inline int __must_check uobj_alloc_commit(struct ib_uobject *uobj)
 113 {
 114         int ret = rdma_alloc_commit_uobject(uobj);
 115
 116         if (ret)
 117                 return ret;
 118         return 0;
 119 }
 120
 121 static inline void uobj_alloc_abort(struct ib_uobject *uobj)
 122 {
 123         rdma_alloc_abort_uobject(uobj);
 124 }
 125
 126 static inline struct ib_uobject *
 127 __uobj_alloc(const struct uverbs_api_object *obj,
 128              struct uverbs_attr_bundle *attrs, struct ib_device **ib_dev)
 129 {
 130         struct ib_uobject *uobj = rdma_alloc_begin_uobject(obj, attrs->ufile);
 131
 132         if (!IS_ERR(uobj)) {
 133                 *ib_dev = uobj->context->device;
 134                 attrs->context = uobj->context;
 135         }
 136         return uobj;
 137 }
 138
 139 #define uobj_alloc(_type, _attrs, _ib_dev)                                     \
 140         __uobj_alloc(uobj_get_type(_attrs, _type), _attrs, _ib_dev)
 141
 142 static inline void uverbs_flow_action_fill_action(struct ib_flow_action *action,
 143                                                   struct ib_uobject *uobj,
 144                                                   struct ib_device *ib_dev,
 145                                                   enum ib_flow_action_type type)
 146 {
 147         atomic_set(&action->usecnt, 0);
 148         action->device = ib_dev;
 149         action->type = type;
 150         action->uobject = uobj;
 151         uobj->object = action;
 152 }
 153
 154 struct ib_uflow_resources {
 155         size_t                  max;
 156         size_t                  num;
 157         size_t                  collection_num;
 158         size_t                  counters_num;
 159         struct ib_counters      **counters;
 160         struct ib_flow_action   **collection;
 161 };
 162
 163 struct ib_uflow_object {
 164         struct ib_uobject               uobject;
 165         struct ib_uflow_resources       *resources;
 166 };
 167
 168 struct ib_uflow_resources *flow_resources_alloc(size_t num_specs);
 169 void flow_resources_add(struct ib_uflow_resources *uflow_res,
 170                         enum ib_flow_spec_type type,
 171                         void *ibobj);
 172 void ib_uverbs_flow_resources_free(struct ib_uflow_resources *uflow_res);
 173
 174 static inline void ib_set_flow(struct ib_uobject *uobj, struct ib_flow *ibflow,
 175                                struct ib_qp *qp, struct ib_device *device,
 176                                struct ib_uflow_resources *uflow_res)
 177 {
 178         struct ib_uflow_object *uflow;
 179
 180         uobj->object = ibflow;
 181         ibflow->uobject = uobj;
 182
 183         if (qp) {
 184                 atomic_inc(&qp->usecnt);
 185                 ibflow->qp = qp;
 186         }
 187
 188         ibflow->device = device;
 189         uflow = container_of(uobj, typeof(*uflow), uobject);
 190         uflow->resources = uflow_res;
 191 }
 192
 193 struct uverbs_api_object {
 194         const struct uverbs_obj_type *type_attrs;
 195         const struct uverbs_obj_type_class *type_class;
 196         u8 disabled:1;
 197         u32 id;
 198 };
 199
 200 static inline u32 uobj_get_object_id(struct ib_uobject *uobj)
 201 {
 202         return uobj->uapi_object->id;
 203 }
 204
 205 #endif
 206