Commit 118620d3 authored by Matan Barak's avatar Matan Barak Committed by Doug Ledford
Browse files

IB/core: Add uverbs merge trees functionality 



Different drivers support different features and even subset of the
common uverbs implementation. Currently, this is handled as bitmask
in every driver that represents which kind of methods it supports, but
doesn't go down to attributes granularity. Moreover, drivers might
want to add their specific types, methods and attributes to let
their user-space counter-parts be exposed to some more efficient
abstractions. It means that existence of different features is
validated syntactically via the parsing infrastructure rather than
using a complex in-handler logic.

In order to do that, we allow defining features and abstractions
as parsing trees. These per-feature parsing tree could be merged
to an efficient (perfect-hash based) parsing tree, which is later
used by the parsing infrastructure.

To sum it up, this makes a parse tree unique for a device and
represents only the features this particular device supports.
This is done by having a root specification tree per feature.
Before a device registers itself as an IB device, it merges
all these trees into one parsing tree. This parsing tree
is used to parse all user-space commands.

A future user-space application could read this parse tree. This
tree represents which objects, methods and attributes are
supported by this device.

This is based on the idea of
Jason Gunthorpe <jgunthorpe@obsidianresearch.com>

Signed-off-by: default avatarMatan Barak <matanb@mellanox.com>
Reviewed-by: default avatarYishai Hadas <yishaih@mellanox.com>
Signed-off-by: default avatarDoug Ledford <dledford@redhat.com>
parent 09e3ebf8

drivers/infiniband/core/Makefile

+2 −1
Original line number Diff line number Diff line
@@ -32,4 +32,5 @@ ib_umad-y := user_mad.o 
ib_ucm-y :=			ucm.o



ib_uverbs-y :=			uverbs_main.o uverbs_cmd.o uverbs_marshall.o \

				rdma_core.o uverbs_std_types.o uverbs_ioctl.o
 
				rdma_core.o uverbs_std_types.o uverbs_ioctl.o \

				uverbs_ioctl_merge.o

drivers/infiniband/core/uverbs_ioctl_merge.c

0 → 100644
+665 −0

File added.

Preview size limit exceeded, changes collapsed.

include/rdma/uverbs_ioctl.h

+39 −1
Original line number Diff line number Diff line
@@ -235,5 +235,43 @@ static inline bool uverbs_attr_is_valid_in_hash(const struct uverbs_attr_bundle_ 
	return test_bit(idx, attrs_hash->valid_bitmap);

}



#endif

/* =================================================

 *	 Definitions -> Specs infrastructure

 * =================================================

 */



/*

 * uverbs_alloc_spec_tree - Merges different common and driver specific feature

 *	into one parsing tree that every uverbs command will be parsed upon.

 *

 * @num_trees: Number of trees in the array @trees.

 * @trees: Array of pointers to tree root definitions to merge. Each such tree

 *	   possibly contains objects, methods and attributes definitions.

 *

 * Returns:

 *	uverbs_root_spec *: The root of the merged parsing tree.

 *	On error, we return an error code. Error is checked via IS_ERR.

 *

 * The following merges could take place:

 * a. Two trees representing the same method with different handler

 *	-> We take the handler of the tree that its handler != NULL

 *	   and its index in the trees array is greater. The incentive for that

 *	   is that developers are expected to first merge common trees and then

 *	   merge trees that gives specialized the behaviour.

 * b. Two trees representing the same object with different

 *    type_attrs (struct uverbs_obj_type):

 *	-> We take the type_attrs of the tree that its type_attr != NULL

 *	   and its index in the trees array is greater. This could be used

 *	   in order to override the free function, allocation size, etc.

 * c. Two trees representing the same method attribute (same id but possibly

 *    different attributes):

 *	-> ERROR (-ENOENT), we believe that's not the programmer's intent.

 *

 * An object without any methods is considered invalid and will abort the

 * function with -ENOENT error.

 */

struct uverbs_root_spec *uverbs_alloc_spec_tree(unsigned int num_trees,

						const struct uverbs_object_tree_def **trees);

void uverbs_free_spec_tree(struct uverbs_root_spec *root);



#endif

CRA Git | Maintained and supported by SUSTech CRA and CCSE