xref: /linux-6.15/include/rdma/ib_addr.h (revision 0e9d2c19)
1 /*
2  * Copyright (c) 2005 Voltaire Inc.  All rights reserved.
3  * Copyright (c) 2005 Intel Corporation.  All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * OpenIB.org BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33 
34 #if !defined(IB_ADDR_H)
35 #define IB_ADDR_H
36 
37 #include <linux/in.h>
38 #include <linux/in6.h>
39 #include <linux/if_arp.h>
40 #include <linux/netdevice.h>
41 #include <linux/inetdevice.h>
42 #include <linux/socket.h>
43 #include <linux/if_vlan.h>
44 #include <net/ipv6.h>
45 #include <net/if_inet6.h>
46 #include <net/ip.h>
47 #include <rdma/ib_verbs.h>
48 #include <rdma/ib_pack.h>
49 #include <net/ipv6.h>
50 #include <net/net_namespace.h>
51 
52 /**
53  * struct rdma_dev_addr - Contains resolved RDMA hardware addresses
54  * @src_dev_addr:	Source MAC address.
55  * @dst_dev_addr:	Destination MAC address.
56  * @broadcast:		Broadcast address of the device.
57  * @dev_type:		The interface hardware type of the device.
58  * @bound_dev_if:	An optional device interface index.
59  * @transport:		The transport type used.
60  * @net:		Network namespace containing the bound_dev_if net_dev.
61  * @sgid_attr:		GID attribute to use for identified SGID
62  */
63 struct rdma_dev_addr {
64 	unsigned char src_dev_addr[MAX_ADDR_LEN];
65 	unsigned char dst_dev_addr[MAX_ADDR_LEN];
66 	unsigned char broadcast[MAX_ADDR_LEN];
67 	unsigned short dev_type;
68 	int bound_dev_if;
69 	enum rdma_transport_type transport;
70 	struct net *net;
71 	const struct ib_gid_attr *sgid_attr;
72 	enum rdma_network_type network;
73 	int hoplimit;
74 };
75 
76 /**
77  * rdma_translate_ip - Translate a local IP address to an RDMA hardware
78  *   address.
79  *
80  * The dev_addr->net field must be initialized.
81  */
82 int rdma_translate_ip(const struct sockaddr *addr,
83 		      struct rdma_dev_addr *dev_addr);
84 
85 /**
86  * rdma_resolve_ip - Resolve source and destination IP addresses to
87  *   RDMA hardware addresses.
88  * @src_addr: An optional source address to use in the resolution.  If a
89  *   source address is not provided, a usable address will be returned via
90  *   the callback.
91  * @dst_addr: The destination address to resolve.
92  * @addr: A reference to a data location that will receive the resolved
93  *   addresses.  The data location must remain valid until the callback has
94  *   been invoked. The net field of the addr struct must be valid.
95  * @timeout_ms: Amount of time to wait for the address resolution to complete.
96  * @callback: Call invoked once address resolution has completed, timed out,
97  *   or been canceled.  A status of 0 indicates success.
98  * @resolve_by_gid_attr:	Resolve the ip based on the GID attribute from
99  *				rdma_dev_addr.
100  * @context: User-specified context associated with the call.
101  */
102 int rdma_resolve_ip(struct sockaddr *src_addr, const struct sockaddr *dst_addr,
103 		    struct rdma_dev_addr *addr, int timeout_ms,
104 		    void (*callback)(int status, struct sockaddr *src_addr,
105 				     struct rdma_dev_addr *addr, void *context),
106 		    bool resolve_by_gid_attr,
107 		    void *context);
108 
109 void rdma_addr_cancel(struct rdma_dev_addr *addr);
110 
111 int rdma_addr_size(const struct sockaddr *addr);
112 int rdma_addr_size_in6(struct sockaddr_in6 *addr);
113 int rdma_addr_size_kss(struct __kernel_sockaddr_storage *addr);
114 
115 static inline u16 ib_addr_get_pkey(struct rdma_dev_addr *dev_addr)
116 {
117 	return ((u16)dev_addr->broadcast[8] << 8) | (u16)dev_addr->broadcast[9];
118 }
119 
120 static inline void ib_addr_set_pkey(struct rdma_dev_addr *dev_addr, u16 pkey)
121 {
122 	dev_addr->broadcast[8] = pkey >> 8;
123 	dev_addr->broadcast[9] = (unsigned char) pkey;
124 }
125 
126 static inline void ib_addr_get_mgid(struct rdma_dev_addr *dev_addr,
127 				    union ib_gid *gid)
128 {
129 	memcpy(gid, dev_addr->broadcast + 4, sizeof *gid);
130 }
131 
132 static inline int rdma_addr_gid_offset(struct rdma_dev_addr *dev_addr)
133 {
134 	return dev_addr->dev_type == ARPHRD_INFINIBAND ? 4 : 0;
135 }
136 
137 static inline u16 rdma_vlan_dev_vlan_id(const struct net_device *dev)
138 {
139 	return is_vlan_dev(dev) ? vlan_dev_vlan_id(dev) : 0xffff;
140 }
141 
142 static inline int rdma_ip2gid(struct sockaddr *addr, union ib_gid *gid)
143 {
144 	switch (addr->sa_family) {
145 	case AF_INET:
146 		ipv6_addr_set_v4mapped(((struct sockaddr_in *)
147 					addr)->sin_addr.s_addr,
148 				       (struct in6_addr *)gid);
149 		break;
150 	case AF_INET6:
151 		*(struct in6_addr *)&gid->raw =
152 			((struct sockaddr_in6 *)addr)->sin6_addr;
153 		break;
154 	default:
155 		return -EINVAL;
156 	}
157 	return 0;
158 }
159 
160 /* Important - sockaddr should be a union of sockaddr_in and sockaddr_in6 */
161 static inline void rdma_gid2ip(struct sockaddr *out, const union ib_gid *gid)
162 {
163 	if (ipv6_addr_v4mapped((struct in6_addr *)gid)) {
164 		struct sockaddr_in *out_in = (struct sockaddr_in *)out;
165 		memset(out_in, 0, sizeof(*out_in));
166 		out_in->sin_family = AF_INET;
167 		memcpy(&out_in->sin_addr.s_addr, gid->raw + 12, 4);
168 	} else {
169 		struct sockaddr_in6 *out_in = (struct sockaddr_in6 *)out;
170 		memset(out_in, 0, sizeof(*out_in));
171 		out_in->sin6_family = AF_INET6;
172 		memcpy(&out_in->sin6_addr.s6_addr, gid->raw, 16);
173 	}
174 }
175 
176 /*
177  * rdma_get/set_sgid/dgid() APIs are applicable to IB, and iWarp.
178  * They are not applicable to RoCE.
179  * RoCE GIDs are derived from the IP addresses.
180  */
181 static inline void rdma_addr_get_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
182 {
183 	memcpy(gid, dev_addr->src_dev_addr + rdma_addr_gid_offset(dev_addr),
184 	       sizeof(*gid));
185 }
186 
187 static inline void rdma_addr_set_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
188 {
189 	memcpy(dev_addr->src_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
190 }
191 
192 static inline void rdma_addr_get_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
193 {
194 	memcpy(gid, dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), sizeof *gid);
195 }
196 
197 static inline void rdma_addr_set_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
198 {
199 	memcpy(dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
200 }
201 
202 static inline enum ib_mtu iboe_get_mtu(int mtu)
203 {
204 	/*
205 	 * Reduce IB headers from effective IBoE MTU.
206 	 */
207 	mtu = mtu - (IB_GRH_BYTES + IB_UDP_BYTES + IB_BTH_BYTES +
208 		     IB_EXT_XRC_BYTES + IB_EXT_ATOMICETH_BYTES +
209 		     IB_ICRC_BYTES);
210 
211 	if (mtu >= ib_mtu_enum_to_int(IB_MTU_4096))
212 		return IB_MTU_4096;
213 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_2048))
214 		return IB_MTU_2048;
215 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_1024))
216 		return IB_MTU_1024;
217 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_512))
218 		return IB_MTU_512;
219 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_256))
220 		return IB_MTU_256;
221 	else
222 		return 0;
223 }
224 
225 static inline int iboe_get_rate(struct net_device *dev)
226 {
227 	struct ethtool_link_ksettings cmd;
228 	int err;
229 
230 	rtnl_lock();
231 	err = __ethtool_get_link_ksettings(dev, &cmd);
232 	rtnl_unlock();
233 	if (err)
234 		return IB_RATE_PORT_CURRENT;
235 
236 	if (cmd.base.speed >= 40000)
237 		return IB_RATE_40_GBPS;
238 	else if (cmd.base.speed >= 30000)
239 		return IB_RATE_30_GBPS;
240 	else if (cmd.base.speed >= 20000)
241 		return IB_RATE_20_GBPS;
242 	else if (cmd.base.speed >= 10000)
243 		return IB_RATE_10_GBPS;
244 	else
245 		return IB_RATE_PORT_CURRENT;
246 }
247 
248 static inline int rdma_link_local_addr(struct in6_addr *addr)
249 {
250 	if (addr->s6_addr32[0] == htonl(0xfe800000) &&
251 	    addr->s6_addr32[1] == 0)
252 		return 1;
253 
254 	return 0;
255 }
256 
257 static inline void rdma_get_ll_mac(struct in6_addr *addr, u8 *mac)
258 {
259 	memcpy(mac, &addr->s6_addr[8], 3);
260 	memcpy(mac + 3, &addr->s6_addr[13], 3);
261 	mac[0] ^= 2;
262 }
263 
264 static inline int rdma_is_multicast_addr(struct in6_addr *addr)
265 {
266 	__be32 ipv4_addr;
267 
268 	if (addr->s6_addr[0] == 0xff)
269 		return 1;
270 
271 	ipv4_addr = addr->s6_addr32[3];
272 	return (ipv6_addr_v4mapped(addr) && ipv4_is_multicast(ipv4_addr));
273 }
274 
275 static inline void rdma_get_mcast_mac(struct in6_addr *addr, u8 *mac)
276 {
277 	int i;
278 
279 	mac[0] = 0x33;
280 	mac[1] = 0x33;
281 	for (i = 2; i < 6; ++i)
282 		mac[i] = addr->s6_addr[i + 10];
283 }
284 
285 static inline u16 rdma_get_vlan_id(union ib_gid *dgid)
286 {
287 	u16 vid;
288 
289 	vid = dgid->raw[11] << 8 | dgid->raw[12];
290 	return vid < 0x1000 ? vid : 0xffff;
291 }
292 
293 static inline struct net_device *rdma_vlan_dev_real_dev(const struct net_device *dev)
294 {
295 	return is_vlan_dev(dev) ? vlan_dev_real_dev(dev) : NULL;
296 }
297 
298 #endif /* IB_ADDR_H */
299