[linux-block.git] / include / net / if_inet6.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *	inet6 interface/address list definitions
 *	Linux INET6 implementation 
 *
 *	Authors:
 *	Pedro Roque		<roque@di.fc.ul.pt>	
 */

#ifndef _NET_IF_INET6_H
#define _NET_IF_INET6_H

#include <net/snmp.h>
#include <linux/ipv6.h>
#include <linux/refcount.h>

/* inet6_dev.if_flags */

#define IF_RA_OTHERCONF	0x80
#define IF_RA_MANAGED	0x40
#define IF_RA_RCVD	0x20
#define IF_RS_SENT	0x10
#define IF_READY	0x80000000

enum {
	INET6_IFADDR_STATE_PREDAD,
	INET6_IFADDR_STATE_DAD,
	INET6_IFADDR_STATE_POSTDAD,
	INET6_IFADDR_STATE_ERRDAD,
	INET6_IFADDR_STATE_DEAD,
};

struct inet6_ifaddr {
	struct in6_addr		addr;
	__u32			prefix_len;
	__u32			rt_priority;

	/* In seconds, relative to tstamp. Expiry is at tstamp + HZ * lft. */
	__u32			valid_lft;
	__u32			prefered_lft;
	refcount_t		refcnt;
	spinlock_t		lock;

	int			state;

	__u32			flags;
	__u8			dad_probes;
	__u8			stable_privacy_retry;

	__u16			scope;
	__u64			dad_nonce;

	unsigned long		cstamp;	/* created timestamp */
	unsigned long		tstamp; /* updated timestamp */

	struct delayed_work	dad_work;

	struct inet6_dev	*idev;
	struct fib6_info	*rt;

	struct hlist_node	addr_lst;
	struct list_head	if_list;
	/*
	 * Used to safely traverse idev->addr_list in process context
	 * if the idev->lock needed to protect idev->addr_list cannot be held.
	 * In that case, add the items to this list temporarily and iterate
	 * without holding idev->lock.
	 * See addrconf_ifdown and dev_forward_change.
	 */
	struct list_head	if_list_aux;

	struct list_head	tmp_list;
	struct inet6_ifaddr	*ifpub;
	int			regen_count;

	bool			tokenized;

	u8			ifa_proto;

	struct rcu_head		rcu;
	struct in6_addr		peer_addr;
};

struct ip6_sf_socklist {
	unsigned int		sl_max;
	unsigned int		sl_count;
	struct rcu_head		rcu;
	struct in6_addr		sl_addr[] __counted_by(sl_max);
};

#define IP6_SFBLOCK	10	/* allocate this many at once */

struct ipv6_mc_socklist {
	struct in6_addr		addr;
	int			ifindex;
	unsigned int		sfmode;		/* MCAST_{INCLUDE,EXCLUDE} */
	struct ipv6_mc_socklist __rcu *next;
	struct ip6_sf_socklist	__rcu *sflist;
	struct rcu_head		rcu;
};

struct ip6_sf_list {
	struct ip6_sf_list __rcu *sf_next;
	struct in6_addr		sf_addr;
	unsigned long		sf_count[2];	/* include/exclude counts */
	unsigned char		sf_gsresp;	/* include in g & s response? */
	unsigned char		sf_oldin;	/* change state */
	unsigned char		sf_crcount;	/* retrans. left to send */
	struct rcu_head		rcu;
};

#define MAF_TIMER_RUNNING	0x01
#define MAF_LAST_REPORTER	0x02
#define MAF_LOADED		0x04
#define MAF_NOREPORT		0x08
#define MAF_GSQUERY		0x10

