include/rdma/uverbs_named_ioctl.h

   1 /*
   2  * Copyright (c) 2018, 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_NAMED_IOCTL_
  34 #define _UVERBS_NAMED_IOCTL_
  35
  36 #include <rdma/uverbs_ioctl.h>
  37
  38 #ifndef UVERBS_MODULE_NAME
  39 #error "Please #define UVERBS_MODULE_NAME before including rdma/uverbs_named_ioctl.h"
  40 #endif
  41
  42 #define _UVERBS_PASTE(x, y)     x ## y
  43 #define _UVERBS_NAME(x, y)      _UVERBS_PASTE(x, y)
  44 #define UVERBS_METHOD(id)       _UVERBS_NAME(UVERBS_MODULE_NAME, _method_##id)
  45 #define UVERBS_HANDLER(id)      _UVERBS_NAME(UVERBS_MODULE_NAME, _handler_##id)
  46 #define UVERBS_OBJECT(id)       _UVERBS_NAME(UVERBS_MOUDLE_NAME, _object_##id)
  47
  48 #define UVERBS_METHOD_ATTRS(id)                                                \
  49         _UVERBS_NAME(UVERBS_MODULE_NAME, _method_attrs_##id)
  50
  51 #define DECLARE_UVERBS_NAMED_METHOD(_method_id, ...)                           \
  52         static const struct uverbs_attr_def *const UVERBS_METHOD_ATTRS(        \
  53                 _method_id)[] = { __VA_ARGS__ };                               \
  54         static const struct uverbs_method_def UVERBS_METHOD(_method_id) = {    \
  55                 .id = _method_id,                                              \
  56                 .handler = UVERBS_HANDLER(_method_id),                         \
  57                 .num_attrs = ARRAY_SIZE(UVERBS_METHOD_ATTRS(_method_id)),      \
  58                 .attrs = &UVERBS_METHOD_ATTRS(_method_id),                     \
  59         }
  60
  61 /* Create a standard destroy method using the default handler. The handle_attr
  62  * argument must be the attribute specifying the handle to destroy, the
  63  * default handler does not support any other attributes.
  64  */
  65 #define DECLARE_UVERBS_NAMED_METHOD_DESTROY(_method_id, _handle_attr)          \
  66         static const struct uverbs_attr_def *const UVERBS_METHOD_ATTRS(        \
  67                 _method_id)[] = { _handle_attr };                              \
  68         static const struct uverbs_method_def UVERBS_METHOD(_method_id) = {    \
  69                 .id = _method_id,                                              \
  70                 .handler = uverbs_destroy_def_handler,                         \
  71                 .num_attrs = ARRAY_SIZE(UVERBS_METHOD_ATTRS(_method_id)),      \
  72                 .attrs = &UVERBS_METHOD_ATTRS(_method_id),                     \
  73         }
  74
  75 #define DECLARE_UVERBS_NAMED_OBJECT(id, ...)    \
  76         DECLARE_UVERBS_OBJECT(UVERBS_OBJECT(id), id, ##__VA_ARGS__)
  77
  78 #define DECLARE_UVERBS_GLOBAL_METHODS(_name, ...)       \
  79         DECLARE_UVERBS_NAMED_OBJECT(_name, NULL, ##__VA_ARGS__)
  80
  81 #define _UVERBS_COMP_NAME(x, y, z) _UVERBS_NAME(_UVERBS_NAME(x, y), z)
  82
  83 /* Used by drivers to declare a complete parsing tree for a single method that
  84  * differs only in having additional driver specific attributes.
  85  */
  86 #define ADD_UVERBS_ATTRIBUTES_SIMPLE(_name, _object_id, _method_id, ...)       \
  87         static const struct uverbs_attr_def *const UVERBS_METHOD_ATTRS(        \
  88                 _method_id)[] = { __VA_ARGS__ };                               \
  89         static const struct uverbs_method_def UVERBS_METHOD(_method_id) = {    \
  90                 .id = _method_id,                                              \
  91                 .num_attrs = ARRAY_SIZE(UVERBS_METHOD_ATTRS(_method_id)),      \
  92                 .attrs = &UVERBS_METHOD_ATTRS(_method_id),                     \
  93         };                                                                     \
  94         static DECLARE_UVERBS_OBJECT(                                          \
  95                 _UVERBS_COMP_NAME(UVERBS_MODULE_NAME, _object_id, _name),      \
  96                 _object_id, NULL, &UVERBS_METHOD(_method_id));                 \
  97         static DECLARE_UVERBS_OBJECT_TREE(                                     \
  98                 _name,                                                         \
  99                 &_UVERBS_COMP_NAME(UVERBS_MODULE_NAME, _object_id, _name))
 100
 101 #endif