xref: /freebsd/sys/ofed/include/rdma/ib_addr.h (revision d0ba1baed3f6e4936a0c1b89c25f6c59168ef6de)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3  *
4  * Copyright (c) 2005 Voltaire Inc.  All rights reserved.
5  * Copyright (c) 2005 Intel Corporation.  All rights reserved.
6  *
7  * This software is available to you under a choice of one of two
8  * licenses.  You may choose to be licensed under the terms of the GNU
9  * General Public License (GPL) Version 2, available from the file
10  * COPYING in the main directory of this source tree, or the
11  * OpenIB.org BSD license below:
12  *
13  *     Redistribution and use in source and binary forms, with or
14  *     without modification, are permitted provided that the following
15  *     conditions are met:
16  *
17  *      - Redistributions of source code must retain the above
18  *        copyright notice, this list of conditions and the following
19  *        disclaimer.
20  *
21  *      - Redistributions in binary form must reproduce the above
22  *        copyright notice, this list of conditions and the following
23  *        disclaimer in the documentation and/or other materials
24  *        provided with the distribution.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
29  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
30  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
31  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
32  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33  * SOFTWARE.
34  *
35  * $FreeBSD$
36  */
37 
38 #if !defined(IB_ADDR_H)
39 #define IB_ADDR_H
40 
41 #include <linux/in.h>
42 #include <linux/in6.h>
43 #include <linux/if_arp.h>
44 #include <linux/netdevice.h>
45 #include <linux/inetdevice.h>
46 #include <linux/socket.h>
47 #include <linux/if_vlan.h>
48 #include <net/ipv6.h>
49 #include <net/if_inet6.h>
50 #include <net/ip.h>
51 #include <rdma/ib_verbs.h>
52 #include <rdma/ib_pack.h>
53 #include <net/ipv6.h>
54 
55 
56 struct rdma_addr_client {
57 	atomic_t refcount;
58 	struct completion comp;
59 };
60 
61 /**
62  * rdma_addr_register_client - Register an address client.
63  */
64 void rdma_addr_register_client(struct rdma_addr_client *client);
65 
66 /**
67  * rdma_addr_unregister_client - Deregister an address client.
68  * @client: Client object to deregister.
69  */
70 void rdma_addr_unregister_client(struct rdma_addr_client *client);
71 
72 /**
73  * struct rdma_dev_addr - Contains resolved RDMA hardware addresses
74  * @src_dev_addr:	Source MAC address.
75  * @dst_dev_addr:	Destination MAC address.
76  * @broadcast:		Broadcast address of the device.
77  * @dev_type:		The interface hardware type of the device.
78  * @bound_dev_if:	An optional device interface index.
79  * @transport:		The transport type used.
80  * @net:		Network namespace containing the bound_dev_if net_dev.
81  */
82 struct vnet;
83 struct rdma_dev_addr {
84 	unsigned char src_dev_addr[MAX_ADDR_LEN];
85 	unsigned char dst_dev_addr[MAX_ADDR_LEN];
86 	unsigned char broadcast[MAX_ADDR_LEN];
87 	unsigned short dev_type;
88 	int bound_dev_if;
89 	enum rdma_transport_type transport;
90 	struct vnet *net;
91 	enum rdma_network_type network;
92 	int hoplimit;
93 };
94 
95 /**
96  * rdma_translate_ip - Translate a local IP address to an RDMA hardware
97  *   address.
98  *
99  * The dev_addr->net and dev_addr->bound_dev_if fields must be initialized.
100  */
101 int rdma_translate_ip(const struct sockaddr *addr,
102 		      struct rdma_dev_addr *dev_addr);
103 
104 /**
105  * rdma_resolve_ip - Resolve source and destination IP addresses to
106  *   RDMA hardware addresses.
107  * @client: Address client associated with request.
108  * @src_addr: An optional source address to use in the resolution.  If a
109  *   source address is not provided, a usable address will be returned via
110  *   the callback.
111  * @dst_addr: The destination address to resolve.
112  * @addr: A reference to a data location that will receive the resolved
113  *   addresses.  The data location must remain valid until the callback has
114  *   been invoked. The net field of the addr struct must be valid.
115  * @timeout_ms: Amount of time to wait for the address resolution to complete.
116  * @callback: Call invoked once address resolution has completed, timed out,
117  *   or been canceled.  A status of 0 indicates success.
118  * @context: User-specified context associated with the call.
119  */
120 int rdma_resolve_ip(struct rdma_addr_client *client,
121 		    struct sockaddr *src_addr, struct sockaddr *dst_addr,
122 		    struct rdma_dev_addr *addr, int timeout_ms,
123 		    void (*callback)(int status, struct sockaddr *src_addr,
124 				     struct rdma_dev_addr *addr, void *context),
125 		    void *context);
126 
127 int rdma_resolve_ip_route(struct sockaddr *src_addr,
128 			  const struct sockaddr *dst_addr,
129 			  struct rdma_dev_addr *addr);
130 
131 void rdma_addr_cancel(struct rdma_dev_addr *addr);
132 
133 int rdma_copy_addr(struct rdma_dev_addr *dev_addr, struct net_device *dev,
134 	      const unsigned char *dst_dev_addr);
135 
136 int rdma_addr_size(struct sockaddr *addr);
137 
138 int rdma_addr_find_l2_eth_by_grh(const union ib_gid *sgid,
139 				 const union ib_gid *dgid,
140 				 u8 *smac, struct net_device *dev,
141 				 int *hoplimit);
142 
143 static inline u16 ib_addr_get_pkey(struct rdma_dev_addr *dev_addr)
144 {
145 	return ((u16)dev_addr->broadcast[8] << 8) | (u16)dev_addr->broadcast[9];
146 }
147 
148 static inline void ib_addr_set_pkey(struct rdma_dev_addr *dev_addr, u16 pkey)
149 {
150 	dev_addr->broadcast[8] = pkey >> 8;
151 	dev_addr->broadcast[9] = (unsigned char) pkey;
152 }
153 
154 static inline void ib_addr_get_mgid(struct rdma_dev_addr *dev_addr,
155 				    union ib_gid *gid)
156 {
157 	memcpy(gid, dev_addr->broadcast + 4, sizeof *gid);
158 }
159 
160 static inline int rdma_addr_gid_offset(struct rdma_dev_addr *dev_addr)
161 {
162 	return dev_addr->dev_type == ARPHRD_INFINIBAND ? 4 : 0;
163 }
164 
165 static inline u16 rdma_vlan_dev_vlan_id(const struct net_device *dev)
166 {
167 	uint16_t tag;
168 
169 	if (VLAN_TAG(__DECONST(struct ifnet *, dev), &tag) != 0)
170 		return 0xffff;
171 	return tag;
172 }
173 
174 static inline int rdma_ip2gid(const struct sockaddr *addr, union ib_gid *gid)
175 {
176 	switch (addr->sa_family) {
177 	case AF_INET:
178 		ipv6_addr_set_v4mapped(((const struct sockaddr_in *)
179 					addr)->sin_addr.s_addr,
180 				       (struct in6_addr *)gid);
181 		break;
182 	case AF_INET6:
183 		memcpy(gid->raw, &((const struct sockaddr_in6 *)addr)->sin6_addr, 16);
184 		/* make sure scope ID gets zeroed inside GID */
185 		if (IN6_IS_SCOPE_LINKLOCAL((struct in6_addr *)gid->raw) ||
186 		    IN6_IS_ADDR_MC_INTFACELOCAL((struct in6_addr *)gid->raw)) {
187 			gid->raw[2] = 0;
188 			gid->raw[3] = 0;
189 		}
190 		break;
191 	default:
192 		return -EINVAL;
193 	}
194 	return 0;
195 }
196 
197 /* Important - sockaddr should be a union of sockaddr_in and sockaddr_in6 */
198 static inline void rdma_gid2ip(struct sockaddr *out, const union ib_gid *gid)
199 {
200 	if (ipv6_addr_v4mapped((const struct in6_addr *)gid)) {
201 		struct sockaddr_in *out_in = (struct sockaddr_in *)out;
202 		memset(out_in, 0, sizeof(*out_in));
203 		out_in->sin_len = sizeof(*out_in);
204 		out_in->sin_family = AF_INET;
205 		memcpy(&out_in->sin_addr.s_addr, gid->raw + 12, 4);
206 	} else {
207 		struct sockaddr_in6 *out_in = (struct sockaddr_in6 *)out;
208 		memset(out_in, 0, sizeof(*out_in));
209 		out_in->sin6_len = sizeof(*out_in);
210 		out_in->sin6_family = AF_INET6;
211 		memcpy(&out_in->sin6_addr.s6_addr, gid->raw, 16);
212 	}
213 }
214 
215 static inline void iboe_addr_get_sgid(struct rdma_dev_addr *dev_addr,
216 				      union ib_gid *gid)
217 {
218 	struct net_device *dev;
219 	struct ifaddr *ifa;
220 
221 	dev = dev_get_by_index(&init_net, dev_addr->bound_dev_if);
222 	if (dev) {
223 		CK_STAILQ_FOREACH(ifa, &dev->if_addrhead, ifa_link) {
224 			if (ifa->ifa_addr == NULL ||
225 			    ifa->ifa_addr->sa_family != AF_INET)
226 				continue;
227 			ipv6_addr_set_v4mapped(((struct sockaddr_in *)
228 					       ifa->ifa_addr)->sin_addr.s_addr,
229 					       (struct in6_addr *)gid);
230 			break;
231 		}
232 		dev_put(dev);
233 	}
234 }
235 
236 static inline void rdma_addr_get_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
237 {
238 	if (dev_addr->transport == RDMA_TRANSPORT_IB &&
239 	    dev_addr->dev_type != ARPHRD_INFINIBAND)
240 		iboe_addr_get_sgid(dev_addr, gid);
241 	else
242 		memcpy(gid, dev_addr->src_dev_addr +
243 		       rdma_addr_gid_offset(dev_addr), sizeof *gid);
244 }
245 
246 static inline void rdma_addr_set_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
247 {
248 	memcpy(dev_addr->src_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
249 }
250 
251 static inline void rdma_addr_get_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
252 {
253 	memcpy(gid, dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), sizeof *gid);
254 }
255 
256 static inline void rdma_addr_set_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
257 {
258 	memcpy(dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
259 }
260 
261 static inline enum ib_mtu iboe_get_mtu(int mtu)
262 {
263 	/*
264 	 * reduce IB headers from effective IBoE MTU. 28 stands for
265 	 * atomic header which is the biggest possible header after BTH
266 	 */
267 	mtu = mtu - IB_GRH_BYTES - IB_BTH_BYTES - 28;
268 
269 	if (mtu >= ib_mtu_enum_to_int(IB_MTU_4096))
270 		return IB_MTU_4096;
271 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_2048))
272 		return IB_MTU_2048;
273 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_1024))
274 		return IB_MTU_1024;
275 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_512))
276 		return IB_MTU_512;
277 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_256))
278 		return IB_MTU_256;
279 	else
280 		return 0;
281 }
282 
283 static inline int iboe_get_rate(struct net_device *dev)
284 {
285 	uint64_t baudrate = dev->if_baudrate;
286 #ifdef if_baudrate_pf
287 	int exp;
288 	for (exp = dev->if_baudrate_pf; exp > 0; exp--)
289 		baudrate *= 10;
290 #endif
291 	if (baudrate >= IF_Gbps(40))
292 		return IB_RATE_40_GBPS;
293 	else if (baudrate >= IF_Gbps(30))
294 		return IB_RATE_30_GBPS;
295 	else if (baudrate >= IF_Gbps(20))
296 		return IB_RATE_20_GBPS;
297 	else if (baudrate >= IF_Gbps(10))
298 		return IB_RATE_10_GBPS;
299 	else
300 		return IB_RATE_PORT_CURRENT;
301 }
302 
303 static inline int rdma_link_local_addr(struct in6_addr *addr)
304 {
305 	if (addr->s6_addr32[0] == htonl(0xfe800000) &&
306 	    addr->s6_addr32[1] == 0)
307 		return 1;
308 
309 	return 0;
310 }
311 
312 static inline void rdma_get_ll_mac(struct in6_addr *addr, u8 *mac)
313 {
314 	memcpy(mac, &addr->s6_addr[8], 3);
315 	memcpy(mac + 3, &addr->s6_addr[13], 3);
316 	mac[0] ^= 2;
317 }
318 
319 static inline int rdma_is_multicast_addr(struct in6_addr *addr)
320 {
321 	return addr->s6_addr[0] == 0xff;
322 }
323 
324 static inline void rdma_get_mcast_mac(struct in6_addr *addr, u8 *mac)
325 {
326 	int i;
327 
328 	mac[0] = 0x33;
329 	mac[1] = 0x33;
330 	for (i = 2; i < 6; ++i)
331 		mac[i] = addr->s6_addr[i + 10];
332 }
333 
334 static inline u16 rdma_get_vlan_id(union ib_gid *dgid)
335 {
336 	u16 vid;
337 
338 	vid = dgid->raw[11] << 8 | dgid->raw[12];
339 	return vid < 0x1000 ? vid : 0xffff;
340 }
341 
342 static inline struct net_device *rdma_vlan_dev_real_dev(const struct net_device *dev)
343 {
344 	return VLAN_TRUNKDEV(__DECONST(struct ifnet *, dev));
345 }
346 
347 #endif /* IB_ADDR_H */
348