struct ifmcaddr6 {
	struct in6_addr		mca_addr;
	struct inet6_dev	*idev;
	struct ifmcaddr6	__rcu *next;
	struct ip6_sf_list	__rcu *mca_sources;
	struct ip6_sf_list	__rcu *mca_tomb;
	unsigned int		mca_sfmode;
	unsigned char		mca_crcount;
	unsigned long		mca_sfcount[2];
	struct delayed_work	mca_work;
	unsigned int		mca_flags;
	int			mca_users;
	refcount_t		mca_refcnt;
	unsigned long		mca_cstamp;
	unsigned long		mca_tstamp;
	struct rcu_head		rcu;
};

/* Anycast stuff */

struct ipv6_ac_socklist {
	struct in6_addr		acl_addr;
	int			acl_ifindex;
	struct ipv6_ac_socklist *acl_next;
};

struct ifacaddr6 {
	struct in6_addr		aca_addr;
	struct fib6_info	*aca_rt;
	struct ifacaddr6	*aca_next;
	struct hlist_node	aca_addr_lst;
	int			aca_users;
	refcount_t		aca_refcnt;
	unsigned long		aca_cstamp;
	unsigned long		aca_tstamp;
	struct rcu_head		rcu;
};

#define	IFA_HOST	IPV6_ADDR_LOOPBACK
#define	IFA_LINK	IPV6_ADDR_LINKLOCAL
#define	IFA_SITE	IPV6_ADDR_SITELOCAL

struct ipv6_devstat {
	struct proc_dir_entry	*proc_dir_entry;
	DEFINE_SNMP_STAT(struct ipstats_mib, ipv6);
	DEFINE_SNMP_STAT_ATOMIC(struct icmpv6_mib_device, icmpv6dev);
	DEFINE_SNMP_STAT_ATOMIC(struct icmpv6msg_mib_device, icmpv6msgdev);
};

struct inet6_dev {
	struct net_device	*dev;
	netdevice_tracker	dev_tracker;

	struct list_head	addr_list;

	struct ifmcaddr6	__rcu *mc_list;
	struct ifmcaddr6	__rcu *mc_tomb;

	unsigned char		mc_qrv;		/* Query Robustness Variable */
	unsigned char		mc_gq_running;
	unsigned char		mc_ifc_count;
	unsigned char		mc_dad_count;

	unsigned long		mc_v1_seen;	/* Max time we stay in MLDv1 mode */
	unsigned long		mc_qi;		/* Query Interval */
	unsigned long		mc_qri;		/* Query Response Interval */
	unsigned long		mc_maxdelay;

	struct delayed_work	mc_gq_work;	/* general query work */
	struct delayed_work	mc_ifc_work;	/* interface change work */
	struct delayed_work	mc_dad_work;	/* dad complete mc work */
	struct delayed_work	mc_query_work;	/* mld query work */
	struct delayed_work	mc_report_work;	/* mld report work */

	struct sk_buff_head	mc_query_queue;		/* mld query queue */
	struct sk_buff_head	mc_report_queue;	/* mld report queue */

	spinlock_t		mc_query_lock;	/* mld query queue lock */
	spinlock_t		mc_report_lock;	/* mld query report lock */
	struct mutex		mc_lock;	/* mld global lock */

	struct ifacaddr6	*ac_list;
	rwlock_t		lock;
	refcount_t		refcnt;
	__u32			if_flags;
	int			dead;

	u32			desync_factor;
	struct list_head	tempaddr_list;

	struct in6_addr		token;

	struct neigh_parms	*nd_parms;
	struct ipv6_devconf	cnf;
	struct ipv6_devstat	stats;

	struct timer_list	rs_timer;
	__s32			rs_interval;	/* in jiffies */
	__u8			rs_probes;

	unsigned long		tstamp; /* ipv6InterfaceTable update timestamp */
	struct rcu_head		rcu;

	unsigned int		ra_mtu;
};

static inline void ipv6_eth_mc_map(const struct in6_addr *addr, char *buf)
{
	/*
	 *	+-------+-------+-------+-------+-------+-------+
	 *      |   33  |   33  | DST13 | DST14 | DST15 | DST16 |
	 *      +-------+-------+-------+-------+-------+-------+
	 */

	buf[0]= 0x33;
	buf[1]= 0x33;

	memcpy(buf + 2, &addr->s6_addr32[3], sizeof(__u32));
}

