[linux-2.6-block.git] / include / rdma / uverbs_types.h

/*
 * Copyright (c) 2017, Mellanox Technologies inc.  All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef _UVERBS_TYPES_
#define _UVERBS_TYPES_

#include <linux/kernel.h>
#include <rdma/ib_verbs.h>

struct uverbs_obj_type;
struct uverbs_api_object;

enum rdma_lookup_mode {
	UVERBS_LOOKUP_READ,
	UVERBS_LOOKUP_WRITE,
	/*
	 * Destroy is like LOOKUP_WRITE, except that the uobject is not
	 * locked.  uobj_destroy is used to convert a LOOKUP_DESTROY lock into
	 * a LOOKUP_WRITE lock.
	 */
	UVERBS_LOOKUP_DESTROY,
};

/*
 * The following sequences are valid:
 * Success flow:
 *   alloc_begin
 *   alloc_commit
 *    [..]
 * Access flow:
 *   lookup_get(exclusive=false) & uverbs_try_lock_object
 *   lookup_put(exclusive=false) via rdma_lookup_put_uobject
 * Destruction flow:
 *   lookup_get(exclusive=true) & uverbs_try_lock_object
 *   remove_commit
 *   remove_handle (optional)
 *   lookup_put(exclusive=true) via rdma_lookup_put_uobject
 *
 * Allocate Error flow #1
 *   alloc_begin
 *   alloc_abort
 * Allocate Error flow #2
 *   alloc_begin
 *   remove_commit
 *   alloc_abort
 * Allocate Error flow #3
 *   alloc_begin
 *   alloc_commit (fails)
 *   remove_commit
 *   alloc_abort
 *
 * In all cases the caller must hold the ufile kref until alloc_commit or
 * alloc_abort returns.
 */
struct uverbs_obj_type_class {
	struct ib_uobject *(*alloc_begin)(const struct uverbs_api_object *obj,
					  struct ib_uverbs_file *ufile);
	/* This consumes the kref on uobj */
	int (*alloc_commit)(struct ib_uobject *uobj);
	/* This does not consume the kref on uobj */
	void (*alloc_abort)(struct ib_uobject *uobj);

	struct ib_uobject *(*lookup_get)(const struct uverbs_api_object *obj,
					 struct ib_uverbs_file *ufile, s64 id,
					 enum rdma_lookup_mode mode);
	void (*lookup_put)(struct ib_uobject *uobj, enum rdma_lookup_mode mode);
	/* This does not consume the kref on uobj */
	int __must_check (*destroy_hw)(struct ib_uobject *uobj,
				       enum rdma_remove_reason why);
	void (*remove_handle)(struct ib_uobject *uobj);
	u8    needs_kfree_rcu;
};

struct uverbs_obj_type {
	const struct uverbs_obj_type_class * const type_class;
	size_t	     obj_size;
};

/*
 * Objects type classes which support a detach state (object is still alive but
 * it's not attached to any context need to make sure:
 * (a) no call through to a driver after a detach is called
 * (b) detach isn't called concurrently with context_cleanup
 */

struct uverbs_obj_idr_type {
	/*
	 * In idr based objects, uverbs_obj_type_class points to a generic
	 * idr operations. In order to specialize the underlying types (e.g. CQ,
	 * QPs, etc.), we add destroy_object specific callbacks.
	 */
	struct uverbs_obj_type  type;

	/* Free driver resources from the uobject, make the driver uncallable,
	 * and move the uobject to the detached state. If the object was
	 * destroyed by the user's request, a failure should leave the uobject
	 * completely unchanged.
	 */
	int __must_check (*destroy_object)(struct ib_uobject *uobj,
					   enum rdma_remove_reason why);
};

struct ib_uobject *rdma_lookup_get_uobject(const struct uverbs_api_object *obj,
					   struct ib_uverbs_file *ufile, s64 id,
					   enum rdma_lookup_mode mode);
void rdma_lookup_put_uobject(struct ib_uobject *uobj,
			     enum rdma_lookup_mode mode);
struct ib_uobject *rdma_alloc_begin_uobject(const struct uverbs_api_object *obj,
					    struct ib_uverbs_file *ufile);
void rdma_alloc_abort_uobject(struct ib_uobject *uobj);
int __must_check rdma_alloc_commit_uobject(struct ib_uobject *uobj);

