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 #define uobj_get_read(_type, _id, _attrs) \ 52 rdma_lookup_get_uobject(uobj_get_type(_attrs, _type), (_attrs)->ufile, \ 53 _uobj_check_id(_id), UVERBS_LOOKUP_READ) 54 55 #define ufd_get_read(_type, _fdnum, _attrs) \ 56 rdma_lookup_get_uobject(uobj_get_type(_attrs, _type), (_attrs)->ufile, \ 57 (_fdnum)*typecheck(s32, _fdnum), \ 58 UVERBS_LOOKUP_READ) 59 60 static inline void *_uobj_get_obj_read(struct ib_uobject *uobj) 61 { 62 if (IS_ERR(uobj)) 63 return NULL; 64 return uobj->object; 65 } 66 #define uobj_get_obj_read(_object, _type, _id, _attrs) \ 67 ((struct ib_##_object *)_uobj_get_obj_read( \ 68 uobj_get_read(_type, _id, _attrs))) 69 70 #define uobj_get_write(_type, _id, _attrs) \ 71 rdma_lookup_get_uobject(uobj_get_type(_attrs, _type), (_attrs)->ufile, \ 72 _uobj_check_id(_id), UVERBS_LOOKUP_WRITE) 73 74 int __uobj_perform_destroy(const struct uverbs_api_object *obj, u32 id, 75 const struct uverbs_attr_bundle *attrs, 76 int success_res); 77 #define uobj_perform_destroy(_type, _id, _attrs, _success_res) \ 78 __uobj_perform_destroy(uobj_get_type(_attrs, _type), \ 79 _uobj_check_id(_id), _attrs, _success_res) 80 81 struct ib_uobject *__uobj_get_destroy(const struct uverbs_api_object *obj, 82 u32 id, 83 const struct uverbs_attr_bundle *attrs); 84 85 #define uobj_get_destroy(_type, _id, _attrs) \ 86 __uobj_get_destroy(uobj_get_type(_attrs, _type), _uobj_check_id(_id), \ 87 _attrs) 88 89 static inline void uobj_put_destroy(struct ib_uobject *uobj) 90 { 91 rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_WRITE); 92 } 93 94 static inline void uobj_put_read(struct ib_uobject *uobj) 95 { 96 rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_READ); 97 } 98 99 #define uobj_put_obj_read(_obj) \ 100 uobj_put_read((_obj)->uobject) 101 102 static inline void uobj_put_write(struct ib_uobject *uobj) 103 { 104 rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_WRITE); 105 } 106 107 static inline int __must_check uobj_alloc_commit(struct ib_uobject *uobj, 108 int success_res) 109 { 110 int ret = rdma_alloc_commit_uobject(uobj); 111 112 if (ret) 113 return ret; 114 return success_res; 115 } 116 117 static inline void uobj_alloc_abort(struct ib_uobject *uobj) 118 { 119 rdma_alloc_abort_uobject(uobj); 120 } 121 122 static inline struct ib_uobject * 123 __uobj_alloc(const struct uverbs_api_object *obj, 124 struct uverbs_attr_bundle *attrs, struct ib_device **ib_dev) 125 { 126 struct ib_uobject *uobj = rdma_alloc_begin_uobject(obj, attrs->ufile); 127 128 if (!IS_ERR(uobj)) 129 *ib_dev = uobj->context->device; 130 return uobj; 131 } 132 133 #define uobj_alloc(_type, _attrs, _ib_dev) \ 134 __uobj_alloc(uobj_get_type(_attrs, _type), _attrs, _ib_dev) 135 136 static inline void uverbs_flow_action_fill_action(struct ib_flow_action *action, 137 struct ib_uobject *uobj, 138 struct ib_device *ib_dev, 139 enum ib_flow_action_type type) 140 { 141 atomic_set(&action->usecnt, 0); 142 action->device = ib_dev; 143 action->type = type; 144 action->uobject = uobj; 145 uobj->object = action; 146 } 147 148 struct ib_uflow_resources { 149 size_t max; 150 size_t num; 151 size_t collection_num; 152 size_t counters_num; 153 struct ib_counters **counters; 154 struct ib_flow_action **collection; 155 }; 156 157 struct ib_uflow_object { 158 struct ib_uobject uobject; 159 struct ib_uflow_resources *resources; 160 }; 161 162 struct ib_uflow_resources *flow_resources_alloc(size_t num_specs); 163 void flow_resources_add(struct ib_uflow_resources *uflow_res, 164 enum ib_flow_spec_type type, 165 void *ibobj); 166 void ib_uverbs_flow_resources_free(struct ib_uflow_resources *uflow_res); 167 168 static inline void ib_set_flow(struct ib_uobject *uobj, struct ib_flow *ibflow, 169 struct ib_qp *qp, struct ib_device *device, 170 struct ib_uflow_resources *uflow_res) 171 { 172 struct ib_uflow_object *uflow; 173 174 uobj->object = ibflow; 175 ibflow->uobject = uobj; 176 177 if (qp) { 178 atomic_inc(&qp->usecnt); 179 ibflow->qp = qp; 180 } 181 182 ibflow->device = device; 183 uflow = container_of(uobj, typeof(*uflow), uobject); 184 uflow->resources = uflow_res; 185 } 186 187 #endif 188 189