static inline void ipv6_arcnet_mc_map(const struct in6_addr *addr, char *buf)
{
	buf[0] = 0x00;
}

static inline void ipv6_ib_mc_map(const struct in6_addr *addr,
				  const unsigned char *broadcast, char *buf)
{
	unsigned char scope = broadcast[5] & 0xF;

	buf[0]  = 0;		/* Reserved */
	buf[1]  = 0xff;		/* Multicast QPN */
	buf[2]  = 0xff;
	buf[3]  = 0xff;
	buf[4]  = 0xff;
	buf[5]  = 0x10 | scope;	/* scope from broadcast address */
	buf[6]  = 0x60;		/* IPv6 signature */
	buf[7]  = 0x1b;
	buf[8]  = broadcast[8];	/* P_Key */
	buf[9]  = broadcast[9];
	memcpy(buf + 10, addr->s6_addr + 6, 10);
}

static inline int ipv6_ipgre_mc_map(const struct in6_addr *addr,
				    const unsigned char *broadcast, char *buf)
{
	if ((broadcast[0] | broadcast[1] | broadcast[2] | broadcast[3]) != 0) {
		memcpy(buf, broadcast, 4);
	} else {
		/* v4mapped? */
		if ((addr->s6_addr32[0] | addr->s6_addr32[1] |
		     (addr->s6_addr32[2] ^ htonl(0x0000ffff))) != 0)
			return -EINVAL;
		memcpy(buf, &addr->s6_addr32[3], 4);
	}
	return 0;
}

#endif
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	/*
	3	* inet6 interface/address list definitions
	4	* Linux INET6 implementation
	5	*
	6	* Authors:
	7	* Pedro Roque <roque@di.fc.ul.pt>
1da177e4 LT	8	*/
	9
	10	#ifndef _NET_IF_INET6_H
	11	#define _NET_IF_INET6_H
	12
	13	#include <net/snmp.h>
	14	#include <linux/ipv6.h>
1be92460	15	#include <linux/refcount.h>
1da177e4 LT	16
	17	/* inet6_dev.if_flags */
	18
	19	#define IF_RA_OTHERCONF 0x80
	20	#define IF_RA_MANAGED 0x40
	21	#define IF_RA_RCVD 0x20
	22	#define IF_RS_SENT 0x10
3c21edbd	23	#define IF_READY 0x80000000
1da177e4	24
e9d3e084	25	enum {
c15b1cca	26	INET6_IFADDR_STATE_PREDAD,
e9d3e084 HX	27	INET6_IFADDR_STATE_DAD,
e9d3e084 HX	28	INET6_IFADDR_STATE_POSTDAD,
c15b1cca	29	INET6_IFADDR_STATE_ERRDAD,
e9d3e084 HX	30	INET6_IFADDR_STATE_DEAD,
	31	};
	32
