[linux-block.git] / include / rdma / ib_addr.h

/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
/*
 * Copyright (c) 2005 Voltaire Inc.  All rights reserved.
 * Copyright (c) 2005 Intel Corporation.  All rights reserved.
 */

#ifndef IB_ADDR_H
#define IB_ADDR_H

#include <linux/ethtool.h>
#include <linux/in.h>
#include <linux/in6.h>
#include <linux/if_arp.h>
#include <linux/netdevice.h>
#include <linux/inetdevice.h>
#include <linux/socket.h>
#include <linux/if_vlan.h>
#include <net/ipv6.h>
#include <net/if_inet6.h>
#include <net/ip.h>
#include <rdma/ib_verbs.h>
#include <rdma/ib_pack.h>
#include <net/net_namespace.h>

/**
 * struct rdma_dev_addr - Contains resolved RDMA hardware addresses
 * @src_dev_addr:	Source MAC address.
 * @dst_dev_addr:	Destination MAC address.
 * @broadcast:		Broadcast address of the device.
 * @dev_type:		The interface hardware type of the device.
 * @bound_dev_if:	An optional device interface index.
 * @transport:		The transport type used.
 * @net:		Network namespace containing the bound_dev_if net_dev.
 * @sgid_attr:		GID attribute to use for identified SGID
 */
struct rdma_dev_addr {
	unsigned char src_dev_addr[MAX_ADDR_LEN];
	unsigned char dst_dev_addr[MAX_ADDR_LEN];
	unsigned char broadcast[MAX_ADDR_LEN];
	unsigned short dev_type;
	int bound_dev_if;
	enum rdma_transport_type transport;
	struct net *net;
	const struct ib_gid_attr *sgid_attr;
	enum rdma_network_type network;
	int hoplimit;
};

/**
 * rdma_translate_ip - Translate a local IP address to an RDMA hardware
 *   address.
 *
 * The dev_addr->net field must be initialized.
 */
int rdma_translate_ip(const struct sockaddr *addr,
		      struct rdma_dev_addr *dev_addr);

/**
 * rdma_resolve_ip - Resolve source and destination IP addresses to
 *   RDMA hardware addresses.
 * @src_addr: An optional source address to use in the resolution.  If a
 *   source address is not provided, a usable address will be returned via
 *   the callback.
 * @dst_addr: The destination address to resolve.
 * @addr: A reference to a data location that will receive the resolved
 *   addresses.  The data location must remain valid until the callback has
 *   been invoked. The net field of the addr struct must be valid.
 * @timeout_ms: Amount of time to wait for the address resolution to complete.
 * @callback: Call invoked once address resolution has completed, timed out,
 *   or been canceled.  A status of 0 indicates success.
 * @resolve_by_gid_attr:	Resolve the ip based on the GID attribute from
 *				rdma_dev_addr.
 * @context: User-specified context associated with the call.
 */
int rdma_resolve_ip(struct sockaddr *src_addr, const struct sockaddr *dst_addr,
		    struct rdma_dev_addr *addr, unsigned long timeout_ms,
		    void (*callback)(int status, struct sockaddr *src_addr,
				     struct rdma_dev_addr *addr, void *context),
		    bool resolve_by_gid_attr, void *context);

void rdma_addr_cancel(struct rdma_dev_addr *addr);

int rdma_addr_size(const struct sockaddr *addr);
int rdma_addr_size_in6(struct sockaddr_in6 *addr);
int rdma_addr_size_kss(struct __kernel_sockaddr_storage *addr);

static inline u16 ib_addr_get_pkey(struct rdma_dev_addr *dev_addr)
{
	return ((u16)dev_addr->broadcast[8] << 8) | (u16)dev_addr->broadcast[9];
}

static inline void ib_addr_set_pkey(struct rdma_dev_addr *dev_addr, u16 pkey)
{
	dev_addr->broadcast[8] = pkey >> 8;
	dev_addr->broadcast[9] = (unsigned char) pkey;
}

