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_TYPES_ 34 #define _UVERBS_TYPES_ 35 36 #include <linux/kernel.h> 37 #include <rdma/ib_verbs.h> 38 39 struct uverbs_obj_type; 40 41 enum rdma_lookup_mode { 42 UVERBS_LOOKUP_READ, 43 UVERBS_LOOKUP_WRITE, 44 /* 45 * Destroy is like LOOKUP_WRITE, except that the uobject is not 46 * locked. uobj_destroy is used to convert a LOOKUP_DESTROY lock into 47 * a LOOKUP_WRITE lock. 48 */ 49 UVERBS_LOOKUP_DESTROY, 50 }; 51 52 /* 53 * The following sequences are valid: 54 * Success flow: 55 * alloc_begin 56 * alloc_commit 57 * [..] 58 * Access flow: 59 * lookup_get(exclusive=false) & uverbs_try_lock_object 60 * lookup_put(exclusive=false) via rdma_lookup_put_uobject 61 * Destruction flow: 62 * lookup_get(exclusive=true) & uverbs_try_lock_object 63 * remove_commit 64 * lookup_put(exclusive=true) via rdma_lookup_put_uobject 65 * 66 * Allocate Error flow #1 67 * alloc_begin 68 * alloc_abort 69 * Allocate Error flow #2 70 * alloc_begin 71 * remove_commit 72 * alloc_abort 73 * Allocate Error flow #3 74 * alloc_begin 75 * alloc_commit (fails) 76 * remove_commit 77 * alloc_abort 78 * 79 * In all cases the caller must hold the ufile kref until alloc_commit or 80 * alloc_abort returns. 81 */ 82 struct uverbs_obj_type_class { 83 struct ib_uobject *(*alloc_begin)(const struct uverbs_obj_type *type, 84 struct ib_uverbs_file *ufile); 85 /* This consumes the kref on uobj */ 86 int (*alloc_commit)(struct ib_uobject *uobj); 87 /* This does not consume the kref on uobj */ 88 void (*alloc_abort)(struct ib_uobject *uobj); 89 90 struct ib_uobject *(*lookup_get)(const struct uverbs_obj_type *type, 91 struct ib_uverbs_file *ufile, s64 id, 92 enum rdma_lookup_mode mode); 93 void (*lookup_put)(struct ib_uobject *uobj, enum rdma_lookup_mode mode); 94 /* This does not consume the kref on uobj */ 95 int __must_check (*remove_commit)(struct ib_uobject *uobj, 96 enum rdma_remove_reason why); 97 u8 needs_kfree_rcu; 98 }; 99 100 struct uverbs_obj_type { 101 const struct uverbs_obj_type_class * const type_class; 102 size_t obj_size; 103 }; 104 105 /* 106 * Objects type classes which support a detach state (object is still alive but 107 * it's not attached to any context need to make sure: 108 * (a) no call through to a driver after a detach is called 109 * (b) detach isn't called concurrently with context_cleanup 110 */ 111 112 struct uverbs_obj_idr_type { 113 /* 114 * In idr based objects, uverbs_obj_type_class points to a generic 115 * idr operations. In order to specialize the underlying types (e.g. CQ, 116 * QPs, etc.), we add destroy_object specific callbacks. 117 */ 118 struct uverbs_obj_type type; 119 120 /* Free driver resources from the uobject, make the driver uncallable, 121 * and move the uobject to the detached state. If the object was 122 * destroyed by the user's request, a failure should leave the uobject 123 * completely unchanged. 124 */ 125 int __must_check (*destroy_object)(struct ib_uobject *uobj, 126 enum rdma_remove_reason why); 127 }; 128 129 struct ib_uobject *rdma_lookup_get_uobject(const struct uverbs_obj_type *type, 130 struct ib_uverbs_file *ufile, s64 id, 131 enum rdma_lookup_mode mode); 132 void rdma_lookup_put_uobject(struct ib_uobject *uobj, 133 enum rdma_lookup_mode mode); 134 struct ib_uobject *rdma_alloc_begin_uobject(const struct uverbs_obj_type *type, 135 struct ib_uverbs_file *ufile); 136 void rdma_alloc_abort_uobject(struct ib_uobject *uobj); 137 int __must_check rdma_alloc_commit_uobject(struct ib_uobject *uobj); 138 139 struct uverbs_obj_fd_type { 140 /* 141 * In fd based objects, uverbs_obj_type_ops points to generic 142 * fd operations. In order to specialize the underlying types (e.g. 143 * completion_channel), we use fops, name and flags for fd creation. 144 * context_closed is called when the context is closed either when 145 * the driver is removed or the process terminated. 146 */ 147 struct uverbs_obj_type type; 148 int (*context_closed)(struct ib_uobject *uobj, 149 enum rdma_remove_reason why); 150 const struct file_operations *fops; 151 const char *name; 152 int flags; 153 }; 154 155 extern const struct uverbs_obj_type_class uverbs_idr_class; 156 extern const struct uverbs_obj_type_class uverbs_fd_class; 157 158 #define UVERBS_BUILD_BUG_ON(cond) (sizeof(char[1 - 2 * !!(cond)]) - \ 159 sizeof(char)) 160 #define UVERBS_TYPE_ALLOC_FD(_obj_size, _context_closed, _fops, _name, _flags)\ 161 ((&((const struct uverbs_obj_fd_type) \ 162 {.type = { \ 163 .type_class = &uverbs_fd_class, \ 164 .obj_size = (_obj_size) + \ 165 UVERBS_BUILD_BUG_ON((_obj_size) < \ 166 sizeof(struct ib_uobject)), \ 167 }, \ 168 .context_closed = _context_closed, \ 169 .fops = _fops, \ 170 .name = _name, \ 171 .flags = _flags}))->type) 172 #define UVERBS_TYPE_ALLOC_IDR_SZ(_size, _destroy_object) \ 173 ((&((const struct uverbs_obj_idr_type) \ 174 {.type = { \ 175 .type_class = &uverbs_idr_class, \ 176 .obj_size = (_size) + \ 177 UVERBS_BUILD_BUG_ON((_size) < \ 178 sizeof(struct ib_uobject)) \ 179 }, \ 180 .destroy_object = _destroy_object,}))->type) 181 #define UVERBS_TYPE_ALLOC_IDR(_destroy_object) \ 182 UVERBS_TYPE_ALLOC_IDR_SZ(sizeof(struct ib_uobject), \ 183 _destroy_object) 184 185 #endif 186