include/rdma/uverbs_ioctl.h

   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 #include <linux/uaccess.h>
  38 #include <rdma/rdma_user_ioctl.h>
  39 #include <rdma/ib_user_ioctl_verbs.h>
  40 #include <rdma/ib_user_ioctl_cmds.h>
  41
  42 /*
  43  * =======================================
  44  *      Verbs action specifications
  45  * =======================================
  46  */
  47
  48 enum uverbs_attr_type {
  49         UVERBS_ATTR_TYPE_NA,
  50         UVERBS_ATTR_TYPE_PTR_IN,
  51         UVERBS_ATTR_TYPE_PTR_OUT,
  52         UVERBS_ATTR_TYPE_IDR,
  53         UVERBS_ATTR_TYPE_FD,
  54         UVERBS_ATTR_TYPE_ENUM_IN,
  55         UVERBS_ATTR_TYPE_IDRS_ARRAY,
  56 };
  57
  58 enum uverbs_obj_access {
  59         UVERBS_ACCESS_READ,
  60         UVERBS_ACCESS_WRITE,
  61         UVERBS_ACCESS_NEW,
  62         UVERBS_ACCESS_DESTROY
  63 };
  64
  65 /* Specification of a single attribute inside the ioctl message */
  66 /* good size 16 */
  67 struct uverbs_attr_spec {
  68         u8 type;
  69
  70         /*
  71          * Support extending attributes by length. Allow the user to provide
  72          * more bytes than ptr.len, but check that everything after is zero'd
  73          * by the user.
  74          */
  75         u8 zero_trailing:1;
  76         /*
  77          * Valid only for PTR_IN. Allocate and copy the data inside
  78          * the parser
  79          */
  80         u8 alloc_and_copy:1;
  81         u8 mandatory:1;
  82
  83         union {
  84                 struct {
  85                         /* Current known size to kernel */
  86                         u16 len;
  87                         /* User isn't allowed to provide something < min_len */
  88                         u16 min_len;
  89                 } ptr;
  90
  91                 struct {
  92                         /*
  93                          * higher bits mean the namespace and lower bits mean
  94                          * the type id within the namespace.
  95                          */
  96                         u16 obj_type;
  97                         u8 access;
  98                 } obj;
  99
 100                 struct {
 101                         u8 num_elems;
 102                 } enum_def;
 103         } u;
 104
 105         /* This weird split lets us remove some padding */
 106         union {
 107                 struct {
 108                         /*
 109                          * The enum attribute can select one of the attributes
 110                          * contained in the ids array. Currently only PTR_IN
 111                          * attributes are supported in the ids array.
 112                          */
 113                         const struct uverbs_attr_spec *ids;
 114                 } enum_def;
 115
 116                 struct {
 117                         /*
 118                          * higher bits mean the namespace and lower bits mean
 119                          * the type id within the namespace.
 120                          */
 121                         u16                             obj_type;
 122                         u16                             min_len;
 123                         u16                             max_len;
 124                         u8                              access;
 125                 } objs_arr;
 126         } u2;
 127 };
 128
 129 /*
 130  * Information about the API is loaded into a radix tree. For IOCTL we start
 131  * with a tuple of:
 132  *  object_id, attr_id, method_id
 133  *
 134  * Which is a 48 bit value, with most of the bits guaranteed to be zero. Based
 135  * on the current kernel support this is compressed into 16 bit key for the
 136  * radix tree. Since this compression is entirely internal to the kernel the
 137  * below limits can be revised if the kernel gains additional data.
 138  *
 139  * With 64 leafs per node this is a 3 level radix tree.
 140  *
 141  * The tree encodes multiple types, and uses a scheme where OBJ_ID,0,0 returns
 142  * the object slot, and OBJ_ID,METH_ID,0 and returns the method slot.
 143  */
 144 enum uapi_radix_data {
 145         UVERBS_API_NS_FLAG = 1U << UVERBS_ID_NS_SHIFT,
 146
 147         UVERBS_API_ATTR_KEY_BITS = 6,
 148         UVERBS_API_ATTR_KEY_MASK = GENMASK(UVERBS_API_ATTR_KEY_BITS - 1, 0),
 149         UVERBS_API_ATTR_BKEY_LEN = (1 << UVERBS_API_ATTR_KEY_BITS) - 1,
 150
 151         UVERBS_API_METHOD_KEY_BITS = 5,
 152         UVERBS_API_METHOD_KEY_SHIFT = UVERBS_API_ATTR_KEY_BITS,
 153         UVERBS_API_METHOD_KEY_NUM_CORE = 24,
 154         UVERBS_API_METHOD_KEY_NUM_DRIVER = (1 << UVERBS_API_METHOD_KEY_BITS) -
 155                                            UVERBS_API_METHOD_KEY_NUM_CORE,
 156         UVERBS_API_METHOD_KEY_MASK = GENMASK(
 157                 UVERBS_API_METHOD_KEY_BITS + UVERBS_API_METHOD_KEY_SHIFT - 1,
 158                 UVERBS_API_METHOD_KEY_SHIFT),
 159
 160         UVERBS_API_OBJ_KEY_BITS = 5,
 161         UVERBS_API_OBJ_KEY_SHIFT =
 162                 UVERBS_API_METHOD_KEY_BITS + UVERBS_API_METHOD_KEY_SHIFT,
 163         UVERBS_API_OBJ_KEY_NUM_CORE = 24,
 164         UVERBS_API_OBJ_KEY_NUM_DRIVER =
 165                 (1 << UVERBS_API_OBJ_KEY_BITS) - UVERBS_API_OBJ_KEY_NUM_CORE,
 166         UVERBS_API_OBJ_KEY_MASK = GENMASK(31, UVERBS_API_OBJ_KEY_SHIFT),
 167
 168         /* This id guaranteed to not exist in the radix tree */
 169         UVERBS_API_KEY_ERR = 0xFFFFFFFF,
 170 };
 171
 172 static inline __attribute_const__ u32 uapi_key_obj(u32 id)
 173 {
 174         if (id & UVERBS_API_NS_FLAG) {
 175                 id &= ~UVERBS_API_NS_FLAG;
 176                 if (id >= UVERBS_API_OBJ_KEY_NUM_DRIVER)
 177                         return UVERBS_API_KEY_ERR;
 178                 id = id + UVERBS_API_OBJ_KEY_NUM_CORE;
 179         } else {
 180                 if (id >= UVERBS_API_OBJ_KEY_NUM_CORE)
 181                         return UVERBS_API_KEY_ERR;
 182         }
 183
 184         return id << UVERBS_API_OBJ_KEY_SHIFT;
 185 }
 186
 187 static inline __attribute_const__ bool uapi_key_is_object(u32 key)
 188 {
 189         return (key & ~UVERBS_API_OBJ_KEY_MASK) == 0;
 190 }
 191
 192 static inline __attribute_const__ u32 uapi_key_ioctl_method(u32 id)
 193 {
 194         if (id & UVERBS_API_NS_FLAG) {
 195                 id &= ~UVERBS_API_NS_FLAG;
 196                 if (id >= UVERBS_API_METHOD_KEY_NUM_DRIVER)
 197                         return UVERBS_API_KEY_ERR;
 198                 id = id + UVERBS_API_METHOD_KEY_NUM_CORE;
 199         } else {
 200                 id++;
 201                 if (id >= UVERBS_API_METHOD_KEY_NUM_CORE)
 202                         return UVERBS_API_KEY_ERR;
 203         }
 204
 205         return id << UVERBS_API_METHOD_KEY_SHIFT;
 206 }
 207
 208 static inline __attribute_const__ u32 uapi_key_attr_to_method(u32 attr_key)
 209 {
 210         return attr_key &
 211                (UVERBS_API_OBJ_KEY_MASK | UVERBS_API_METHOD_KEY_MASK);
 212 }
 213
 214 static inline __attribute_const__ bool uapi_key_is_ioctl_method(u32 key)
 215 {
 216         return (key & UVERBS_API_METHOD_KEY_MASK) != 0 &&
 217                (key & UVERBS_API_ATTR_KEY_MASK) == 0;
 218 }
 219
 220 static inline __attribute_const__ u32 uapi_key_attrs_start(u32 ioctl_method_key)
 221 {
 222         /* 0 is the method slot itself */
 223         return ioctl_method_key + 1;
 224 }
 225
 226 static inline __attribute_const__ u32 uapi_key_attr(u32 id)
 227 {
 228         /*
 229          * The attr is designed to fit in the typical single radix tree node
 230          * of 64 entries. Since allmost all methods have driver attributes we
 231          * organize things so that the driver and core attributes interleave to
 232          * reduce the length of the attributes array in typical cases.
 233          */
 234         if (id & UVERBS_API_NS_FLAG) {
 235                 id &= ~UVERBS_API_NS_FLAG;
 236                 id++;
 237                 if (id >= 1 << (UVERBS_API_ATTR_KEY_BITS - 1))
 238                         return UVERBS_API_KEY_ERR;
 239                 id = (id << 1) | 0;
 240         } else {
 241                 if (id >= 1 << (UVERBS_API_ATTR_KEY_BITS - 1))
 242                         return UVERBS_API_KEY_ERR;
 243                 id = (id << 1) | 1;
 244         }
 245
 246         return id;
 247 }
 248
 249 static inline __attribute_const__ bool uapi_key_is_attr(u32 key)
 250 {
 251         return (key & UVERBS_API_METHOD_KEY_MASK) != 0 &&
 252                (key & UVERBS_API_ATTR_KEY_MASK) != 0;
 253 }
 254
 255 /*
 256  * This returns a value in the range [0 to UVERBS_API_ATTR_BKEY_LEN),
 257  * basically it undoes the reservation of 0 in the ID numbering. attr_key
 258  * must already be masked with UVERBS_API_ATTR_KEY_MASK, or be the output of
 259  * uapi_key_attr().
 260  */
 261 static inline __attribute_const__ u32 uapi_bkey_attr(u32 attr_key)
 262 {
 263         return attr_key - 1;
 264 }
 265
 266 static inline __attribute_const__ u32 uapi_bkey_to_key_attr(u32 attr_bkey)
 267 {
 268         return attr_bkey + 1;
 269 }
 270
 271 /*
 272  * =======================================
 273  *      Verbs definitions
 274  * =======================================
 275  */
 276
 277 struct uverbs_attr_def {
 278         u16                           id;
 279         struct uverbs_attr_spec       attr;
 280 };
 281
 282 struct uverbs_method_def {
 283         u16                                  id;
 284         /* Combination of bits from enum UVERBS_ACTION_FLAG_XXXX */
 285         u32                                  flags;
 286         size_t                               num_attrs;
 287         const struct uverbs_attr_def * const (*attrs)[];
 288         int (*handler)(struct ib_uverbs_file *ufile,
 289                        struct uverbs_attr_bundle *ctx);
 290 };
 291
 292 struct uverbs_object_def {
 293         u16                                      id;
 294         const struct uverbs_obj_type            *type_attrs;
 295         size_t                                   num_methods;
 296         const struct uverbs_method_def * const (*methods)[];
 297 };
 298
 299 enum uapi_definition_kind {
 300         UAPI_DEF_END = 0,
 301         UAPI_DEF_CHAIN_OBJ_TREE,
 302         UAPI_DEF_CHAIN,
 303 };
 304
 305 struct uapi_definition {
 306         u8 kind;
 307         union {
 308                 struct {
 309                         u16 object_id;
 310                 } object_start;
 311         };
 312
 313         union {
 314                 const struct uapi_definition *chain;
 315                 const struct uverbs_object_def *chain_obj_tree;
 316         };
 317 };
 318
 319 /* Include another struct uapi_definition in this one */
 320 #define UAPI_DEF_CHAIN(_def_var)                                               \
 321         {                                                                      \
 322                 .kind = UAPI_DEF_CHAIN, .chain = _def_var,                     \
 323         }
 324
 325 /* Temporary until the tree base description is replaced */
 326 #define UAPI_DEF_CHAIN_OBJ_TREE(_object_enum, _object_ptr)                     \
 327         {                                                                      \
 328                 .kind = UAPI_DEF_CHAIN_OBJ_TREE,                               \
 329                 .object_start = { .object_id = _object_enum },                 \
 330                 .chain_obj_tree = _object_ptr,                                 \
 331         }
 332 #define UAPI_DEF_CHAIN_OBJ_TREE_NAMED(_object_enum, ...)                       \
 333         UAPI_DEF_CHAIN_OBJ_TREE(_object_enum, &UVERBS_OBJECT(_object_enum)),   \
 334                 ##__VA_ARGS__
 335
 336 /*
 337  * =======================================
 338  *      Attribute Specifications
 339  * =======================================
 340  */
 341
 342 #define UVERBS_ATTR_SIZE(_min_len, _len)                        \
 343         .u.ptr.min_len = _min_len, .u.ptr.len = _len
 344
 345 #define UVERBS_ATTR_NO_DATA() UVERBS_ATTR_SIZE(0, 0)
 346
 347 /*
 348  * Specifies a uapi structure that cannot be extended. The user must always
 349  * supply the whole structure and nothing more. The structure must be declared
 350  * in a header under include/uapi/rdma.
 351  */
 352 #define UVERBS_ATTR_TYPE(_type)                                 \
 353         .u.ptr.min_len = sizeof(_type), .u.ptr.len = sizeof(_type)
 354 /*
 355  * Specifies a uapi structure where the user must provide at least up to
 356  * member 'last'.  Anything after last and up until the end of the structure
 357  * can be non-zero, anything longer than the end of the structure must be
 358  * zero. The structure must be declared in a header under include/uapi/rdma.
 359  */
 360 #define UVERBS_ATTR_STRUCT(_type, _last)                                       \
 361         .zero_trailing = 1,                                                    \
 362         UVERBS_ATTR_SIZE(((uintptr_t)(&((_type *)0)->_last + 1)),              \
 363                          sizeof(_type))
 364 /*
 365  * Specifies at least min_len bytes must be passed in, but the amount can be
 366  * larger, up to the protocol maximum size. No check for zeroing is done.
 367  */
 368 #define UVERBS_ATTR_MIN_SIZE(_min_len) UVERBS_ATTR_SIZE(_min_len, USHRT_MAX)
 369
 370 /* Must be used in the '...' of any UVERBS_ATTR */
 371 #define UA_ALLOC_AND_COPY .alloc_and_copy = 1
 372 #define UA_MANDATORY .mandatory = 1
 373 #define UA_OPTIONAL .mandatory = 0
 374
 375 /*
 376  * min_len must be bigger than 0 and _max_len must be smaller than 4095.  Only
 377  * READ\WRITE accesses are supported.
 378  */
 379 #define UVERBS_ATTR_IDRS_ARR(_attr_id, _idr_type, _access, _min_len, _max_len, \
 380                              ...)                                              \
 381         (&(const struct uverbs_attr_def){                                      \
 382                 .id = (_attr_id) +                                             \
 383                       BUILD_BUG_ON_ZERO((_min_len) == 0 ||                     \
 384                                         (_max_len) >                           \
 385                                                 PAGE_SIZE / sizeof(void *) ||  \
 386                                         (_min_len) > (_max_len) ||             \
 387                                         (_access) == UVERBS_ACCESS_NEW ||      \
 388                                         (_access) == UVERBS_ACCESS_DESTROY),   \
 389                 .attr = { .type = UVERBS_ATTR_TYPE_IDRS_ARRAY,                 \
 390                           .u2.objs_arr.obj_type = _idr_type,                   \
 391                           .u2.objs_arr.access = _access,                       \
 392                           .u2.objs_arr.min_len = _min_len,                     \
 393                           .u2.objs_arr.max_len = _max_len,                     \
 394                           __VA_ARGS__ } })
 395
 396 #define UVERBS_ATTR_IDR(_attr_id, _idr_type, _access, ...)                     \
 397         (&(const struct uverbs_attr_def){                                      \
 398                 .id = _attr_id,                                                \
 399                 .attr = { .type = UVERBS_ATTR_TYPE_IDR,                        \
 400                           .u.obj.obj_type = _idr_type,                         \
 401                           .u.obj.access = _access,                             \
 402                           __VA_ARGS__ } })
 403
 404 #define UVERBS_ATTR_FD(_attr_id, _fd_type, _access, ...)                       \
 405         (&(const struct uverbs_attr_def){                                      \
 406                 .id = (_attr_id) +                                             \
 407                       BUILD_BUG_ON_ZERO((_access) != UVERBS_ACCESS_NEW &&      \
 408                                         (_access) != UVERBS_ACCESS_READ),      \
 409                 .attr = { .type = UVERBS_ATTR_TYPE_FD,                         \
 410                           .u.obj.obj_type = _fd_type,                          \
 411                           .u.obj.access = _access,                             \
 412                           __VA_ARGS__ } })
 413
 414 #define UVERBS_ATTR_PTR_IN(_attr_id, _type, ...)                               \
 415         (&(const struct uverbs_attr_def){                                      \
 416                 .id = _attr_id,                                                \
 417                 .attr = { .type = UVERBS_ATTR_TYPE_PTR_IN,                     \
 418                           _type,                                               \
 419                           __VA_ARGS__ } })
 420
 421 #define UVERBS_ATTR_PTR_OUT(_attr_id, _type, ...)                              \
 422         (&(const struct uverbs_attr_def){                                      \
 423                 .id = _attr_id,                                                \
 424                 .attr = { .type = UVERBS_ATTR_TYPE_PTR_OUT,                    \
 425                           _type,                                               \
 426                           __VA_ARGS__ } })
 427
 428 /* _enum_arry should be a 'static const union uverbs_attr_spec[]' */
 429 #define UVERBS_ATTR_ENUM_IN(_attr_id, _enum_arr, ...)                          \
 430         (&(const struct uverbs_attr_def){                                      \
 431                 .id = _attr_id,                                                \
 432                 .attr = { .type = UVERBS_ATTR_TYPE_ENUM_IN,                    \
 433                           .u2.enum_def.ids = _enum_arr,                        \
 434                           .u.enum_def.num_elems = ARRAY_SIZE(_enum_arr),       \
 435                           __VA_ARGS__ },                                       \
 436         })
 437
 438 /* An input value that is a member in the enum _enum_type. */
 439 #define UVERBS_ATTR_CONST_IN(_attr_id, _enum_type, ...)                        \
 440         UVERBS_ATTR_PTR_IN(                                                    \
 441                 _attr_id,                                                      \
 442                 UVERBS_ATTR_SIZE(                                              \
 443                         sizeof(u64) + BUILD_BUG_ON_ZERO(!sizeof(_enum_type)),  \
 444                         sizeof(u64)),                                          \
 445                 __VA_ARGS__)
 446
 447 /*
 448  * An input value that is a bitwise combination of values of _enum_type.
 449  * This permits the flag value to be passed as either a u32 or u64, it must
 450  * be retrieved via uverbs_get_flag().
 451  */
 452 #define UVERBS_ATTR_FLAGS_IN(_attr_id, _enum_type, ...)                        \
 453         UVERBS_ATTR_PTR_IN(                                                    \
 454                 _attr_id,                                                      \
 455                 UVERBS_ATTR_SIZE(sizeof(u32) + BUILD_BUG_ON_ZERO(              \
 456                                                        !sizeof(_enum_type *)), \
 457                                  sizeof(u64)),                                 \
 458                 __VA_ARGS__)
 459
 460 /*
 461  * This spec is used in order to pass information to the hardware driver in a
 462  * legacy way. Every verb that could get driver specific data should get this
 463  * spec.
 464  */
 465 #define UVERBS_ATTR_UHW()                                                      \
 466         UVERBS_ATTR_PTR_IN(UVERBS_ATTR_UHW_IN,                                 \
 467                            UVERBS_ATTR_MIN_SIZE(0),                            \
 468                            UA_OPTIONAL),                                       \
 469         UVERBS_ATTR_PTR_OUT(UVERBS_ATTR_UHW_OUT,                               \
 470                             UVERBS_ATTR_MIN_SIZE(0),                           \
 471                             UA_OPTIONAL)
 472
 473 /* =================================================
 474  *              Parsing infrastructure
 475  * =================================================
 476  */
 477
 478
 479 struct uverbs_ptr_attr {
 480         /*
 481          * If UVERBS_ATTR_SPEC_F_ALLOC_AND_COPY is set then the 'ptr' is
 482          * used.
 483          */
 484         union {
 485                 void *ptr;
 486                 u64 data;
 487         };
 488         u16             len;
 489         u16             uattr_idx;
 490         u8              enum_id;
 491 };
 492
 493 struct uverbs_obj_attr {
 494         struct ib_uobject               *uobject;
 495         const struct uverbs_api_attr    *attr_elm;
 496 };
 497
 498 struct uverbs_objs_arr_attr {
 499         struct ib_uobject **uobjects;
 500         u16 len;
 501 };
 502
 503 struct uverbs_attr {
 504         union {
 505                 struct uverbs_ptr_attr  ptr_attr;
 506                 struct uverbs_obj_attr  obj_attr;
 507                 struct uverbs_objs_arr_attr objs_arr_attr;
 508         };
 509 };
 510
 511 struct uverbs_attr_bundle {
 512         struct ib_uverbs_file *ufile;
 513         DECLARE_BITMAP(attr_present, UVERBS_API_ATTR_BKEY_LEN);
 514         struct uverbs_attr attrs[];
 515 };
 516
 517 static inline bool uverbs_attr_is_valid(const struct uverbs_attr_bundle *attrs_bundle,
 518                                         unsigned int idx)
 519 {
 520         return test_bit(uapi_bkey_attr(uapi_key_attr(idx)),
 521                         attrs_bundle->attr_present);
 522 }
 523
 524 #define IS_UVERBS_COPY_ERR(_ret)                ((_ret) && (_ret) != -ENOENT)
 525
 526 static inline const struct uverbs_attr *uverbs_attr_get(const struct uverbs_attr_bundle *attrs_bundle,
 527                                                         u16 idx)
 528 {
 529         if (!uverbs_attr_is_valid(attrs_bundle, idx))
 530                 return ERR_PTR(-ENOENT);
 531
 532         return &attrs_bundle->attrs[uapi_bkey_attr(uapi_key_attr(idx))];
 533 }
 534
 535 static inline int uverbs_attr_get_enum_id(const struct uverbs_attr_bundle *attrs_bundle,
 536                                           u16 idx)
 537 {
 538         const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
 539
 540         if (IS_ERR(attr))
 541                 return PTR_ERR(attr);
 542
 543         return attr->ptr_attr.enum_id;
 544 }
 545
 546 static inline void *uverbs_attr_get_obj(const struct uverbs_attr_bundle *attrs_bundle,
 547                                         u16 idx)
 548 {
 549         const struct uverbs_attr *attr;
 550
 551         attr = uverbs_attr_get(attrs_bundle, idx);
 552         if (IS_ERR(attr))
 553                 return ERR_CAST(attr);
 554
 555         return attr->obj_attr.uobject->object;
 556 }
 557
 558 static inline struct ib_uobject *uverbs_attr_get_uobject(const struct uverbs_attr_bundle *attrs_bundle,
 559                                                          u16 idx)
 560 {
 561         const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
 562
 563         if (IS_ERR(attr))
 564                 return ERR_CAST(attr);
 565
 566         return attr->obj_attr.uobject;
 567 }
 568
 569 static inline int
 570 uverbs_attr_get_len(const struct uverbs_attr_bundle *attrs_bundle, u16 idx)
 571 {
 572         const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
 573
 574         if (IS_ERR(attr))
 575                 return PTR_ERR(attr);
 576
 577         return attr->ptr_attr.len;
 578 }
 579
 580 /**
 581  * uverbs_attr_get_uobjs_arr() - Provides array's properties for attribute for
 582  * UVERBS_ATTR_TYPE_IDRS_ARRAY.
 583  * @arr: Returned pointer to array of pointers for uobjects or NULL if
 584  *       the attribute isn't provided.
 585  *
 586  * Return: The array length or 0 if no attribute was provided.
 587  */
 588 static inline int uverbs_attr_get_uobjs_arr(
 589         const struct uverbs_attr_bundle *attrs_bundle, u16 attr_idx,
 590         struct ib_uobject ***arr)
 591 {
 592         const struct uverbs_attr *attr =
 593                         uverbs_attr_get(attrs_bundle, attr_idx);
 594
 595         if (IS_ERR(attr)) {
 596                 *arr = NULL;
 597                 return 0;
 598         }
 599
 600         *arr = attr->objs_arr_attr.uobjects;
 601
 602         return attr->objs_arr_attr.len;
 603 }
 604
 605 static inline bool uverbs_attr_ptr_is_inline(const struct uverbs_attr *attr)
 606 {
 607         return attr->ptr_attr.len <= sizeof(attr->ptr_attr.data);
 608 }
 609
 610 static inline void *uverbs_attr_get_alloced_ptr(
 611         const struct uverbs_attr_bundle *attrs_bundle, u16 idx)
 612 {
 613         const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
 614
 615         if (IS_ERR(attr))
 616                 return (void *)attr;
 617
 618         return uverbs_attr_ptr_is_inline(attr) ? (void *)&attr->ptr_attr.data :
 619                                                  attr->ptr_attr.ptr;
 620 }
 621
 622 static inline int _uverbs_copy_from(void *to,
 623                                     const struct uverbs_attr_bundle *attrs_bundle,
 624                                     size_t idx,
 625                                     size_t size)
 626 {
 627         const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
 628
 629         if (IS_ERR(attr))
 630                 return PTR_ERR(attr);
 631
 632         /*
 633          * Validation ensures attr->ptr_attr.len >= size. If the caller is
 634          * using UVERBS_ATTR_SPEC_F_MIN_SZ_OR_ZERO then it must call
 635          * uverbs_copy_from_or_zero.
 636          */
 637         if (unlikely(size < attr->ptr_attr.len))
 638                 return -EINVAL;
 639
 640         if (uverbs_attr_ptr_is_inline(attr))
 641                 memcpy(to, &attr->ptr_attr.data, attr->ptr_attr.len);
 642         else if (copy_from_user(to, u64_to_user_ptr(attr->ptr_attr.data),
 643                                 attr->ptr_attr.len))
 644                 return -EFAULT;
 645
 646         return 0;
 647 }
 648
 649 static inline int _uverbs_copy_from_or_zero(void *to,
 650                                             const struct uverbs_attr_bundle *attrs_bundle,
 651                                             size_t idx,
 652                                             size_t size)
 653 {
 654         const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
 655         size_t min_size;
 656
 657         if (IS_ERR(attr))
 658                 return PTR_ERR(attr);
 659
 660         min_size = min_t(size_t, size, attr->ptr_attr.len);
 661
 662         if (uverbs_attr_ptr_is_inline(attr))
 663                 memcpy(to, &attr->ptr_attr.data, min_size);
 664         else if (copy_from_user(to, u64_to_user_ptr(attr->ptr_attr.data),
 665                                 min_size))
 666                 return -EFAULT;
 667
 668         if (size > min_size)
 669                 memset(to + min_size, 0, size - min_size);
 670
 671         return 0;
 672 }
 673
 674 #define uverbs_copy_from(to, attrs_bundle, idx)                               \
 675         _uverbs_copy_from(to, attrs_bundle, idx, sizeof(*to))
 676
 677 #define uverbs_copy_from_or_zero(to, attrs_bundle, idx)                       \
 678         _uverbs_copy_from_or_zero(to, attrs_bundle, idx, sizeof(*to))
 679
 680 #if IS_ENABLED(CONFIG_INFINIBAND_USER_ACCESS)
 681 int uverbs_get_flags64(u64 *to, const struct uverbs_attr_bundle *attrs_bundle,
 682                        size_t idx, u64 allowed_bits);
 683 int uverbs_get_flags32(u32 *to, const struct uverbs_attr_bundle *attrs_bundle,
 684                        size_t idx, u64 allowed_bits);
 685 int uverbs_copy_to(const struct uverbs_attr_bundle *attrs_bundle, size_t idx,
 686                    const void *from, size_t size);
 687 __malloc void *_uverbs_alloc(struct uverbs_attr_bundle *bundle, size_t size,
 688                              gfp_t flags);
 689
 690 static inline __malloc void *uverbs_alloc(struct uverbs_attr_bundle *bundle,
 691                                           size_t size)
 692 {
 693         return _uverbs_alloc(bundle, size, GFP_KERNEL);
 694 }
 695
 696 static inline __malloc void *uverbs_zalloc(struct uverbs_attr_bundle *bundle,
 697                                            size_t size)
 698 {
 699         return _uverbs_alloc(bundle, size, GFP_KERNEL | __GFP_ZERO);
 700 }
 701 int _uverbs_get_const(s64 *to, const struct uverbs_attr_bundle *attrs_bundle,
 702                       size_t idx, s64 lower_bound, u64 upper_bound,
 703                       s64 *def_val);
 704 #else
 705 static inline int
 706 uverbs_get_flags64(u64 *to, const struct uverbs_attr_bundle *attrs_bundle,
 707                    size_t idx, u64 allowed_bits)
 708 {
 709         return -EINVAL;
 710 }
 711 static inline int
 712 uverbs_get_flags32(u32 *to, const struct uverbs_attr_bundle *attrs_bundle,
 713                    size_t idx, u64 allowed_bits)
 714 {
 715         return -EINVAL;
 716 }
 717 static inline int uverbs_copy_to(const struct uverbs_attr_bundle *attrs_bundle,
 718                                  size_t idx, const void *from, size_t size)
 719 {
 720         return -EINVAL;
 721 }
 722 static inline __malloc void *uverbs_alloc(struct uverbs_attr_bundle *bundle,
 723                                           size_t size)
 724 {
 725         return ERR_PTR(-EINVAL);
 726 }
 727 static inline __malloc void *uverbs_zalloc(struct uverbs_attr_bundle *bundle,
 728                                            size_t size)
 729 {
 730         return ERR_PTR(-EINVAL);
 731 }
 732 static inline int
 733 _uverbs_get_const(s64 *to, const struct uverbs_attr_bundle *attrs_bundle,
 734                   size_t idx, s64 lower_bound, u64 upper_bound,
 735                   s64 *def_val)
 736 {
 737         return -EINVAL;
 738 }
 739 #endif
 740
 741 #define uverbs_get_const(_to, _attrs_bundle, _idx)                             \
 742         ({                                                                     \
 743                 s64 _val;                                                      \
 744                 int _ret = _uverbs_get_const(&_val, _attrs_bundle, _idx,       \
 745                                              type_min(typeof(*_to)),           \
 746                                              type_max(typeof(*_to)), NULL);    \
 747                 (*_to) = _val;                                                 \
 748                 _ret;                                                          \
 749         })
 750
 751 #define uverbs_get_const_default(_to, _attrs_bundle, _idx, _default)           \
 752         ({                                                                     \
 753                 s64 _val;                                                      \
 754                 s64 _def_val = _default;                                       \
 755                 int _ret =                                                     \
 756                         _uverbs_get_const(&_val, _attrs_bundle, _idx,          \
 757                                           type_min(typeof(*_to)),              \
 758                                           type_max(typeof(*_to)), &_def_val);  \
 759                 (*_to) = _val;                                                 \
 760                 _ret;                                                          \
 761         })
 762 #endif