1 /*
2  * Copyright (c) 2004 Topspin Communications.  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 _CORE_PRIV_H
34 #define _CORE_PRIV_H
35 
36 #include <linux/list.h>
37 #include <linux/spinlock.h>
38 #include <linux/cgroup_rdma.h>
39 
40 #include <rdma/ib_verbs.h>
41 #include <rdma/opa_addr.h>
42 #include <rdma/ib_mad.h>
43 #include <rdma/restrack.h>
44 #include "mad_priv.h"
45 
46 /* Total number of ports combined across all struct ib_devices's */
47 #define RDMA_MAX_PORTS 8192
48 
49 struct pkey_index_qp_list {
50 	struct list_head    pkey_index_list;
51 	u16                 pkey_index;
52 	/* Lock to hold while iterating the qp_list. */
53 	spinlock_t          qp_list_lock;
54 	struct list_head    qp_list;
55 };
56 
57 extern const struct attribute_group ib_dev_attr_group;
58 extern bool ib_devices_shared_netns;
59 
60 int ib_device_register_sysfs(struct ib_device *device);
61 void ib_device_unregister_sysfs(struct ib_device *device);
62 int ib_device_rename(struct ib_device *ibdev, const char *name);
63 int ib_device_set_dim(struct ib_device *ibdev, u8 use_dim);
64 
65 typedef void (*roce_netdev_callback)(struct ib_device *device, u8 port,
66 	      struct net_device *idev, void *cookie);
67 
68 typedef bool (*roce_netdev_filter)(struct ib_device *device, u8 port,
69 				   struct net_device *idev, void *cookie);
70 
71 struct net_device *ib_device_get_netdev(struct ib_device *ib_dev,
72 					unsigned int port);
73 
74 void ib_enum_roce_netdev(struct ib_device *ib_dev,
75 			 roce_netdev_filter filter,
76 			 void *filter_cookie,
77 			 roce_netdev_callback cb,
78 			 void *cookie);
79 void ib_enum_all_roce_netdevs(roce_netdev_filter filter,
80 			      void *filter_cookie,
81 			      roce_netdev_callback cb,
82 			      void *cookie);
83 
84 typedef int (*nldev_callback)(struct ib_device *device,
85 			      struct sk_buff *skb,
86 			      struct netlink_callback *cb,
87 			      unsigned int idx);
88 
89 int ib_enum_all_devs(nldev_callback nldev_cb, struct sk_buff *skb,
90 		     struct netlink_callback *cb);
91 
92 struct ib_client_nl_info {
93 	struct sk_buff *nl_msg;
94 	struct device *cdev;
95 	unsigned int port;
96 	u64 abi;
97 };
98 int ib_get_client_nl_info(struct ib_device *ibdev, const char *client_name,
99 			  struct ib_client_nl_info *res);
100 
101 enum ib_cache_gid_default_mode {
102 	IB_CACHE_GID_DEFAULT_MODE_SET,
103 	IB_CACHE_GID_DEFAULT_MODE_DELETE
104 };
105 
106 int ib_cache_gid_parse_type_str(const char *buf);
107 
108 const char *ib_cache_gid_type_str(enum ib_gid_type gid_type);
109 
110 void ib_cache_gid_set_default_gid(struct ib_device *ib_dev, u8 port,
111 				  struct net_device *ndev,
112 				  unsigned long gid_type_mask,
113 				  enum ib_cache_gid_default_mode mode);
114 
115 int ib_cache_gid_add(struct ib_device *ib_dev, u8 port,
116 		     union ib_gid *gid, struct ib_gid_attr *attr);
117 
118 int ib_cache_gid_del(struct ib_device *ib_dev, u8 port,
119 		     union ib_gid *gid, struct ib_gid_attr *attr);
120 
121 int ib_cache_gid_del_all_netdev_gids(struct ib_device *ib_dev, u8 port,
122 				     struct net_device *ndev);
123 
124 int roce_gid_mgmt_init(void);
125 void roce_gid_mgmt_cleanup(void);
126 
127 unsigned long roce_gid_type_mask_support(struct ib_device *ib_dev, u8 port);
128 
129 int ib_cache_setup_one(struct ib_device *device);
130 void ib_cache_cleanup_one(struct ib_device *device);
131 void ib_cache_release_one(struct ib_device *device);
132 
133 #ifdef CONFIG_CGROUP_RDMA
134 void ib_device_register_rdmacg(struct ib_device *device);
135 void ib_device_unregister_rdmacg(struct ib_device *device);
136 
137 int ib_rdmacg_try_charge(struct ib_rdmacg_object *cg_obj,
138 			 struct ib_device *device,
139 			 enum rdmacg_resource_type resource_index);
140 
141 void ib_rdmacg_uncharge(struct ib_rdmacg_object *cg_obj,
142 			struct ib_device *device,
143 			enum rdmacg_resource_type resource_index);
144 #else
145 static inline void ib_device_register_rdmacg(struct ib_device *device)
146 {
147 }
148 
149 static inline void ib_device_unregister_rdmacg(struct ib_device *device)
150 {
151 }
152 
153 static inline int ib_rdmacg_try_charge(struct ib_rdmacg_object *cg_obj,
154 				       struct ib_device *device,
155 				       enum rdmacg_resource_type resource_index)
156 {
157 	return 0;
158 }
159 
160 static inline void ib_rdmacg_uncharge(struct ib_rdmacg_object *cg_obj,
161 				      struct ib_device *device,
162 				      enum rdmacg_resource_type resource_index)
163 {
164 }
165 #endif
166 
167 static inline bool rdma_is_upper_dev_rcu(struct net_device *dev,
168 					 struct net_device *upper)
169 {
170 	return netdev_has_upper_dev_all_rcu(dev, upper);
171 }
172 
173 int addr_init(void);
174 void addr_cleanup(void);
175 
176 int ib_mad_init(void);
177 void ib_mad_cleanup(void);
178 
179 int ib_sa_init(void);
180 void ib_sa_cleanup(void);
181 
182 int rdma_nl_init(void);
183 void rdma_nl_exit(void);
184 
185 int ib_nl_handle_resolve_resp(struct sk_buff *skb,
186 			      struct nlmsghdr *nlh,
187 			      struct netlink_ext_ack *extack);
188 int ib_nl_handle_set_timeout(struct sk_buff *skb,
189 			     struct nlmsghdr *nlh,
190 			     struct netlink_ext_ack *extack);
191 int ib_nl_handle_ip_res_resp(struct sk_buff *skb,
192 			     struct nlmsghdr *nlh,
193 			     struct netlink_ext_ack *extack);
194 
195 int ib_get_cached_subnet_prefix(struct ib_device *device,
196 				u8                port_num,
197 				u64              *sn_pfx);
198 
199 #ifdef CONFIG_SECURITY_INFINIBAND
200 void ib_security_release_port_pkey_list(struct ib_device *device);
201 
202 void ib_security_cache_change(struct ib_device *device,
203 			      u8 port_num,
204 			      u64 subnet_prefix);
205 
206 int ib_security_modify_qp(struct ib_qp *qp,
207 			  struct ib_qp_attr *qp_attr,
208 			  int qp_attr_mask,
209 			  struct ib_udata *udata);
210 
211 int ib_create_qp_security(struct ib_qp *qp, struct ib_device *dev);
212 void ib_destroy_qp_security_begin(struct ib_qp_security *sec);
213 void ib_destroy_qp_security_abort(struct ib_qp_security *sec);
214 void ib_destroy_qp_security_end(struct ib_qp_security *sec);
215 int ib_open_shared_qp_security(struct ib_qp *qp, struct ib_device *dev);
216 void ib_close_shared_qp_security(struct ib_qp_security *sec);
217 int ib_mad_agent_security_setup(struct ib_mad_agent *agent,
218 				enum ib_qp_type qp_type);
219 void ib_mad_agent_security_cleanup(struct ib_mad_agent *agent);
220 int ib_mad_enforce_security(struct ib_mad_agent_private *map, u16 pkey_index);
221 void ib_mad_agent_security_change(void);
222 #else
223 static inline void ib_security_release_port_pkey_list(struct ib_device *device)
224 {
225 }
226 
227 static inline void ib_security_cache_change(struct ib_device *device,
228 					    u8 port_num,
229 					    u64 subnet_prefix)
230 {
231 }
232 
233 static inline int ib_security_modify_qp(struct ib_qp *qp,
234 					struct ib_qp_attr *qp_attr,
235 					int qp_attr_mask,
236 					struct ib_udata *udata)
237 {
238 	return qp->device->ops.modify_qp(qp->real_qp,
239 					 qp_attr,
240 					 qp_attr_mask,
241 					 udata);
242 }
243 
244 static inline int ib_create_qp_security(struct ib_qp *qp,
245 					struct ib_device *dev)
246 {
247 	return 0;
248 }
249 
250 static inline void ib_destroy_qp_security_begin(struct ib_qp_security *sec)
251 {
252 }
253 
254 static inline void ib_destroy_qp_security_abort(struct ib_qp_security *sec)
255 {
256 }
257 
258 static inline void ib_destroy_qp_security_end(struct ib_qp_security *sec)
259 {
260 }
261 
262 static inline int ib_open_shared_qp_security(struct ib_qp *qp,
263 					     struct ib_device *dev)
264 {
265 	return 0;
266 }
267 
268 static inline void ib_close_shared_qp_security(struct ib_qp_security *sec)
269 {
270 }
271 
272 static inline int ib_mad_agent_security_setup(struct ib_mad_agent *agent,
273 					      enum ib_qp_type qp_type)
274 {
275 	return 0;
276 }
277 
278 static inline void ib_mad_agent_security_cleanup(struct ib_mad_agent *agent)
279 {
280 }
281 
282 static inline int ib_mad_enforce_security(struct ib_mad_agent_private *map,
283 					  u16 pkey_index)
284 {
285 	return 0;
286 }
287 
288 static inline void ib_mad_agent_security_change(void)
289 {
290 }
291 #endif
292 
293 struct ib_device *ib_device_get_by_index(const struct net *net, u32 index);
294 
295 /* RDMA device netlink */
296 void nldev_init(void);
297 void nldev_exit(void);
298 
299 static inline struct ib_qp *_ib_create_qp(struct ib_device *dev,
300 					  struct ib_pd *pd,
301 					  struct ib_qp_init_attr *attr,
302 					  struct ib_udata *udata,
303 					  struct ib_uobject *uobj)
304 {
305 	struct ib_qp *qp;
306 
307 	if (!dev->ops.create_qp)
308 		return ERR_PTR(-EOPNOTSUPP);
309 
310 	qp = dev->ops.create_qp(pd, attr, udata);
311 	if (IS_ERR(qp))
312 		return qp;
313 
314 	qp->device = dev;
315 	qp->pd = pd;
316 	qp->uobject = uobj;
317 	qp->real_qp = qp;
318 	/*
319 	 * We don't track XRC QPs for now, because they don't have PD
320 	 * and more importantly they are created internaly by driver,
321 	 * see mlx5 create_dev_resources() as an example.
322 	 */
323 	if (attr->qp_type < IB_QPT_XRC_INI) {
324 		qp->res.type = RDMA_RESTRACK_QP;
325 		if (uobj)
326 			rdma_restrack_uadd(&qp->res);
327 		else
328 			rdma_restrack_kadd(&qp->res);
329 	} else
330 		qp->res.valid = false;
331 
332 	return qp;
333 }
334 
335 struct rdma_dev_addr;
336 int rdma_resolve_ip_route(struct sockaddr *src_addr,
337 			  const struct sockaddr *dst_addr,
338 			  struct rdma_dev_addr *addr);
339 
340 int rdma_addr_find_l2_eth_by_grh(const union ib_gid *sgid,
341 				 const union ib_gid *dgid,
342 				 u8 *dmac, const struct ib_gid_attr *sgid_attr,
343 				 int *hoplimit);
344 void rdma_copy_src_l2_addr(struct rdma_dev_addr *dev_addr,
345 			   const struct net_device *dev);
346 
347 struct sa_path_rec;
348 int roce_resolve_route_from_path(struct sa_path_rec *rec,
349 				 const struct ib_gid_attr *attr);
350 
351 struct net_device *rdma_read_gid_attr_ndev_rcu(const struct ib_gid_attr *attr);
352 
353 void ib_free_port_attrs(struct ib_core_device *coredev);
354 int ib_setup_port_attrs(struct ib_core_device *coredev);
355 
356 int rdma_compatdev_set(u8 enable);
357 
358 int ib_port_register_module_stat(struct ib_device *device, u8 port_num,
359 				 struct kobject *kobj, struct kobj_type *ktype,
360 				 const char *name);
361 void ib_port_unregister_module_stat(struct kobject *kobj);
362 
363 int ib_device_set_netns_put(struct sk_buff *skb,
364 			    struct ib_device *dev, u32 ns_fd);
365 #endif /* _CORE_PRIV_H */
366