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