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