static inline void ib_addr_get_mgid(struct rdma_dev_addr *dev_addr,
				    union ib_gid *gid)
{
	memcpy(gid, dev_addr->broadcast + 4, sizeof *gid);
}

static inline int rdma_addr_gid_offset(struct rdma_dev_addr *dev_addr)
{
	return dev_addr->dev_type == ARPHRD_INFINIBAND ? 4 : 0;
}

static inline u16 rdma_vlan_dev_vlan_id(const struct net_device *dev)
{
	return is_vlan_dev(dev) ? vlan_dev_vlan_id(dev) : 0xffff;
}

static inline int rdma_ip2gid(struct sockaddr *addr, union ib_gid *gid)
{
	switch (addr->sa_family) {
	case AF_INET:
		ipv6_addr_set_v4mapped(((struct sockaddr_in *)
					addr)->sin_addr.s_addr,
				       (struct in6_addr *)gid);
		break;
	case AF_INET6:
		*(struct in6_addr *)&gid->raw =
			((struct sockaddr_in6 *)addr)->sin6_addr;
		break;
	default:
		return -EINVAL;
	}
	return 0;
}

/* Important - sockaddr should be a union of sockaddr_in and sockaddr_in6 */
static inline void rdma_gid2ip(struct sockaddr *out, const union ib_gid *gid)
{
	if (ipv6_addr_v4mapped((struct in6_addr *)gid)) {
		struct sockaddr_in *out_in = (struct sockaddr_in *)out;
		memset(out_in, 0, sizeof(*out_in));
		out_in->sin_family = AF_INET;
		memcpy(&out_in->sin_addr.s_addr, gid->raw + 12, 4);
	} else {
		struct sockaddr_in6 *out_in = (struct sockaddr_in6 *)out;
		memset(out_in, 0, sizeof(*out_in));
		out_in->sin6_family = AF_INET6;
		memcpy(&out_in->sin6_addr.s6_addr, gid->raw, 16);
	}
}

/*
 * rdma_get/set_sgid/dgid() APIs are applicable to IB, and iWarp.
 * They are not applicable to RoCE.
 * RoCE GIDs are derived from the IP addresses.
 */
static inline void rdma_addr_get_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
{
	memcpy(gid, dev_addr->src_dev_addr + rdma_addr_gid_offset(dev_addr),
	       sizeof(*gid));
}

static inline void rdma_addr_set_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
{
	memcpy(dev_addr->src_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
}

static inline void rdma_addr_get_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
{
	memcpy(gid, dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), sizeof *gid);
}

static inline void rdma_addr_set_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
{
	memcpy(dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
}

static inline enum ib_mtu iboe_get_mtu(int mtu)
{
	/*
	 * Reduce IB headers from effective IBoE MTU.
	 */
	mtu = mtu - (IB_GRH_BYTES + IB_UDP_BYTES + IB_BTH_BYTES +
		     IB_EXT_XRC_BYTES + IB_EXT_ATOMICETH_BYTES +
		     IB_ICRC_BYTES);

	if (mtu >= ib_mtu_enum_to_int(IB_MTU_4096))
		return IB_MTU_4096;
	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_2048))
		return IB_MTU_2048;
	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_1024))
		return IB_MTU_1024;
	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_512))
		return IB_MTU_512;
	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_256))
		return IB_MTU_256;
	else
		return 0;
}

static inline int iboe_get_rate(struct net_device *dev)
{
	struct ethtool_link_ksettings cmd;
	int err;

	rtnl_lock();
	err = __ethtool_get_link_ksettings(dev, &cmd);
	rtnl_unlock();
	if (err)
		return IB_RATE_PORT_CURRENT;

	if (cmd.base.speed >= 40000)
		return IB_RATE_40_GBPS;
	else if (cmd.base.speed >= 30000)
		return IB_RATE_30_GBPS;
	else if (cmd.base.speed >= 20000)
		return IB_RATE_20_GBPS;
	else if (cmd.base.speed >= 10000)
		return IB_RATE_10_GBPS;
	else
		return IB_RATE_PORT_CURRENT;
}

