]>
git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blob - include/rdma/uverbs_std_types.h
2 * Copyright (c) 2017, Mellanox Technologies inc. All rights reserved.
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:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
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.
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
33 #ifndef _UVERBS_STD_TYPES__
34 #define _UVERBS_STD_TYPES__
36 #include <rdma/uverbs_types.h>
37 #include <rdma/uverbs_ioctl.h>
38 #include <rdma/ib_user_ioctl_verbs.h>
40 /* Returns _id, or causes a compile error if _id is not a u32.
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.
46 #define _uobj_check_id(_id) ((_id) * typecheck(u32, _id))
48 #define uobj_get_type(_attrs, _object) \
49 uapi_get_object((_attrs)->ufile->device->uapi, _object)
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, \
56 #define ufd_get_read(_type, _fdnum, _attrs) \
57 rdma_lookup_get_uobject(uobj_get_type(_attrs, _type), (_attrs)->ufile, \
58 (_fdnum)*typecheck(s32, _fdnum), \
59 UVERBS_LOOKUP_READ, _attrs)
61 static inline void *_uobj_get_obj_read(struct ib_uobject
*uobj
)
67 #define uobj_get_obj_read(_object, _type, _id, _attrs) \
68 ((struct ib_##_object *)_uobj_get_obj_read( \
69 uobj_get_read(_type, _id, _attrs)))
71 #define uobj_get_write(_type, _id, _attrs) \
72 rdma_lookup_get_uobject(uobj_get_type(_attrs, _type), (_attrs)->ufile, \
73 _uobj_check_id(_id), UVERBS_LOOKUP_WRITE, \
76 int __uobj_perform_destroy(const struct uverbs_api_object
*obj
, u32 id
,
77 struct uverbs_attr_bundle
*attrs
);
78 #define uobj_perform_destroy(_type, _id, _attrs) \
79 __uobj_perform_destroy(uobj_get_type(_attrs, _type), \
80 _uobj_check_id(_id), _attrs)
82 struct ib_uobject
*__uobj_get_destroy(const struct uverbs_api_object
*obj
,
83 u32 id
, struct uverbs_attr_bundle
*attrs
);
85 #define uobj_get_destroy(_type, _id, _attrs) \
86 __uobj_get_destroy(uobj_get_type(_attrs, _type), _uobj_check_id(_id), \
89 static inline void uobj_put_destroy(struct ib_uobject
*uobj
)
91 rdma_lookup_put_uobject(uobj
, UVERBS_LOOKUP_WRITE
);
94 static inline void uobj_put_read(struct ib_uobject
*uobj
)
96 rdma_lookup_put_uobject(uobj
, UVERBS_LOOKUP_READ
);
99 #define uobj_put_obj_read(_obj) \
100 uobj_put_read((_obj)->uobject)
102 static inline void uobj_put_write(struct ib_uobject
*uobj
)
104 rdma_lookup_put_uobject(uobj
, UVERBS_LOOKUP_WRITE
);
107 static inline int __must_check
108 uobj_alloc_commit(struct ib_uobject
*uobj
, struct uverbs_attr_bundle
*attrs
)
110 int ret
= rdma_alloc_commit_uobject(uobj
, attrs
);
117 static inline void uobj_alloc_abort(struct ib_uobject
*uobj
,
118 struct uverbs_attr_bundle
*attrs
)
120 rdma_alloc_abort_uobject(uobj
, attrs
);
123 static inline struct ib_uobject
*
124 __uobj_alloc(const struct uverbs_api_object
*obj
,
125 struct uverbs_attr_bundle
*attrs
, struct ib_device
**ib_dev
)
127 struct ib_uobject
*uobj
=
128 rdma_alloc_begin_uobject(obj
, attrs
->ufile
, attrs
);
131 *ib_dev
= attrs
->context
->device
;
135 #define uobj_alloc(_type, _attrs, _ib_dev) \
136 __uobj_alloc(uobj_get_type(_attrs, _type), _attrs, _ib_dev)
138 static inline void uverbs_flow_action_fill_action(struct ib_flow_action
*action
,
139 struct ib_uobject
*uobj
,
140 struct ib_device
*ib_dev
,
141 enum ib_flow_action_type type
)
143 atomic_set(&action
->usecnt
, 0);
144 action
->device
= ib_dev
;
146 action
->uobject
= uobj
;
147 uobj
->object
= action
;
150 struct ib_uflow_resources
{
153 size_t collection_num
;
155 struct ib_counters
**counters
;
156 struct ib_flow_action
**collection
;
159 struct ib_uflow_object
{
160 struct ib_uobject uobject
;
161 struct ib_uflow_resources
*resources
;
164 struct ib_uflow_resources
*flow_resources_alloc(size_t num_specs
);
165 void flow_resources_add(struct ib_uflow_resources
*uflow_res
,
166 enum ib_flow_spec_type type
,
168 void ib_uverbs_flow_resources_free(struct ib_uflow_resources
*uflow_res
);
170 static inline void ib_set_flow(struct ib_uobject
*uobj
, struct ib_flow
*ibflow
,
171 struct ib_qp
*qp
, struct ib_device
*device
,
172 struct ib_uflow_resources
*uflow_res
)
174 struct ib_uflow_object
*uflow
;
176 uobj
->object
= ibflow
;
177 ibflow
->uobject
= uobj
;
180 atomic_inc(&qp
->usecnt
);
184 ibflow
->device
= device
;
185 uflow
= container_of(uobj
, typeof(*uflow
), uobject
);
186 uflow
->resources
= uflow_res
;
189 struct uverbs_api_object
{
190 const struct uverbs_obj_type
*type_attrs
;
191 const struct uverbs_obj_type_class
*type_class
;
196 static inline u32
uobj_get_object_id(struct ib_uobject
*uobj
)
198 return uobj
->uapi_object
->id
;