[mirror_ubuntu-bionic-kernel.git] / include / rdma / uverbs_ioctl.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_IOCTL_
#define _UVERBS_IOCTL_

#include <rdma/uverbs_types.h>

/*
 * =======================================
 *	Verbs action specifications
 * =======================================
 */

enum uverbs_attr_type {
	UVERBS_ATTR_TYPE_NA,
	UVERBS_ATTR_TYPE_IDR,
	UVERBS_ATTR_TYPE_FD,
};

enum uverbs_obj_access {
	UVERBS_ACCESS_READ,
	UVERBS_ACCESS_WRITE,
	UVERBS_ACCESS_NEW,
	UVERBS_ACCESS_DESTROY
};

struct uverbs_attr_spec {
	enum uverbs_attr_type		type;
	struct {
		/*
		 * higher bits mean the namespace and lower bits mean
		 * the type id within the namespace.
		 */
		u16			obj_type;
		u8			access;
	} obj;
};

struct uverbs_attr_spec_hash {
	size_t				num_attrs;
	struct uverbs_attr_spec		attrs[0];
};

struct uverbs_obj_attr {
	struct ib_uobject		*uobject;
};

struct uverbs_attr {
	struct uverbs_obj_attr	obj_attr;
};

struct uverbs_attr_bundle_hash {
	/* if bit i is set, it means attrs[i] contains valid information */
	unsigned long *valid_bitmap;
	size_t num_attrs;
	/*
	 * arrays of attributes, each element corresponds to the specification
	 * of the attribute in the same index.
	 */
	struct uverbs_attr *attrs;
};

struct uverbs_attr_bundle {
	size_t				num_buckets;
	struct uverbs_attr_bundle_hash  hash[];
};

static inline bool uverbs_attr_is_valid_in_hash(const struct uverbs_attr_bundle_hash *attrs_hash,
						unsigned int idx)
{
	return test_bit(idx, attrs_hash->valid_bitmap);
}

#endif
Commit	Line	Data
a0aa309c 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_IOCTL_
	34	#define _UVERBS_IOCTL_
	35
	36	#include <rdma/uverbs_types.h>
	37
	38	/*
	39	* =======================================
	40	* Verbs action specifications
	41	* =======================================
	42	*/
	43
f43dbebf MB	44	enum uverbs_attr_type {
	45	UVERBS_ATTR_TYPE_NA,
	46	UVERBS_ATTR_TYPE_IDR,
	47	UVERBS_ATTR_TYPE_FD,
	48	};
	49
a0aa309c MB	50	enum uverbs_obj_access {
	51	UVERBS_ACCESS_READ,
	52	UVERBS_ACCESS_WRITE,
	53	UVERBS_ACCESS_NEW,
	54	UVERBS_ACCESS_DESTROY
	55	};
	56
f43dbebf MB	57	struct uverbs_attr_spec {
	58	enum uverbs_attr_type type;
	59	struct {
	60	/*
	61	* higher bits mean the namespace and lower bits mean
	62	* the type id within the namespace.
	63	*/
	64	u16 obj_type;
	65	u8 access;
	66	} obj;
	67	};
	68
	69	struct uverbs_attr_spec_hash {
	70	size_t num_attrs;
	71	struct uverbs_attr_spec attrs[0];
	72	};
	73
	74	struct uverbs_obj_attr {
	75	struct ib_uobject *uobject;
	76	};
	77
	78	struct uverbs_attr {
	79	struct uverbs_obj_attr obj_attr;
	80	};
	81
	82	struct uverbs_attr_bundle_hash {
	83	/* if bit i is set, it means attrs[i] contains valid information */
	84	unsigned long *valid_bitmap;
	85	size_t num_attrs;
	86	/*
	87	* arrays of attributes, each element corresponds to the specification
	88	* of the attribute in the same index.
	89	*/
	90	struct uverbs_attr *attrs;
	91	};
	92
	93	struct uverbs_attr_bundle {
	94	size_t num_buckets;
	95	struct uverbs_attr_bundle_hash hash[];
	96	};
	97
	98	static inline bool uverbs_attr_is_valid_in_hash(const struct uverbs_attr_bundle_hash *attrs_hash,
	99	unsigned int idx)
	100	{
	101	return test_bit(idx, attrs_hash->valid_bitmap);
	102	}
	103
a0aa309c MB	104	#endif
a0aa309c MB	105