static inline int rdma_link_local_addr(struct in6_addr *addr)
{
	if (addr->s6_addr32[0] == htonl(0xfe800000) &&
	    addr->s6_addr32[1] == 0)
		return 1;

	return 0;
}

static inline void rdma_get_ll_mac(struct in6_addr *addr, u8 *mac)
{
	memcpy(mac, &addr->s6_addr[8], 3);
	memcpy(mac + 3, &addr->s6_addr[13], 3);
	mac[0] ^= 2;
}

static inline int rdma_is_multicast_addr(struct in6_addr *addr)
{
	__be32 ipv4_addr;

	if (addr->s6_addr[0] == 0xff)
		return 1;

	ipv4_addr = addr->s6_addr32[3];
	return (ipv6_addr_v4mapped(addr) && ipv4_is_multicast(ipv4_addr));
}

static inline void rdma_get_mcast_mac(struct in6_addr *addr, u8 *mac)
{
	int i;

	mac[0] = 0x33;
	mac[1] = 0x33;
	for (i = 2; i < 6; ++i)
		mac[i] = addr->s6_addr[i + 10];
}

static inline u16 rdma_get_vlan_id(union ib_gid *dgid)
{
	u16 vid;

	vid = dgid->raw[11] << 8 | dgid->raw[12];
	return vid < 0x1000 ? vid : 0xffff;
}

static inline struct net_device *rdma_vlan_dev_real_dev(const struct net_device *dev)
{
	return is_vlan_dev(dev) ? vlan_dev_real_dev(dev) : NULL;
}

#endif /* IB_ADDR_H */
Commit	Line	Data
6bf9d8f6	1	/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
7025fcd3 SH	2	/*
	3	* Copyright (c) 2005 Voltaire Inc. All rights reserved.
	4	* Copyright (c) 2005 Intel Corporation. All rights reserved.
7025fcd3 SH	5	*/
7025fcd3 SH	6
6bf9d8f6	7	#ifndef IB_ADDR_H
7025fcd3 SH	8	#define IB_ADDR_H
7025fcd3 SH	9
cc69837f	10	#include <linux/ethtool.h>
7025fcd3 SH	11	#include <linux/in.h>
7025fcd3 SH	12	#include <linux/in6.h>
c4315d85	13	#include <linux/if_arp.h>
7025fcd3	14	#include <linux/netdevice.h>
7b85627b	15	#include <linux/inetdevice.h>
7025fcd3	16	#include <linux/socket.h>
af7bd463	17	#include <linux/if_vlan.h>
7b85627b MS	18	#include <net/ipv6.h>
	19	#include <net/if_inet6.h>
	20	#include <net/ip.h>
