1 /*
2 * Copyright (c) 2005 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
4 * Copyright (c) 2005-2017 Mellanox Technologies. All rights reserved.
5 * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
6 * Copyright (c) 2005 PathScale, Inc. All rights reserved.
7 *
8 * This software is available to you under a choice of one of two
9 * licenses. You may choose to be licensed under the terms of the GNU
10 * General Public License (GPL) Version 2, available from the file
11 * COPYING in the main directory of this source tree, or the
12 * OpenIB.org BSD license below:
13 *
14 * Redistribution and use in source and binary forms, with or
15 * without modification, are permitted provided that the following
16 * conditions are met:
17 *
18 * - Redistributions of source code must retain the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer.
21 *
22 * - Redistributions in binary form must reproduce the above
23 * copyright notice, this list of conditions and the following
24 * disclaimer in the documentation and/or other materials
25 * provided with the distribution.
26 *
27 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
28 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
29 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
30 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
31 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
32 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
33 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
34 * SOFTWARE.
35 */
36
37 #ifndef RDMA_CORE_H
38 #define RDMA_CORE_H
39
40 #include <linux/idr.h>
41 #include <rdma/uverbs_types.h>
42 #include <rdma/uverbs_ioctl.h>
43 #include <rdma/ib_verbs.h>
44 #include <linux/mutex.h>
45
46 struct ib_uverbs_device;
47
48 void uverbs_destroy_ufile_hw(struct ib_uverbs_file *ufile,
49 enum rdma_remove_reason reason);
50
51 int uobj_destroy(struct ib_uobject *uobj);
52
53 /*
54 * uverbs_uobject_get is called in order to increase the reference count on
55 * an uobject. This is useful when a handler wants to keep the uobject's memory
56 * alive, regardless if this uobject is still alive in the context's objects
57 * repository. Objects are put via uverbs_uobject_put.
58 */
59 void uverbs_uobject_get(struct ib_uobject *uobject);
60
61 /*
62 * In order to indicate we no longer needs this uobject, uverbs_uobject_put
63 * is called. When the reference count is decreased, the uobject is freed.
64 * For example, this is used when attaching a completion channel to a CQ.
65 */
66 void uverbs_uobject_put(struct ib_uobject *uobject);
67
68 /* Indicate this fd is no longer used by this consumer, but its memory isn't
69 * necessarily released yet. When the last reference is put, we release the
70 * memory. After this call is executed, calling uverbs_uobject_get isn't
71 * allowed.
72 * This must be called from the release file_operations of the file!
73 */
74 void uverbs_close_fd(struct file *f);
75
76 /*
77 * Get an ib_uobject that corresponds to the given id from ufile, assuming
78 * the object is from the given type. Lock it to the required access when
79 * applicable.
80 * This function could create (access == NEW), destroy (access == DESTROY)
81 * or unlock (access == READ || access == WRITE) objects if required.
82 * The action will be finalized only when uverbs_finalize_object or
83 * uverbs_finalize_objects are called.
84 */
85 struct ib_uobject *
86 uverbs_get_uobject_from_file(u16 object_id,
87 struct ib_uverbs_file *ufile,
88 enum uverbs_obj_access access, s64 id);
89
90 /*
91 * Note that certain finalize stages could return a status:
92 * (a) alloc_commit could return a failure if the object is committed at the
93 * same time when the context is destroyed.
94 * (b) remove_commit could fail if the object wasn't destroyed successfully.
95 * Since multiple objects could be finalized in one transaction, it is very NOT
96 * recommended to have several finalize actions which have side effects.
97 * For example, it's NOT recommended to have a certain action which has both
98 * a commit action and a destroy action or two destroy objects in the same
99 * action. The rule of thumb is to have one destroy or commit action with
100 * multiple lookups.
101 * The first non zero return value of finalize_object is returned from this
102 * function. For example, this could happen when we couldn't destroy an
103 * object.
104 */
105 int uverbs_finalize_object(struct ib_uobject *uobj,
106 enum uverbs_obj_access access,
107 bool commit);
108
109 void setup_ufile_idr_uobject(struct ib_uverbs_file *ufile);
110 void release_ufile_idr_uobject(struct ib_uverbs_file *ufile);
111
112 /*
113 * This is the runtime description of the uverbs API, used by the syscall
114 * machinery to validate and dispatch calls.
115 */
116
117 /*
118 * Depending on ID the slot pointer in the radix tree points at one of these
119 * structs.
120 */
121 struct uverbs_api_object {
122 const struct uverbs_obj_type *type_attrs;
123 const struct uverbs_obj_type_class *type_class;
124 };
125
126 struct uverbs_api_ioctl_method {
127 int (__rcu *handler)(struct ib_uverbs_file *ufile,
128 struct uverbs_attr_bundle *ctx);
129 DECLARE_BITMAP(attr_mandatory, UVERBS_API_ATTR_BKEY_LEN);
130 u16 bundle_size;
131 u8 use_stack:1;
132 u8 driver_method:1;
133 u8 key_bitmap_len;
134 u8 destroy_bkey;
135 };
136
137 struct uverbs_api_attr {
138 struct uverbs_attr_spec spec;
139 };
140
141 struct uverbs_api_object;
142 struct uverbs_api {
143 /* radix tree contains struct uverbs_api_* pointers */
144 struct radix_tree_root radix;
145 enum rdma_driver_id driver_id;
146 };
147
148 static inline const struct uverbs_api_object *
uapi_get_object(struct uverbs_api * uapi,u16 object_id)149 uapi_get_object(struct uverbs_api *uapi, u16 object_id)
150 {
151 return radix_tree_lookup(&uapi->radix, uapi_key_obj(object_id));
152 }
153
154 char *uapi_key_format(char *S, unsigned int key);
155 struct uverbs_api *uverbs_alloc_api(
156 const struct uverbs_object_tree_def *const *driver_specs,
157 enum rdma_driver_id driver_id);
158 void uverbs_disassociate_api_pre(struct ib_uverbs_device *uverbs_dev);
159 void uverbs_disassociate_api(struct uverbs_api *uapi);
160 void uverbs_destroy_api(struct uverbs_api *uapi);
161 void uapi_compute_bundle_size(struct uverbs_api_ioctl_method *method_elm,
162 unsigned int num_attrs);
163
164 #endif /* RDMA_CORE_H */
165
