xref: /freebsd/sys/ofed/include/rdma/ib_addr.h (revision aacb0377421485e27c662c7d2962d6c86666c6ae)
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 #ifndef 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 <rdma/ib_verbs.h>
45 #include <rdma/ib_pack.h>
46 #include <net/if_inet6.h>
47 #include <net/ipv6.h>
48 
49 struct rdma_addr_client {
50 	atomic_t refcount;
51 	struct completion comp;
52 };
53 
54 /**
55  * rdma_addr_register_client - Register an address client.
56  */
57 void rdma_addr_register_client(struct rdma_addr_client *client);
58 
59 /**
60  * rdma_addr_unregister_client - Deregister an address client.
61  * @client: Client object to deregister.
62  */
63 void rdma_addr_unregister_client(struct rdma_addr_client *client);
64 
65 struct rdma_dev_addr {
66 	unsigned char src_dev_addr[MAX_ADDR_LEN];
67 	unsigned char dst_dev_addr[MAX_ADDR_LEN];
68 	unsigned char broadcast[MAX_ADDR_LEN];
69 	unsigned short dev_type;
70 	int bound_dev_if;
71 	enum rdma_transport_type transport;
72 };
73 
74 /**
75  * rdma_translate_ip - Translate a local IP address to an RDMA hardware
76  *   address.
77  */
78 int rdma_translate_ip(struct sockaddr *addr, struct rdma_dev_addr *dev_addr,
79 		      u16 *vlan_id);
80 
81 /**
82  * rdma_resolve_ip - Resolve source and destination IP addresses to
83  *   RDMA hardware addresses.
84  * @client: Address client associated with request.
85  * @src_addr: An optional source address to use in the resolution.  If a
86  *   source address is not provided, a usable address will be returned via
87  *   the callback.
88  * @dst_addr: The destination address to resolve.
89  * @addr: A reference to a data location that will receive the resolved
90  *   addresses.  The data location must remain valid until the callback has
91  *   been invoked.
92  * @timeout_ms: Amount of time to wait for the address resolution to complete.
93  * @callback: Call invoked once address resolution has completed, timed out,
94  *   or been canceled.  A status of 0 indicates success.
95  * @context: User-specified context associated with the call.
96  */
97 int rdma_resolve_ip(struct rdma_addr_client *client,
98 		    struct sockaddr *src_addr, struct sockaddr *dst_addr,
99 		    struct rdma_dev_addr *addr, int timeout_ms,
100 		    void (*callback)(int status, struct sockaddr *src_addr,
101 				     struct rdma_dev_addr *addr, void *context),
102 		    void *context);
103 
104 void rdma_addr_cancel(struct rdma_dev_addr *addr);
105 
106 int rdma_copy_addr(struct rdma_dev_addr *dev_addr, struct net_device *dev,
107 	      const unsigned char *dst_dev_addr);
108 int rdma_addr_find_smac_by_sgid(union ib_gid *sgid, u8 *smac, u16 *vlan_id,
109 				u32 scope_id);
110 int rdma_addr_find_dmac_by_grh(union ib_gid *sgid, union ib_gid *dgid, u8 *smac,
111 			       u16 *vlan_id, u32 scope_id);
112 
113 static inline int ip_addr_size(struct sockaddr *addr)
114 {
115 	return addr->sa_family == AF_INET6 ?
116 	       sizeof(struct sockaddr_in6) : sizeof(struct sockaddr_in);
117 }
118 
119 static inline u16 ib_addr_get_pkey(struct rdma_dev_addr *dev_addr)
120 {
121 	return ((u16)dev_addr->broadcast[8] << 8) | (u16)dev_addr->broadcast[9];
122 }
123 
124 static inline void ib_addr_set_pkey(struct rdma_dev_addr *dev_addr, u16 pkey)
125 {
126 	dev_addr->broadcast[8] = pkey >> 8;
127 	dev_addr->broadcast[9] = (unsigned char) pkey;
128 }
129 
130 static inline void ib_addr_get_mgid(struct rdma_dev_addr *dev_addr,
131 				    union ib_gid *gid)
132 {
133 	memcpy(gid, dev_addr->broadcast + 4, sizeof *gid);
134 }
135 
136 static inline int rdma_addr_gid_offset(struct rdma_dev_addr *dev_addr)
137 {
138 	return dev_addr->dev_type == ARPHRD_INFINIBAND ? 4 : 0;
139 }
140 
141 static inline u16 rdma_vlan_dev_vlan_id(const struct net_device *dev)
142 {
143 	uint16_t tag;
144 
145 	if (VLAN_TAG(__DECONST(struct ifnet *, dev), &tag) != 0)
146 		return 0xffff;
147 	return tag;
148 }
149 
150 static inline int rdma_ip2gid(struct sockaddr *addr, union ib_gid *gid)
151 {
152 	switch (addr->sa_family) {
153 	case AF_INET:
154 		ipv6_addr_set_v4mapped(((struct sockaddr_in *)addr)->sin_addr.s_addr,
155 				       (struct in6_addr *)gid);
156 		break;
157 	case AF_INET6:
158 		memcpy(gid->raw, &((struct sockaddr_in6 *)addr)->sin6_addr,
159 				   16);
160 		/* make sure scope ID gets zeroed inside GID */
161 		if (IN6_IS_SCOPE_LINKLOCAL((struct in6_addr *)gid->raw) ||
162 		    IN6_IS_ADDR_MC_INTFACELOCAL((struct in6_addr *)gid->raw)) {
163 			gid->raw[2] = 0;
164 			gid->raw[3] = 0;
165 		}
166 		break;
167 	default:
168 		return -EINVAL;
169 	}
170 	return 0;
171 }
172 
173 /* Important - sockaddr should be a union of sockaddr_in and sockaddr_in6 */
174 static inline int rdma_gid2ip(struct sockaddr *out, union ib_gid *gid,
175     uint32_t scope_id)
176 {
177 	if (ipv6_addr_v4mapped((struct in6_addr *)gid)) {
178 		struct sockaddr_in *out_in = (struct sockaddr_in *)out;
179 		memset(out_in, 0, sizeof(*out_in));
180 		out_in->sin_len = sizeof(*out_in);
181 		out_in->sin_family = AF_INET;
182 		memcpy(&out_in->sin_addr.s_addr, gid->raw + 12, 4);
183 	} else {
184 		struct sockaddr_in6 *out_in = (struct sockaddr_in6 *)out;
185 		memset(out_in, 0, sizeof(*out_in));
186 		out_in->sin6_len = sizeof(*out_in);
187 		out_in->sin6_family = AF_INET6;
188 		memcpy(&out_in->sin6_addr.s6_addr, gid->raw, 16);
189 		if (scope_id < 256 &&
190 		    IN6_IS_SCOPE_LINKLOCAL(&out_in->sin6_addr))
191 			out_in->sin6_scope_id = scope_id;
192 	}
193 	return 0;
194 }
195 
196 u32 rdma_get_ipv6_scope_id(struct ib_device *ib, u8 port_num);
197 
198 /* This func is called only in loopback ip address (127.0.0.1)
199  * case in which sgid is not relevant
200  */
201 static inline void iboe_addr_get_sgid(struct rdma_dev_addr *dev_addr,
202 				      union ib_gid *gid)
203 {
204 }
205 
206 static inline void rdma_addr_get_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
207 {
208 	if (dev_addr->transport == RDMA_TRANSPORT_IB &&
209 	    dev_addr->dev_type != ARPHRD_INFINIBAND)
210 		iboe_addr_get_sgid(dev_addr, gid);
211 	else
212 		memcpy(gid, dev_addr->src_dev_addr +
213 		       rdma_addr_gid_offset(dev_addr), sizeof *gid);
214 }
215 
216 static inline void rdma_addr_set_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
217 {
218 	memcpy(dev_addr->src_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
219 }
220 
221 static inline void rdma_addr_get_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
222 {
223 	memcpy(gid, dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), sizeof *gid);
224 }
225 
226 static inline void rdma_addr_set_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
227 {
228 	memcpy(dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
229 }
230 
231 static inline enum ib_mtu iboe_get_mtu(int mtu)
232 {
233 	/*
234 	 * reduce IB headers from effective IBoE MTU. 28 stands for
235 	 * atomic header which is the biggest possible header after BTH
236 	 */
237 	mtu = mtu - IB_GRH_BYTES - IB_BTH_BYTES - 28;
238 
239 	if (mtu >= ib_mtu_enum_to_int(IB_MTU_4096))
240 		return IB_MTU_4096;
241 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_2048))
242 		return IB_MTU_2048;
243 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_1024))
244 		return IB_MTU_1024;
245 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_512))
246 		return IB_MTU_512;
247 	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_256))
248 		return IB_MTU_256;
249 	else
250 		return 0;
251 }
252 
253 static inline int iboe_get_rate(struct net_device *dev)
254 {
255 	if (dev->if_baudrate >= IF_Gbps(40))
256 		return IB_RATE_40_GBPS;
257 	else if (dev->if_baudrate >= IF_Gbps(30))
258 		return IB_RATE_30_GBPS;
259 	else if (dev->if_baudrate >= IF_Gbps(20))
260 		return IB_RATE_20_GBPS;
261 	else if (dev->if_baudrate >= IF_Gbps(10))
262 		return IB_RATE_10_GBPS;
263 	else
264 		return IB_RATE_PORT_CURRENT;
265 }
266 
267 static inline int rdma_link_local_addr(struct in6_addr *addr)
268 {
269 	if (addr->s6_addr32[0] == htonl(0xfe800000) &&
270 	    addr->s6_addr32[1] == 0)
271 		return 1;
272 
273 	return 0;
274 }
275 
276 static inline void rdma_get_ll_mac(struct in6_addr *addr, u8 *mac)
277 {
278 	memcpy(mac, &addr->s6_addr[8], 3);
279 	memcpy(mac + 3, &addr->s6_addr[13], 3);
280 	mac[0] ^= 2;
281 }
282 
283 static inline int rdma_is_multicast_addr(struct in6_addr *addr)
284 {
285 	return addr->s6_addr[0] == 0xff;
286 }
287 
288 static inline void resolve_mcast_mac(struct in6_addr *addr, u8 *mac)
289 {
290 	if (addr->s6_addr[0] != 0xff)
291 		return;
292 
293 #ifdef DUAL_MODE_MCAST_MAC
294 	if (addr->s6_addr[1] == 0x0e) /* IPv4 */
295 		ip_eth_mc_map(addr->s6_addr32[3], mac);
296 	else
297 #endif
298 		ipv6_eth_mc_map(addr, mac);
299 }
300 
301 
302 static inline void rdma_get_mcast_mac(struct in6_addr *addr, u8 *mac)
303 {
304 	int i;
305 
306 	mac[0] = 0x33;
307 	mac[1] = 0x33;
308 	for (i = 2; i < 6; ++i)
309 		mac[i] = addr->s6_addr[i + 10];
310 }
311 
312 static inline u16 rdma_get_vlan_id(union ib_gid *dgid)
313 {
314 	u16 vid;
315 
316 	vid = dgid->raw[11] << 8 | dgid->raw[12];
317 	return vid < 0x1000 ? vid  : 0xffff;
318 }
319 
320 static inline struct net_device *rdma_vlan_dev_real_dev(const struct net_device *dev)
321 {
322 	return VLAN_TRUNKDEV(__DECONST(struct ifnet *, dev));
323 }
324 
325 #endif /* IB_ADDR_H */
326