7025fcd3	21	#include <rdma/ib_verbs.h>
3c86aa70	22	#include <rdma/ib_pack.h>
565edd1d	23	#include <net/net_namespace.h>
7025fcd3	24
565edd1d GS	25	/**
	26	* struct rdma_dev_addr - Contains resolved RDMA hardware addresses
	27	* @src_dev_addr: Source MAC address.
	28	* @dst_dev_addr: Destination MAC address.
	29	* @broadcast: Broadcast address of the device.
	30	* @dev_type: The interface hardware type of the device.
	31	* @bound_dev_if: An optional device interface index.
	32	* @transport: The transport type used.
	33	* @net: Network namespace containing the bound_dev_if net_dev.
4ed13a5f	34	* @sgid_attr: GID attribute to use for identified SGID
565edd1d	35	*/
7025fcd3 SH	36	struct rdma_dev_addr {
	37	unsigned char src_dev_addr[MAX_ADDR_LEN];
	38	unsigned char dst_dev_addr[MAX_ADDR_LEN];
	39	unsigned char broadcast[MAX_ADDR_LEN];
c4315d85	40	unsigned short dev_type;
6266ed6e	41	int bound_dev_if;
3c86aa70	42	enum rdma_transport_type transport;
565edd1d	43	struct net *net;
4ed13a5f	44	const struct ib_gid_attr *sgid_attr;
c865f246	45	enum rdma_network_type network;
c3efe750	46	int hoplimit;
7025fcd3 SH	47	};
	48
	49	/**
	50	* rdma_translate_ip - Translate a local IP address to an RDMA hardware
	51	* address.
565edd1d GS	52	*
565edd1d GS	53	* The dev_addr->net field must be initialized.
7025fcd3	54	*/
20029832	55	int rdma_translate_ip(const struct sockaddr *addr,
575c7e58	56	struct rdma_dev_addr *dev_addr);
7025fcd3 SH	57
	58	/**
	59	* rdma_resolve_ip - Resolve source and destination IP addresses to
	60	* RDMA hardware addresses.
	61	* @src_addr: An optional source address to use in the resolution. If a
	62	* source address is not provided, a usable address will be returned via
	63	* the callback.
	64	* @dst_addr: The destination address to resolve.
	65	* @addr: A reference to a data location that will receive the resolved
	66	* addresses. The data location must remain valid until the callback has
565edd1d	67	* been invoked. The net field of the addr struct must be valid.
7025fcd3 SH	68	* @timeout_ms: Amount of time to wait for the address resolution to complete.
	69	* @callback: Call invoked once address resolution has completed, timed out,
	70	* or been canceled. A status of 0 indicates success.
0e9d2c19 PP	71	* @resolve_by_gid_attr: Resolve the ip based on the GID attribute from
0e9d2c19 PP	72	* rdma_dev_addr.
7025fcd3 SH	73	* @context: User-specified context associated with the call.
7025fcd3 SH	74	*/
2df7dba8	75	int rdma_resolve_ip(struct sockaddr src_addr, const struct sockaddr dst_addr,
dbace111	76	struct rdma_dev_addr *addr, unsigned long timeout_ms,
7025fcd3 SH	77	void (callback)(int status, struct sockaddr src_addr,
7025fcd3 SH	78	struct rdma_dev_addr addr, void context),
9549c2bd	79	bool resolve_by_gid_attr, void *context);
7025fcd3 SH	80
	81	void rdma_addr_cancel(struct rdma_dev_addr *addr);
	82
2df7dba8	83	int rdma_addr_size(const struct sockaddr *addr);
84652aef RD	84	int rdma_addr_size_in6(struct sockaddr_in6 *addr);
84652aef RD	85	int rdma_addr_size_kss(struct __kernel_sockaddr_storage *addr);
7025fcd3 SH	86
	87	static inline u16 ib_addr_get_pkey(struct rdma_dev_addr *dev_addr)
	88	{
	89	return ((u16)dev_addr->broadcast[8] << 8) \| (u16)dev_addr->broadcast[9];
	90	}
	91
	92	static inline void ib_addr_set_pkey(struct rdma_dev_addr *dev_addr, u16 pkey)
	93	{
	94	dev_addr->broadcast[8] = pkey >> 8;
	95	dev_addr->broadcast[9] = (unsigned char) pkey;
	96	}
	97
faec2f7b SH	98	static inline void ib_addr_get_mgid(struct rdma_dev_addr *dev_addr,
	99	union ib_gid *gid)
	100	{
	101	memcpy(gid, dev_addr->broadcast + 4, sizeof *gid);
	102	}
	103
