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