fd2c3ef7	33	struct inet6_ifaddr {
1da177e4 LT	34	struct in6_addr addr;
1da177e4 LT	35	__u32 prefix_len;
8308f3ff	36	__u32 rt_priority;
8e8e676d	37
76f793e3	38	/* In seconds, relative to tstamp. Expiry is at tstamp + HZ * lft. */
1da177e4 LT	39	__u32 valid_lft;
1da177e4 LT	40	__u32 prefered_lft;
271201c0	41	refcount_t refcnt;
1da177e4	42	spinlock_t lock;
e9d3e084 HX	43
e9d3e084 HX	44	int state;
1da177e4	45
479840ff	46	__u32 flags;
b7b1bfce	47	__u8 dad_probes;
5f40ef77	48	__u8 stable_privacy_retry;
1da177e4 LT	49
1da177e4 LT	50	__u16 scope;
adc176c5	51	__u64 dad_nonce;
1da177e4	52
04ec5cfc RK	53	unsigned long cstamp; /* created timestamp */
	54	unsigned long tstamp; /* updated timestamp */
	55
c15b1cca	56	struct delayed_work dad_work;
1da177e4 LT	57
1da177e4 LT	58	struct inet6_dev *idev;
8d1c802b	59	struct fib6_info *rt;
1da177e4	60
c2e21293	61	struct hlist_node addr_lst;
502a2ffd	62	struct list_head if_list;
51454ea4 ND	63	/*
	64	* Used to safely traverse idev->addr_list in process context
	65	* if the idev->lock needed to protect idev->addr_list cannot be held.
	66	* In that case, add the items to this list temporarily and iterate
	67	* without holding idev->lock.
	68	* See addrconf_ifdown and dev_forward_change.
	69	*/
	70	struct list_head if_list_aux;
1da177e4	71
372e6c8f	72	struct list_head tmp_list;
1da177e4 LT	73	struct inet6_ifaddr *ifpub;
1da177e4 LT	74	int regen_count;
5d9efa7e	75
617fe29d DB	76	bool tokenized;
617fe29d DB	77
47f0bd50 JL	78	u8 ifa_proto;
47f0bd50 JL	79
5c578aed	80	struct rcu_head rcu;
caeaba79	81	struct in6_addr peer_addr;
1da177e4 LT	82	};
1da177e4 LT	83
fd2c3ef7	84	struct ip6_sf_socklist {
1da177e4 LT	85	unsigned int sl_max;
1da177e4 LT	86	unsigned int sl_count;
882ba1f7	87	struct rcu_head rcu;
5d22b652	88	struct in6_addr sl_addr[] __counted_by(sl_max);
1da177e4 LT	89	};
1da177e4 LT	90
1da177e4 LT	91	#define IP6_SFBLOCK 10 /* allocate this many at once */
1da177e4 LT	92
fd2c3ef7	93	struct ipv6_mc_socklist {
1da177e4 LT	94	struct in6_addr addr;
1da177e4 LT	95	int ifindex;
14105c19	96	unsigned int sfmode; /* MCAST_{INCLUDE,EXCLUDE} */
456b61bc	97	struct ipv6_mc_socklist __rcu *next;
882ba1f7	98	struct ip6_sf_socklist __rcu *sflist;
456b61bc	99	struct rcu_head rcu;
1da177e4 LT	100	};
1da177e4 LT	101
fd2c3ef7	102	struct ip6_sf_list {
4b200e39	103	struct ip6_sf_list __rcu *sf_next;
1da177e4 LT	104	struct in6_addr sf_addr;
	105	unsigned long sf_count[2]; /* include/exclude counts */
	106	unsigned char sf_gsresp; /* include in g & s response? */
	107	unsigned char sf_oldin; /* change state */
	108	unsigned char sf_crcount; /* retrans. left to send */
4b200e39	109	struct rcu_head rcu;
1da177e4 LT	110	};
	111
	112	#define MAF_TIMER_RUNNING 0x01
	113	#define MAF_LAST_REPORTER 0x02
	114	#define MAF_LOADED 0x04
	115	#define MAF_NOREPORT 0x08
	116	#define MAF_GSQUERY 0x10
	117
fd2c3ef7	118	struct ifmcaddr6 {
1da177e4 LT	119	struct in6_addr mca_addr;
1da177e4 LT	120	struct inet6_dev *idev;
88e2ca30	121	struct ifmcaddr6 __rcu *next;
4b200e39 TY	122	struct ip6_sf_list __rcu *mca_sources;
4b200e39 TY	123	struct ip6_sf_list __rcu *mca_tomb;
1da177e4	124	unsigned int mca_sfmode;
246f19d1	125	unsigned char mca_crcount;
1da177e4	126	unsigned long mca_sfcount[2];
2d9a93b4	127	struct delayed_work mca_work;
95c96174	128	unsigned int mca_flags;
1da177e4	129	int mca_users;
d3981bc6	130	refcount_t mca_refcnt;
1da177e4 LT	131	unsigned long mca_cstamp;
1da177e4 LT	132	unsigned long mca_tstamp;
88e2ca30	133	struct rcu_head rcu;
1da177e4 LT	134	};
	135
	136	/* Anycast stuff */
	137
