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