struct uverbs_obj_fd_type {
	/*
	 * In fd based objects, uverbs_obj_type_ops points to generic
	 * fd operations. In order to specialize the underlying types (e.g.
	 * completion_channel), we use fops, name and flags for fd creation.
	 * context_closed is called when the context is closed either when
	 * the driver is removed or the process terminated.
	 */
	struct uverbs_obj_type  type;
	int (*context_closed)(struct ib_uobject *uobj,
			      enum rdma_remove_reason why);
	const struct file_operations	*fops;
	const char			*name;
	int				flags;
};

extern const struct uverbs_obj_type_class uverbs_idr_class;
extern const struct uverbs_obj_type_class uverbs_fd_class;

#define UVERBS_BUILD_BUG_ON(cond) (sizeof(char[1 - 2 * !!(cond)]) -	\
				   sizeof(char))
#define UVERBS_TYPE_ALLOC_FD(_obj_size, _context_closed, _fops, _name, _flags)\
	((&((const struct uverbs_obj_fd_type)				\
	 {.type = {							\
		.type_class = &uverbs_fd_class,				\
		.obj_size = (_obj_size) +				\
			UVERBS_BUILD_BUG_ON((_obj_size) <               \
					    sizeof(struct ib_uobject)), \
	 },								\
	 .context_closed = _context_closed,				\
	 .fops = _fops,							\
	 .name = _name,							\
	 .flags = _flags}))->type)
#define UVERBS_TYPE_ALLOC_IDR_SZ(_size, _destroy_object)	\
	((&((const struct uverbs_obj_idr_type)				\
	 {.type = {							\
		.type_class = &uverbs_idr_class,			\
		.obj_size = (_size) +					\
			UVERBS_BUILD_BUG_ON((_size) <			\
					    sizeof(struct ib_uobject))	\
	 },								\
	 .destroy_object = _destroy_object,}))->type)
#define UVERBS_TYPE_ALLOC_IDR(_destroy_object)			\
	 UVERBS_TYPE_ALLOC_IDR_SZ(sizeof(struct ib_uobject),	\
				  _destroy_object)

#endif
Commit	Line	Data
38321256 MB	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
	39	struct uverbs_obj_type;
6b0d08f4	40	struct uverbs_api_object;
38321256	41
9867f5c6 JG	42	enum rdma_lookup_mode {
	43	UVERBS_LOOKUP_READ,
	44	UVERBS_LOOKUP_WRITE,
7452a3c7 JG	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,
9867f5c6 JG	51	};
9867f5c6 JG	52
87ad80ab JG	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
0f50d88a	65	* remove_handle (optional)
87ad80ab JG	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	*/
38321256	84	struct uverbs_obj_type_class {
6b0d08f4	85	struct ib_uobject (alloc_begin)(const struct uverbs_api_object *obj,
6ef1c828	86	struct ib_uverbs_file *ufile);
87ad80ab	87	/* This consumes the kref on uobj */
aba94548	88	int (alloc_commit)(struct ib_uobject uobj);
87ad80ab	89	/* This does not consume the kref on uobj */
38321256 MB	90	void (alloc_abort)(struct ib_uobject uobj);
38321256 MB	91
6b0d08f4	92	struct ib_uobject (lookup_get)(const struct uverbs_api_object *obj,
1250c304	93	struct ib_uverbs_file *ufile, s64 id,
9867f5c6 JG	94	enum rdma_lookup_mode mode);
9867f5c6 JG	95	void (lookup_put)(struct ib_uobject uobj, enum rdma_lookup_mode mode);
87ad80ab	96	/* This does not consume the kref on uobj */
0f50d88a JG	97	int __must_check (destroy_hw)(struct ib_uobject uobj,
	98	enum rdma_remove_reason why);
	99	void (remove_handle)(struct ib_uobject uobj);
38321256 MB	100	u8 needs_kfree_rcu;
	101	};
	102
	103	struct uverbs_obj_type {
	104	const struct uverbs_obj_type_class * const type_class;
	105	size_t obj_size;
38321256 MB	106	};
	107
	108	/*
	109	* Objects type classes which support a detach state (object is still alive but
	110	* it's not attached to any context need to make sure:
	111	* (a) no call through to a driver after a detach is called
	112	* (b) detach isn't called concurrently with context_cleanup
	113	*/
	114
	115	struct uverbs_obj_idr_type {
	116	/*
	117	* In idr based objects, uverbs_obj_type_class points to a generic
	118	* idr operations. In order to specialize the underlying types (e.g. CQ,
	119	* QPs, etc.), we add destroy_object specific callbacks.
	120	*/
	121	struct uverbs_obj_type type;
	122
	123	/* Free driver resources from the uobject, make the driver uncallable,
	124	* and move the uobject to the detached state. If the object was
	125	* destroyed by the user's request, a failure should leave the uobject
	126	* completely unchanged.
	127	*/
	128	int __must_check (destroy_object)(struct ib_uobject uobj,
	129	enum rdma_remove_reason why);
	130	};
	131