6f8372b6	104	static inline int rdma_addr_gid_offset(struct rdma_dev_addr *dev_addr)
7025fcd3	105	{
6f8372b6	106	return dev_addr->dev_type == ARPHRD_INFINIBAND ? 4 : 0;
7025fcd3 SH	107	}
7025fcd3 SH	108
7b85627b	109	static inline u16 rdma_vlan_dev_vlan_id(const struct net_device *dev)
3c86aa70	110	{
d0d7b10b	111	return is_vlan_dev(dev) ? vlan_dev_vlan_id(dev) : 0xffff;
3c86aa70 EC	112	}
3c86aa70 EC	113
dd5f03be MB	114	static inline int rdma_ip2gid(struct sockaddr addr, union ib_gid gid)
	115	{
	116	switch (addr->sa_family) {
	117	case AF_INET:
	118	ipv6_addr_set_v4mapped(((struct sockaddr_in *)
	119	addr)->sin_addr.s_addr,
	120	(struct in6_addr *)gid);
	121	break;
	122	case AF_INET6:
5f8a4db7 AB	123	(struct in6_addr )&gid->raw =
5f8a4db7 AB	124	((struct sockaddr_in6 *)addr)->sin6_addr;
dd5f03be MB	125	break;
	126	default:
	127	return -EINVAL;
	128	}
	129	return 0;
	130	}
	131
	132	/* Important - sockaddr should be a union of sockaddr_in and sockaddr_in6 */
73cdaaee	133	static inline void rdma_gid2ip(struct sockaddr out, const union ib_gid gid)
dd5f03be MB	134	{
	135	if (ipv6_addr_v4mapped((struct in6_addr *)gid)) {
	136	struct sockaddr_in out_in = (struct sockaddr_in )out;
	137	memset(out_in, 0, sizeof(*out_in));
	138	out_in->sin_family = AF_INET;
	139	memcpy(&out_in->sin_addr.s_addr, gid->raw + 12, 4);
	140	} else {
	141	struct sockaddr_in6 out_in = (struct sockaddr_in6 )out;
	142	memset(out_in, 0, sizeof(*out_in));
	143	out_in->sin6_family = AF_INET6;
	144	memcpy(&out_in->sin6_addr.s6_addr, gid->raw, 16);
	145	}
dd5f03be MB	146	}
dd5f03be MB	147
15cbc519 PP	148	/*
	149	* rdma_get/set_sgid/dgid() APIs are applicable to IB, and iWarp.
	150	* They are not applicable to RoCE.
	151	* RoCE GIDs are derived from the IP addresses.
	152	*/