fd2c3ef7	138	struct ipv6_ac_socklist {
1da177e4 LT	139	struct in6_addr acl_addr;
	140	int acl_ifindex;
	141	struct ipv6_ac_socklist *acl_next;
	142	};
	143
fd2c3ef7	144	struct ifacaddr6 {
1da177e4	145	struct in6_addr aca_addr;
8d1c802b	146	struct fib6_info *aca_rt;
1da177e4	147	struct ifacaddr6 *aca_next;
2384d025	148	struct hlist_node aca_addr_lst;
1da177e4	149	int aca_users;
affa78bc	150	refcount_t aca_refcnt;
1da177e4 LT	151	unsigned long aca_cstamp;
1da177e4 LT	152	unsigned long aca_tstamp;
2384d025	153	struct rcu_head rcu;
1da177e4 LT	154	};
	155
	156	#define IFA_HOST IPV6_ADDR_LOOPBACK
	157	#define IFA_LINK IPV6_ADDR_LINKLOCAL
	158	#define IFA_SITE IPV6_ADDR_SITELOCAL
1da177e4 LT	159
	160	struct ipv6_devstat {
	161	struct proc_dir_entry *proc_dir_entry;
a11d206d	162	DEFINE_SNMP_STAT(struct ipstats_mib, ipv6);
be281e55 ED	163	DEFINE_SNMP_STAT_ATOMIC(struct icmpv6_mib_device, icmpv6dev);
be281e55 ED	164	DEFINE_SNMP_STAT_ATOMIC(struct icmpv6msg_mib_device, icmpv6msgdev);
1da177e4 LT	165	};
1da177e4 LT	166
fd2c3ef7	167	struct inet6_dev {
502a2ffd	168	struct net_device *dev;
8c727003	169	netdevice_tracker dev_tracker;
1da177e4	170
502a2ffd	171	struct list_head addr_list;
1da177e4	172
88e2ca30 TY	173	struct ifmcaddr6 __rcu *mc_list;
88e2ca30 TY	174	struct ifmcaddr6 __rcu *mc_tomb;
89225d1c DB	175
89225d1c DB	176	unsigned char mc_qrv; /* Query Robustness Variable */
1da177e4 LT	177	unsigned char mc_gq_running;
1da177e4 LT	178	unsigned char mc_ifc_count;
b173ee48	179	unsigned char mc_dad_count;
89225d1c DB	180
	181	unsigned long mc_v1_seen; /* Max time we stay in MLDv1 mode */
	182	unsigned long mc_qi; /* Query Interval */
	183	unsigned long mc_qri; /* Query Response Interval */
4e7e5cfe	184	unsigned long mc_maxdelay;
89225d1c	185
2d9a93b4 TY	186	struct delayed_work mc_gq_work; /* general query work */
	187	struct delayed_work mc_ifc_work; /* interface change work */
	188	struct delayed_work mc_dad_work; /* dad complete mc work */
f185de28 TY	189	struct delayed_work mc_query_work; /* mld query work */
	190	struct delayed_work mc_report_work; /* mld report work */
	191
	192	struct sk_buff_head mc_query_queue; /* mld query queue */
	193	struct sk_buff_head mc_report_queue; /* mld report queue */
	194
	195	spinlock_t mc_query_lock; /* mld query queue lock */
	196	spinlock_t mc_report_lock; /* mld query report lock */
63ed8de4	197	struct mutex mc_lock; /* mld global lock */
1da177e4 LT	198
	199	struct ifacaddr6 *ac_list;
	200	rwlock_t lock;
1be92460	201	refcount_t refcnt;
1da177e4 LT	202	__u32 if_flags;
	203	int dead;
	204
76506a98	205	u32 desync_factor;
372e6c8f	206	struct list_head tempaddr_list;
1da177e4	207
f53adae4 DB	208	struct in6_addr token;
f53adae4 DB	209
1da177e4	210	struct neigh_parms *nd_parms;
1da177e4 LT	211	struct ipv6_devconf cnf;
1da177e4 LT	212	struct ipv6_devstat stats;
b7b1bfce HFS	213
b7b1bfce HFS	214	struct timer_list rs_timer;
bd11f074	215	__s32 rs_interval; /* in jiffies */
b7b1bfce HFS	216	__u8 rs_probes;
b7b1bfce HFS	217
1da177e4	218	unsigned long tstamp; /* ipv6InterfaceTable update timestamp */
8814c4b5	219	struct rcu_head rcu;
49b99da2 RY	220
49b99da2 RY	221	unsigned int ra_mtu;
1da177e4 LT	222	};
1da177e4 LT	223
b71d1d42	224	static inline void ipv6_eth_mc_map(const struct in6_addr addr, char buf)
1da177e4 LT	225	{
	226	/*
	227	* +-------+-------+-------+-------+-------+-------+
	228	* \| 33 \| 33 \| DST13 \| DST14 \| DST15 \| DST16 \|
	229	* +-------+-------+-------+-------+-------+-------+
	230	*/
	231
	232	buf[0]= 0x33;
	233	buf[1]= 0x33;
	234
	235	memcpy(buf + 2, &addr->s6_addr32[3], sizeof(__u32));
	236	}
	237
