1 // SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
3 * Copyright (c) 2017, Mellanox Technologies inc. All rights reserved.
5 #include <rdma/uverbs_ioctl.h>
6 #include <rdma/rdma_user_ioctl.h>
7 #include <linux/bitops.h>
11 static int ib_uverbs_notsupp(struct uverbs_attr_bundle *attrs,
12 const char __user *buf, int in_len, int out_len)
17 static int ib_uverbs_ex_notsupp(struct uverbs_attr_bundle *attrs,
18 struct ib_udata *ucore, struct ib_udata *uhw)
23 static void *uapi_add_elm(struct uverbs_api *uapi, u32 key, size_t alloc_size)
28 if (key == UVERBS_API_KEY_ERR)
29 return ERR_PTR(-EOVERFLOW);
31 elm = kzalloc(alloc_size, GFP_KERNEL);
32 rc = radix_tree_insert(&uapi->radix, key, elm);
41 static void *uapi_add_get_elm(struct uverbs_api *uapi, u32 key,
42 size_t alloc_size, bool *exists)
46 elm = uapi_add_elm(uapi, key, alloc_size);
52 if (elm != ERR_PTR(-EEXIST))
55 elm = radix_tree_lookup(&uapi->radix, key);
57 return ERR_PTR(-EINVAL);
62 static int uapi_create_write(struct uverbs_api *uapi,
63 struct ib_device *ibdev,
64 const struct uapi_definition *def,
68 struct uverbs_api_write_method *method_elm;
69 u32 method_key = obj_key;
73 method_key |= uapi_key_write_ex_method(def->write.command_num);
75 method_key |= uapi_key_write_method(def->write.command_num);
77 method_elm = uapi_add_get_elm(uapi, method_key, sizeof(*method_elm),
79 if (IS_ERR(method_elm))
80 return PTR_ERR(method_elm);
82 if (WARN_ON(exists && (def->write.is_ex != method_elm->is_ex ||
83 method_elm->handler_ex || method_elm->handler)))
86 method_elm->is_ex = def->write.is_ex;
87 if (def->write.is_ex) {
88 method_elm->handler_ex = def->func_write_ex;
90 method_elm->disabled = !(ibdev->uverbs_ex_cmd_mask &
91 BIT_ULL(def->write.command_num));
93 method_elm->handler = def->func_write;
95 method_elm->disabled = !(ibdev->uverbs_cmd_mask &
96 BIT_ULL(def->write.command_num));
99 if (!def->write.is_ex && def->func_write) {
100 method_elm->has_udata = def->write.has_udata;
101 method_elm->has_resp = def->write.has_resp;
102 method_elm->req_size = def->write.req_size;
103 method_elm->resp_size = def->write.resp_size;
106 *cur_method_key = method_key;
110 static int uapi_merge_method(struct uverbs_api *uapi,
111 struct uverbs_api_object *obj_elm, u32 obj_key,
112 const struct uverbs_method_def *method,
115 u32 method_key = obj_key | uapi_key_ioctl_method(method->id);
116 struct uverbs_api_ioctl_method *method_elm;
123 method_elm = uapi_add_get_elm(uapi, method_key, sizeof(*method_elm),
125 if (IS_ERR(method_elm))
126 return PTR_ERR(method_elm);
129 * This occurs when a driver uses ADD_UVERBS_ATTRIBUTES_SIMPLE
131 if (WARN_ON(method->handler))
134 WARN_ON(!method->handler);
135 rcu_assign_pointer(method_elm->handler, method->handler);
136 if (method->handler != uverbs_destroy_def_handler)
137 method_elm->driver_method = is_driver;
140 for (i = 0; i != method->num_attrs; i++) {
141 const struct uverbs_attr_def *attr = (*method->attrs)[i];
142 struct uverbs_api_attr *attr_slot;
148 * ENUM_IN contains the 'ids' pointer to the driver's .rodata,
149 * so if it is specified by a driver then it always makes this
150 * into a driver method.
152 if (attr->attr.type == UVERBS_ATTR_TYPE_ENUM_IN)
153 method_elm->driver_method |= is_driver;
156 * Like other uobject based things we only support a single
157 * uobject being NEW'd or DESTROY'd
159 if (attr->attr.type == UVERBS_ATTR_TYPE_IDRS_ARRAY) {
160 u8 access = attr->attr.u2.objs_arr.access;
162 if (WARN_ON(access == UVERBS_ACCESS_NEW ||
163 access == UVERBS_ACCESS_DESTROY))
168 uapi_add_elm(uapi, method_key | uapi_key_attr(attr->id),
170 /* Attributes are not allowed to be modified by drivers */
171 if (IS_ERR(attr_slot))
172 return PTR_ERR(attr_slot);
174 attr_slot->spec = attr->attr;
180 static int uapi_merge_obj_tree(struct uverbs_api *uapi,
181 const struct uverbs_object_def *obj,
184 struct uverbs_api_object *obj_elm;
190 obj_key = uapi_key_obj(obj->id);
191 obj_elm = uapi_add_get_elm(uapi, obj_key, sizeof(*obj_elm), &exists);
193 return PTR_ERR(obj_elm);
195 if (obj->type_attrs) {
196 if (WARN_ON(obj_elm->type_attrs))
199 obj_elm->type_attrs = obj->type_attrs;
200 obj_elm->type_class = obj->type_attrs->type_class;
202 * Today drivers are only permitted to use idr_class
203 * types. They cannot use FD types because we currently have
204 * no way to revoke the fops pointer after device
207 if (WARN_ON(is_driver &&
208 obj->type_attrs->type_class != &uverbs_idr_class))
215 for (i = 0; i != obj->num_methods; i++) {
216 const struct uverbs_method_def *method = (*obj->methods)[i];
221 rc = uapi_merge_method(uapi, obj_elm, obj_key, method,
230 static int uapi_disable_elm(struct uverbs_api *uapi,
231 const struct uapi_definition *def,
237 if (def->scope == UAPI_SCOPE_OBJECT) {
238 struct uverbs_api_object *obj_elm;
240 obj_elm = uapi_add_get_elm(
241 uapi, obj_key, sizeof(*obj_elm), &exists);
243 return PTR_ERR(obj_elm);
244 obj_elm->disabled = 1;
248 if (def->scope == UAPI_SCOPE_METHOD &&
249 uapi_key_is_ioctl_method(method_key)) {
250 struct uverbs_api_ioctl_method *method_elm;
252 method_elm = uapi_add_get_elm(uapi, method_key,
253 sizeof(*method_elm), &exists);
254 if (IS_ERR(method_elm))
255 return PTR_ERR(method_elm);
256 method_elm->disabled = 1;
260 if (def->scope == UAPI_SCOPE_METHOD &&
261 (uapi_key_is_write_method(method_key) ||
262 uapi_key_is_write_ex_method(method_key))) {
263 struct uverbs_api_write_method *write_elm;
265 write_elm = uapi_add_get_elm(uapi, method_key,
266 sizeof(*write_elm), &exists);
267 if (IS_ERR(write_elm))
268 return PTR_ERR(write_elm);
269 write_elm->disabled = 1;
277 static int uapi_merge_def(struct uverbs_api *uapi, struct ib_device *ibdev,
278 const struct uapi_definition *def_list,
281 const struct uapi_definition *def = def_list;
282 u32 cur_obj_key = UVERBS_API_KEY_ERR;
283 u32 cur_method_key = UVERBS_API_KEY_ERR;
291 switch ((enum uapi_definition_kind)def->kind) {
293 rc = uapi_merge_def(uapi, ibdev, def->chain, is_driver);
298 case UAPI_DEF_CHAIN_OBJ_TREE:
299 if (WARN_ON(def->object_start.object_id !=
300 def->chain_obj_tree->id))
303 cur_obj_key = uapi_key_obj(def->object_start.object_id);
304 rc = uapi_merge_obj_tree(uapi, def->chain_obj_tree,
313 case UAPI_DEF_IS_SUPPORTED_DEV_FN: {
314 void **ibdev_fn = (void *)ibdev + def->needs_fn_offset;
318 rc = uapi_disable_elm(
319 uapi, def, cur_obj_key, cur_method_key);
325 case UAPI_DEF_IS_SUPPORTED_FUNC:
326 if (def->func_is_supported(ibdev))
328 rc = uapi_disable_elm(
329 uapi, def, cur_obj_key, cur_method_key);
334 case UAPI_DEF_OBJECT_START: {
335 struct uverbs_api_object *obj_elm;
337 cur_obj_key = uapi_key_obj(def->object_start.object_id);
338 obj_elm = uapi_add_get_elm(uapi, cur_obj_key,
339 sizeof(*obj_elm), &exists);
341 return PTR_ERR(obj_elm);
346 rc = uapi_create_write(
347 uapi, ibdev, def, cur_obj_key, &cur_method_key);
358 uapi_finalize_ioctl_method(struct uverbs_api *uapi,
359 struct uverbs_api_ioctl_method *method_elm,
362 struct radix_tree_iter iter;
363 unsigned int num_attrs = 0;
364 unsigned int max_bkey = 0;
365 bool single_uobj = false;
368 method_elm->destroy_bkey = UVERBS_API_ATTR_BKEY_LEN;
369 radix_tree_for_each_slot (slot, &uapi->radix, &iter,
370 uapi_key_attrs_start(method_key)) {
371 struct uverbs_api_attr *elm =
372 rcu_dereference_protected(*slot, true);
373 u32 attr_key = iter.index & UVERBS_API_ATTR_KEY_MASK;
374 u32 attr_bkey = uapi_bkey_attr(attr_key);
375 u8 type = elm->spec.type;
377 if (uapi_key_attr_to_ioctl_method(iter.index) !=
378 uapi_key_attr_to_ioctl_method(method_key))
381 if (elm->spec.mandatory)
382 __set_bit(attr_bkey, method_elm->attr_mandatory);
384 if (type == UVERBS_ATTR_TYPE_IDR ||
385 type == UVERBS_ATTR_TYPE_FD) {
386 u8 access = elm->spec.u.obj.access;
389 * Verbs specs may only have one NEW/DESTROY, we don't
390 * have the infrastructure to abort multiple NEW's or
391 * cope with multiple DESTROY failure.
393 if (access == UVERBS_ACCESS_NEW ||
394 access == UVERBS_ACCESS_DESTROY) {
395 if (WARN_ON(single_uobj))
399 if (WARN_ON(!elm->spec.mandatory))
403 if (access == UVERBS_ACCESS_DESTROY)
404 method_elm->destroy_bkey = attr_bkey;
407 max_bkey = max(max_bkey, attr_bkey);
411 method_elm->key_bitmap_len = max_bkey + 1;
412 WARN_ON(method_elm->key_bitmap_len > UVERBS_API_ATTR_BKEY_LEN);
414 uapi_compute_bundle_size(method_elm, num_attrs);
418 static int uapi_finalize(struct uverbs_api *uapi)
420 const struct uverbs_api_write_method **data;
421 unsigned long max_write_ex = 0;
422 unsigned long max_write = 0;
423 struct radix_tree_iter iter;
428 radix_tree_for_each_slot (slot, &uapi->radix, &iter, 0) {
429 struct uverbs_api_ioctl_method *method_elm =
430 rcu_dereference_protected(*slot, true);
432 if (uapi_key_is_ioctl_method(iter.index)) {
433 rc = uapi_finalize_ioctl_method(uapi, method_elm,
439 if (uapi_key_is_write_method(iter.index))
440 max_write = max(max_write,
441 iter.index & UVERBS_API_ATTR_KEY_MASK);
442 if (uapi_key_is_write_ex_method(iter.index))
445 iter.index & UVERBS_API_ATTR_KEY_MASK);
448 uapi->notsupp_method.handler = ib_uverbs_notsupp;
449 uapi->notsupp_method.handler_ex = ib_uverbs_ex_notsupp;
450 uapi->num_write = max_write + 1;
451 uapi->num_write_ex = max_write_ex + 1;
452 data = kmalloc_array(uapi->num_write + uapi->num_write_ex,
453 sizeof(*uapi->write_methods), GFP_KERNEL);
454 for (i = 0; i != uapi->num_write + uapi->num_write_ex; i++)
455 data[i] = &uapi->notsupp_method;
456 uapi->write_methods = data;
457 uapi->write_ex_methods = data + uapi->num_write;
459 radix_tree_for_each_slot (slot, &uapi->radix, &iter, 0) {
460 if (uapi_key_is_write_method(iter.index))
461 uapi->write_methods[iter.index &
462 UVERBS_API_ATTR_KEY_MASK] =
463 rcu_dereference_protected(*slot, true);
464 if (uapi_key_is_write_ex_method(iter.index))
465 uapi->write_ex_methods[iter.index &
466 UVERBS_API_ATTR_KEY_MASK] =
467 rcu_dereference_protected(*slot, true);
473 static void uapi_remove_range(struct uverbs_api *uapi, u32 start, u32 last)
475 struct radix_tree_iter iter;
478 radix_tree_for_each_slot (slot, &uapi->radix, &iter, start) {
479 if (iter.index > last)
481 kfree(rcu_dereference_protected(*slot, true));
482 radix_tree_iter_delete(&uapi->radix, &iter, slot);
486 static void uapi_remove_object(struct uverbs_api *uapi, u32 obj_key)
488 uapi_remove_range(uapi, obj_key,
489 obj_key | UVERBS_API_METHOD_KEY_MASK |
490 UVERBS_API_ATTR_KEY_MASK);
493 static void uapi_remove_method(struct uverbs_api *uapi, u32 method_key)
495 uapi_remove_range(uapi, method_key,
496 method_key | UVERBS_API_ATTR_KEY_MASK);
500 static u32 uapi_get_obj_id(struct uverbs_attr_spec *spec)
502 if (spec->type == UVERBS_ATTR_TYPE_IDR ||
503 spec->type == UVERBS_ATTR_TYPE_FD)
504 return spec->u.obj.obj_type;
505 if (spec->type == UVERBS_ATTR_TYPE_IDRS_ARRAY)
506 return spec->u2.objs_arr.obj_type;
507 return UVERBS_API_KEY_ERR;
510 static void uapi_key_okay(u32 key)
512 unsigned int count = 0;
514 if (uapi_key_is_object(key))
516 if (uapi_key_is_ioctl_method(key))
518 if (uapi_key_is_write_method(key))
520 if (uapi_key_is_write_ex_method(key))
522 if (uapi_key_is_attr(key))
524 WARN(count != 1, "Bad count %d key=%x", count, key);
527 static void uapi_finalize_disable(struct uverbs_api *uapi)
529 struct radix_tree_iter iter;
530 u32 starting_key = 0;
531 bool scan_again = false;
535 radix_tree_for_each_slot (slot, &uapi->radix, &iter, starting_key) {
536 uapi_key_okay(iter.index);
538 if (uapi_key_is_object(iter.index)) {
539 struct uverbs_api_object *obj_elm =
540 rcu_dereference_protected(*slot, true);
542 if (obj_elm->disabled) {
543 /* Have to check all the attrs again */
545 starting_key = iter.index;
546 uapi_remove_object(uapi, iter.index);
552 if (uapi_key_is_ioctl_method(iter.index)) {
553 struct uverbs_api_ioctl_method *method_elm =
554 rcu_dereference_protected(*slot, true);
556 if (method_elm->disabled) {
557 starting_key = iter.index;
558 uapi_remove_method(uapi, iter.index);
564 if (uapi_key_is_write_method(iter.index) ||
565 uapi_key_is_write_ex_method(iter.index)) {
566 struct uverbs_api_write_method *method_elm =
567 rcu_dereference_protected(*slot, true);
569 if (method_elm->disabled) {
571 radix_tree_iter_delete(&uapi->radix, &iter, slot);
576 if (uapi_key_is_attr(iter.index)) {
577 struct uverbs_api_attr *attr_elm =
578 rcu_dereference_protected(*slot, true);
579 const struct uverbs_api_object *tmp_obj;
583 * If the method has a mandatory object handle
584 * attribute which relies on an object which is not
585 * present then the entire method is uncallable.
587 if (!attr_elm->spec.mandatory)
589 obj_key = uapi_get_obj_id(&attr_elm->spec);
590 if (obj_key == UVERBS_API_KEY_ERR)
592 tmp_obj = uapi_get_object(uapi, obj_key);
593 if (tmp_obj && !tmp_obj->disabled)
596 starting_key = iter.index;
599 iter.index & (UVERBS_API_OBJ_KEY_MASK |
600 UVERBS_API_METHOD_KEY_MASK));
614 void uverbs_destroy_api(struct uverbs_api *uapi)
619 uapi_remove_range(uapi, 0, U32_MAX);
620 kfree(uapi->write_methods);
624 static const struct uapi_definition uverbs_core_api[] = {
625 UAPI_DEF_CHAIN(uverbs_def_obj_counters),
626 UAPI_DEF_CHAIN(uverbs_def_obj_cq),
627 UAPI_DEF_CHAIN(uverbs_def_obj_dm),
628 UAPI_DEF_CHAIN(uverbs_def_obj_flow_action),
629 UAPI_DEF_CHAIN(uverbs_def_obj_intf),
630 UAPI_DEF_CHAIN(uverbs_def_obj_mr),
631 UAPI_DEF_CHAIN(uverbs_def_write_intf),
635 struct uverbs_api *uverbs_alloc_api(struct ib_device *ibdev)
637 struct uverbs_api *uapi;
640 uapi = kzalloc(sizeof(*uapi), GFP_KERNEL);
642 return ERR_PTR(-ENOMEM);
644 INIT_RADIX_TREE(&uapi->radix, GFP_KERNEL);
645 uapi->driver_id = ibdev->driver_id;
647 rc = uapi_merge_def(uapi, ibdev, uverbs_core_api, false);
650 rc = uapi_merge_def(uapi, ibdev, ibdev->driver_def, true);
654 uapi_finalize_disable(uapi);
655 rc = uapi_finalize(uapi);
663 "Setup of uverbs_api failed, kernel parsing tree description is not valid (%d)??\n",
666 uverbs_destroy_api(uapi);
671 * The pre version is done before destroying the HW objects, it only blocks
672 * off method access. All methods that require the ib_dev or the module data
673 * must test one of these assignments prior to continuing.
675 void uverbs_disassociate_api_pre(struct ib_uverbs_device *uverbs_dev)
677 struct uverbs_api *uapi = uverbs_dev->uapi;
678 struct radix_tree_iter iter;
681 rcu_assign_pointer(uverbs_dev->ib_dev, NULL);
683 radix_tree_for_each_slot (slot, &uapi->radix, &iter, 0) {
684 if (uapi_key_is_ioctl_method(iter.index)) {
685 struct uverbs_api_ioctl_method *method_elm =
686 rcu_dereference_protected(*slot, true);
688 if (method_elm->driver_method)
689 rcu_assign_pointer(method_elm->handler, NULL);
693 synchronize_srcu(&uverbs_dev->disassociate_srcu);
697 * Called when a driver disassociates from the ib_uverbs_device. The
698 * assumption is that the driver module will unload after. Replace everything
699 * related to the driver with NULL as a safety measure.
701 void uverbs_disassociate_api(struct uverbs_api *uapi)
703 struct radix_tree_iter iter;
706 radix_tree_for_each_slot (slot, &uapi->radix, &iter, 0) {
707 if (uapi_key_is_object(iter.index)) {
708 struct uverbs_api_object *object_elm =
709 rcu_dereference_protected(*slot, true);
712 * Some type_attrs are in the driver module. We don't
713 * bother to keep track of which since there should be
714 * no use of this after disassociate.
716 object_elm->type_attrs = NULL;
717 } else if (uapi_key_is_attr(iter.index)) {
718 struct uverbs_api_attr *elm =
719 rcu_dereference_protected(*slot, true);
721 if (elm->spec.type == UVERBS_ATTR_TYPE_ENUM_IN)
722 elm->spec.u2.enum_def.ids = NULL;