6b0d08f4	132	struct ib_uobject rdma_lookup_get_uobject(const struct uverbs_api_object obj,
9867f5c6 JG	133	struct ib_uverbs_file *ufile, s64 id,
	134	enum rdma_lookup_mode mode);
	135	void rdma_lookup_put_uobject(struct ib_uobject *uobj,
	136	enum rdma_lookup_mode mode);
6b0d08f4	137	struct ib_uobject rdma_alloc_begin_uobject(const struct uverbs_api_object obj,
6ef1c828	138	struct ib_uverbs_file *ufile);
38321256	139	void rdma_alloc_abort_uobject(struct ib_uobject *uobj);
2c96eb7d	140	int __must_check rdma_alloc_commit_uobject(struct ib_uobject *uobj);
38321256	141
cf8966b3 MB	142	struct uverbs_obj_fd_type {
	143	/*
	144	* In fd based objects, uverbs_obj_type_ops points to generic
	145	* fd operations. In order to specialize the underlying types (e.g.
	146	* completion_channel), we use fops, name and flags for fd creation.
	147	* context_closed is called when the context is closed either when
	148	* the driver is removed or the process terminated.
	149	*/
	150	struct uverbs_obj_type type;
d0259e82	151	int (context_closed)(struct ib_uobject uobj,
cf8966b3 MB	152	enum rdma_remove_reason why);
	153	const struct file_operations *fops;
	154	const char *name;
	155	int flags;
	156	};
	157
6be60aed	158	extern const struct uverbs_obj_type_class uverbs_idr_class;
1e7710f3	159	extern const struct uverbs_obj_type_class uverbs_fd_class;
6be60aed MB	160
	161	#define UVERBS_BUILD_BUG_ON(cond) (sizeof(char[1 - 2 * !!(cond)]) - \
	162	sizeof(char))
1c77483e	163	#define UVERBS_TYPE_ALLOC_FD(_obj_size, _context_closed, _fops, _name, _flags)\
5009010f MB	164	((&((const struct uverbs_obj_fd_type) \
5009010f MB	165	{.type = { \
5009010f MB	166	.type_class = &uverbs_fd_class, \
5009010f MB	167	.obj_size = (_obj_size) + \
d0259e82 JG	168	UVERBS_BUILD_BUG_ON((_obj_size) < \
d0259e82 JG	169	sizeof(struct ib_uobject)), \
5009010f MB	170	}, \
	171	.context_closed = _context_closed, \
	172	.fops = _fops, \
	173	.name = _name, \
	174	.flags = _flags}))->type)
1c77483e	175	#define UVERBS_TYPE_ALLOC_IDR_SZ(_size, _destroy_object) \
5009010f MB	176	((&((const struct uverbs_obj_idr_type) \
5009010f MB	177	{.type = { \
6be60aed MB	178	.type_class = &uverbs_idr_class, \
6be60aed MB	179	.obj_size = (_size) + \
5009010f MB	180	UVERBS_BUILD_BUG_ON((_size) < \
	181	sizeof(struct ib_uobject)) \
	182	}, \
	183	.destroy_object = _destroy_object,}))->type)
1c77483e YH	184	#define UVERBS_TYPE_ALLOC_IDR(_destroy_object) \
1c77483e YH	185	UVERBS_TYPE_ALLOC_IDR_SZ(sizeof(struct ib_uobject), \
5009010f MB	186	_destroy_object)
5009010f MB	187
38321256	188	#endif