1da177e4 LT	238	static inline void ipv6_arcnet_mc_map(const struct in6_addr addr, char buf)
	239	{
	240	buf[0] = 0x00;
	241	}
	242
a9e527e3 RM	243	static inline void ipv6_ib_mc_map(const struct in6_addr *addr,
a9e527e3 RM	244	const unsigned char broadcast, char buf)
1da177e4	245	{
a9e527e3 RM	246	unsigned char scope = broadcast[5] & 0xF;
a9e527e3 RM	247
1da177e4 LT	248	buf[0] = 0; /* Reserved */
	249	buf[1] = 0xff; /* Multicast QPN */
	250	buf[2] = 0xff;
	251	buf[3] = 0xff;
	252	buf[4] = 0xff;
a9e527e3	253	buf[5] = 0x10 \| scope; /* scope from broadcast address */
1da177e4 LT	254	buf[6] = 0x60; /* IPv6 signature */
1da177e4 LT	255	buf[7] = 0x1b;
a9e527e3 RM	256	buf[8] = broadcast[8]; /* P_Key */
a9e527e3 RM	257	buf[9] = broadcast[9];
1da177e4 LT	258	memcpy(buf + 10, addr->s6_addr + 6, 10);
1da177e4 LT	259	}
93ca3bb5 TT	260
	261	static inline int ipv6_ipgre_mc_map(const struct in6_addr *addr,
	262	const unsigned char broadcast, char buf)
	263	{
	264	if ((broadcast[0] \| broadcast[1] \| broadcast[2] \| broadcast[3]) != 0) {
	265	memcpy(buf, broadcast, 4);
	266	} else {
	267	/* v4mapped? */
	268	if ((addr->s6_addr32[0] \| addr->s6_addr32[1] \|
	269	(addr->s6_addr32[2] ^ htonl(0x0000ffff))) != 0)
	270	return -EINVAL;
	271	memcpy(buf, &addr->s6_addr32[3], 4);
	272	}
	273	return 0;
	274	}
	275
1da177e4	276	#endif