6f8372b6	153	static inline void rdma_addr_get_sgid(struct rdma_dev_addr dev_addr, union ib_gid gid)
7025fcd3	154	{
15cbc519 PP	155	memcpy(gid, dev_addr->src_dev_addr + rdma_addr_gid_offset(dev_addr),
15cbc519 PP	156	sizeof(*gid));
7025fcd3 SH	157	}
7025fcd3 SH	158
6f8372b6	159	static inline void rdma_addr_set_sgid(struct rdma_dev_addr dev_addr, union ib_gid gid)
7025fcd3	160	{
6f8372b6	161	memcpy(dev_addr->src_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
7025fcd3 SH	162	}
7025fcd3 SH	163
6f8372b6	164	static inline void rdma_addr_get_dgid(struct rdma_dev_addr dev_addr, union ib_gid gid)
7025fcd3	165	{
6f8372b6	166	memcpy(gid, dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), sizeof *gid);
7025fcd3 SH	167	}
7025fcd3 SH	168
6f8372b6	169	static inline void rdma_addr_set_dgid(struct rdma_dev_addr dev_addr, union ib_gid gid)
07ebafba	170	{
6f8372b6	171	memcpy(dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
07ebafba TT	172	}
07ebafba TT	173
3c86aa70 EC	174	static inline enum ib_mtu iboe_get_mtu(int mtu)
	175	{
	176	/*
99260132	177	* Reduce IB headers from effective IBoE MTU.
3c86aa70	178	*/
99260132 PP	179	mtu = mtu - (IB_GRH_BYTES + IB_UDP_BYTES + IB_BTH_BYTES +
	180	IB_EXT_XRC_BYTES + IB_EXT_ATOMICETH_BYTES +
	181	IB_ICRC_BYTES);
3c86aa70 EC	182
	183	if (mtu >= ib_mtu_enum_to_int(IB_MTU_4096))
	184	return IB_MTU_4096;
	185	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_2048))
	186	return IB_MTU_2048;
	187	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_1024))
	188	return IB_MTU_1024;
	189	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_512))
	190	return IB_MTU_512;
	191	else if (mtu >= ib_mtu_enum_to_int(IB_MTU_256))
	192	return IB_MTU_256;
	193	else
	194	return 0;
	195	}
	196
	197	static inline int iboe_get_rate(struct net_device *dev)
	198	{
17605b96	199	struct ethtool_link_ksettings cmd;
4bc71cb9	200	int err;
3c86aa70	201
4bc71cb9	202	rtnl_lock();
17605b96	203	err = __ethtool_get_link_ksettings(dev, &cmd);
4bc71cb9 JP	204	rtnl_unlock();
4bc71cb9 JP	205	if (err)
3c86aa70 EC	206	return IB_RATE_PORT_CURRENT;
3c86aa70 EC	207
17605b96	208	if (cmd.base.speed >= 40000)
3c86aa70	209	return IB_RATE_40_GBPS;
17605b96	210	else if (cmd.base.speed >= 30000)
3c86aa70	211	return IB_RATE_30_GBPS;
17605b96	212	else if (cmd.base.speed >= 20000)
3c86aa70	213	return IB_RATE_20_GBPS;
17605b96	214	else if (cmd.base.speed >= 10000)
3c86aa70 EC	215	return IB_RATE_10_GBPS;
	216	else
	217	return IB_RATE_PORT_CURRENT;
	218	}
	219
	220	static inline int rdma_link_local_addr(struct in6_addr *addr)
	221	{
	222	if (addr->s6_addr32[0] == htonl(0xfe800000) &&
	223	addr->s6_addr32[1] == 0)
	224	return 1;
	225
	226	return 0;
	227	}
	228
	229	static inline void rdma_get_ll_mac(struct in6_addr addr, u8 mac)
	230	{
	231	memcpy(mac, &addr->s6_addr[8], 3);
	232	memcpy(mac + 3, &addr->s6_addr[13], 3);
	233	mac[0] ^= 2;
	234	}
	235
	236	static inline int rdma_is_multicast_addr(struct in6_addr *addr)
	237	{
1c3aea2b	238	__be32 ipv4_addr;
be1d325a NO	239
	240	if (addr->s6_addr[0] == 0xff)
	241	return 1;
	242
1c3aea2b	243	ipv4_addr = addr->s6_addr32[3];
be1d325a	244	return (ipv6_addr_v4mapped(addr) && ipv4_is_multicast(ipv4_addr));
3c86aa70 EC	245	}
	246
	247	static inline void rdma_get_mcast_mac(struct in6_addr addr, u8 mac)
	248	{
	249	int i;
	250
	251	mac[0] = 0x33;
	252	mac[1] = 0x33;
	253	for (i = 2; i < 6; ++i)
	254	mac[i] = addr->s6_addr[i + 10];
	255	}
	256
af7bd463 EC	257	static inline u16 rdma_get_vlan_id(union ib_gid *dgid)
	258	{
	259	u16 vid;
	260
	261	vid = dgid->raw[11] << 8 \| dgid->raw[12];
	262	return vid < 0x1000 ? vid : 0xffff;
	263	}
	264
	265	static inline struct net_device rdma_vlan_dev_real_dev(const struct net_device dev)
	266	{
d0d7b10b	267	return is_vlan_dev(dev) ? vlan_dev_real_dev(dev) : NULL;
af7bd463 EC	268	}
af7bd463 EC	269
7025fcd3	270	#endif /* IB_ADDR_H */