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