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 #if IS_ENABLED(CONFIG_INFINIBAND_USER_ACCESS)
  41 const struct uverbs_object_tree_def *uverbs_default_get_objects(void);
  42 #else
  43 static inline const struct uverbs_object_tree_def *uverbs_default_get_objects(void)
  44 {
  45         return NULL;
  46 }
  47 #endif
  48
  49 /* Returns _id, or causes a compile error if _id is not a u32.
  50  *
  51  * The uobj APIs should only be used with the write based uAPI to access
  52  * object IDs. The write API must use a u32 for the object handle, which is
  53  * checked by this macro.
  54  */
  55 #define _uobj_check_id(_id) ((_id) * typecheck(u32, _id))
  56
  57 #define uobj_get_type(_object) UVERBS_OBJECT(_object).type_attrs
  58
  59 #define uobj_get_read(_type, _id, _ufile)                                      \
  60         rdma_lookup_get_uobject(uobj_get_type(_type), _ufile,                  \
  61                                 _uobj_check_id(_id), false)
  62
  63 #define ufd_get_read(_type, _fdnum, _ufile)                                    \
  64         rdma_lookup_get_uobject(uobj_get_type(_type), _ufile,                  \
  65                                 (_fdnum)*typecheck(s32, _fdnum), false)
  66
  67 static inline void *_uobj_get_obj_read(struct ib_uobject *uobj)
  68 {
  69         if (IS_ERR(uobj))
  70                 return NULL;
  71         return uobj->object;
  72 }
  73 #define uobj_get_obj_read(_object, _type, _id, _ufile)                         \
  74         ((struct ib_##_object *)_uobj_get_obj_read(                            \
  75                 uobj_get_read(_type, _id, _ufile)))
  76
  77 #define uobj_get_write(_type, _id, _ufile)                                     \
  78         rdma_lookup_get_uobject(uobj_get_type(_type), _ufile,                  \
  79                                 _uobj_check_id(_id), true)
  80
  81 int __uobj_perform_destroy(const struct uverbs_obj_type *type, u32 id,
  82                            struct ib_uverbs_file *ufile, int success_res);
  83 #define uobj_perform_destroy(_type, _id, _ufile, _success_res)                 \
  84         __uobj_perform_destroy(uobj_get_type(_type), _uobj_check_id(_id),      \
  85                                _ufile, _success_res)
  86
  87 struct ib_uobject *__uobj_get_destroy(const struct uverbs_obj_type *type,
  88                                       u32 id, struct ib_uverbs_file *ufile);
  89
  90 #define uobj_get_destroy(_type, _id, _ufile)                                   \
  91         __uobj_get_destroy(uobj_get_type(_type), _uobj_check_id(_id), _ufile)
  92
  93 static inline void uobj_put_destroy(struct ib_uobject *uobj)
  94 {
  95         rdma_lookup_put_uobject(uobj, true);
  96 }
  97
  98 static inline void uobj_put_read(struct ib_uobject *uobj)
  99 {
 100         rdma_lookup_put_uobject(uobj, false);
 101 }
 102
 103 #define uobj_put_obj_read(_obj)                                 \
 104         uobj_put_read((_obj)->uobject)
 105
 106 static inline void uobj_put_write(struct ib_uobject *uobj)
 107 {
 108         rdma_lookup_put_uobject(uobj, true);
 109 }
 110
 111 static inline int __must_check uobj_alloc_commit(struct ib_uobject *uobj,
 112                                                  int success_res)
 113 {
 114         int ret = rdma_alloc_commit_uobject(uobj);
 115
 116         if (ret)
 117                 return ret;
 118         return success_res;
 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 *__uobj_alloc(const struct uverbs_obj_type *type,
 127                                               struct ib_uverbs_file *ufile)
 128 {
 129         return rdma_alloc_begin_uobject(type, ufile);
 130 }
 131
 132 #define uobj_alloc(_type, _ufile) __uobj_alloc(uobj_get_type(_type), _ufile)
 133
 134 #endif
 135