[mirror_ubuntu-jammy-kernel.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

/* prefix flags */
#define IF_PREFIX_ONLINK	0x01
#define IF_PREFIX_AUTOCONF	0x02

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;

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

	bool			tokenized;

	struct rcu_head		rcu;
	struct in6_addr		peer_addr;
};

struct ip6_sf_socklist {
	unsigned int		sl_max;
	unsigned int		sl_count;
	struct in6_addr		sl_addr[];
};

#define IP6_SFLSIZE(count)	(sizeof(struct ip6_sf_socklist) + \
	(count) * sizeof(struct in6_addr))

#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;
	rwlock_t		sflock;
	struct ip6_sf_socklist	*sflist;
	struct rcu_head		rcu;
};

struct ip6_sf_list {
	struct ip6_sf_list	*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 */
};

#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	*next;
	struct ip6_sf_list	*mca_sources;
	struct ip6_sf_list	*mca_tomb;
	unsigned int		mca_sfmode;
	unsigned char		mca_crcount;
	unsigned long		mca_sfcount[2];
	struct timer_list	mca_timer;
	unsigned int		mca_flags;
	int			mca_users;
	refcount_t		mca_refcnt;
	spinlock_t		mca_lock;
	unsigned long		mca_cstamp;
	unsigned long		mca_tstamp;
};

/* 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;

	struct list_head	addr_list;

	struct ifmcaddr6	*mc_list;
	struct ifmcaddr6	*mc_tomb;
	spinlock_t		mc_lock;

	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 timer_list	mc_gq_timer;	/* general query timer */
	struct timer_list	mc_ifc_timer;	/* interface change timer */
	struct timer_list	mc_dad_timer;	/* dad complete mc timer */

	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;
};

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 LT	24
	25	/* prefix flags */
	26	#define IF_PREFIX_ONLINK 0x01
	27	#define IF_PREFIX_AUTOCONF 0x02
	28
e9d3e084	29	enum {
c15b1cca	30	INET6_IFADDR_STATE_PREDAD,
e9d3e084 HX	31	INET6_IFADDR_STATE_DAD,
e9d3e084 HX	32	INET6_IFADDR_STATE_POSTDAD,
c15b1cca	33	INET6_IFADDR_STATE_ERRDAD,
e9d3e084 HX	34	INET6_IFADDR_STATE_DEAD,
	35	};
	36
fd2c3ef7	37	struct inet6_ifaddr {
1da177e4 LT	38	struct in6_addr addr;
1da177e4 LT	39	__u32 prefix_len;
8308f3ff	40	__u32 rt_priority;
8e8e676d	41
76f793e3	42	/* In seconds, relative to tstamp. Expiry is at tstamp + HZ * lft. */
1da177e4 LT	43	__u32 valid_lft;
1da177e4 LT	44	__u32 prefered_lft;
271201c0	45	refcount_t refcnt;
1da177e4	46	spinlock_t lock;
e9d3e084 HX	47
e9d3e084 HX	48	int state;
1da177e4	49
479840ff	50	__u32 flags;
b7b1bfce	51	__u8 dad_probes;
5f40ef77	52	__u8 stable_privacy_retry;
1da177e4 LT	53
1da177e4 LT	54	__u16 scope;
adc176c5	55	__u64 dad_nonce;
1da177e4	56
04ec5cfc RK	57	unsigned long cstamp; /* created timestamp */
	58	unsigned long tstamp; /* updated timestamp */
	59
c15b1cca	60	struct delayed_work dad_work;
1da177e4 LT	61
1da177e4 LT	62	struct inet6_dev *idev;
8d1c802b	63	struct fib6_info *rt;
1da177e4	64
c2e21293	65	struct hlist_node addr_lst;
502a2ffd	66	struct list_head if_list;
1da177e4	67
372e6c8f	68	struct list_head tmp_list;
1da177e4 LT	69	struct inet6_ifaddr *ifpub;
1da177e4 LT	70	int regen_count;
5d9efa7e	71
617fe29d DB	72	bool tokenized;
617fe29d DB	73
5c578aed	74	struct rcu_head rcu;
caeaba79	75	struct in6_addr peer_addr;
1da177e4 LT	76	};
1da177e4 LT	77
fd2c3ef7	78	struct ip6_sf_socklist {
1da177e4 LT	79	unsigned int sl_max;
1da177e4 LT	80	unsigned int sl_count;
0fa39d6d	81	struct in6_addr sl_addr[];
1da177e4 LT	82	};
	83
	84	#define IP6_SFLSIZE(count) (sizeof(struct ip6_sf_socklist) + \
	85	(count) * sizeof(struct in6_addr))
	86
	87	#define IP6_SFBLOCK 10 /* allocate this many at once */
	88
fd2c3ef7	89	struct ipv6_mc_socklist {
1da177e4 LT	90	struct in6_addr addr;
1da177e4 LT	91	int ifindex;
14105c19	92	unsigned int sfmode; /* MCAST_{INCLUDE,EXCLUDE} */
456b61bc	93	struct ipv6_mc_socklist __rcu *next;
5ab4a6c8	94	rwlock_t sflock;
1da177e4	95	struct ip6_sf_socklist *sflist;
456b61bc	96	struct rcu_head rcu;
1da177e4 LT	97	};
1da177e4 LT	98
fd2c3ef7	99	struct ip6_sf_list {
1da177e4 LT	100	struct ip6_sf_list *sf_next;
	101	struct in6_addr sf_addr;
	102	unsigned long sf_count[2]; /* include/exclude counts */
	103	unsigned char sf_gsresp; /* include in g & s response? */
	104	unsigned char sf_oldin; /* change state */
	105	unsigned char sf_crcount; /* retrans. left to send */
	106	};
	107
	108	#define MAF_TIMER_RUNNING 0x01
	109	#define MAF_LAST_REPORTER 0x02
	110	#define MAF_LOADED 0x04
	111	#define MAF_NOREPORT 0x08
	112	#define MAF_GSQUERY 0x10
	113
fd2c3ef7	114	struct ifmcaddr6 {
1da177e4 LT	115	struct in6_addr mca_addr;
	116	struct inet6_dev *idev;
	117	struct ifmcaddr6 *next;
	118	struct ip6_sf_list *mca_sources;
	119	struct ip6_sf_list *mca_tomb;
	120	unsigned int mca_sfmode;
246f19d1	121	unsigned char mca_crcount;
1da177e4 LT	122	unsigned long mca_sfcount[2];
1da177e4 LT	123	struct timer_list mca_timer;
95c96174	124	unsigned int mca_flags;
1da177e4	125	int mca_users;
d3981bc6	126	refcount_t mca_refcnt;
1da177e4	127	spinlock_t mca_lock;
1da177e4 LT	128	unsigned long mca_cstamp;
	129	unsigned long mca_tstamp;
	130	};
	131
	132	/* Anycast stuff */
	133
fd2c3ef7	134	struct ipv6_ac_socklist {
1da177e4 LT	135	struct in6_addr acl_addr;
	136	int acl_ifindex;
	137	struct ipv6_ac_socklist *acl_next;
	138	};
	139
fd2c3ef7	140	struct ifacaddr6 {
1da177e4	141	struct in6_addr aca_addr;
8d1c802b	142	struct fib6_info *aca_rt;
1da177e4	143	struct ifacaddr6 *aca_next;
2384d025	144	struct hlist_node aca_addr_lst;
1da177e4	145	int aca_users;
affa78bc	146	refcount_t aca_refcnt;
1da177e4 LT	147	unsigned long aca_cstamp;
1da177e4 LT	148	unsigned long aca_tstamp;
2384d025	149	struct rcu_head rcu;
1da177e4 LT	150	};
	151
	152	#define IFA_HOST IPV6_ADDR_LOOPBACK
	153	#define IFA_LINK IPV6_ADDR_LINKLOCAL
	154	#define IFA_SITE IPV6_ADDR_SITELOCAL
1da177e4 LT	155
	156	struct ipv6_devstat {
	157	struct proc_dir_entry *proc_dir_entry;
a11d206d	158	DEFINE_SNMP_STAT(struct ipstats_mib, ipv6);
be281e55 ED	159	DEFINE_SNMP_STAT_ATOMIC(struct icmpv6_mib_device, icmpv6dev);
be281e55 ED	160	DEFINE_SNMP_STAT_ATOMIC(struct icmpv6msg_mib_device, icmpv6msgdev);
1da177e4 LT	161	};
1da177e4 LT	162
fd2c3ef7	163	struct inet6_dev {
502a2ffd	164	struct net_device *dev;
1da177e4	165
502a2ffd	166	struct list_head addr_list;
1da177e4 LT	167
	168	struct ifmcaddr6 *mc_list;
	169	struct ifmcaddr6 *mc_tomb;
6457d26b	170	spinlock_t mc_lock;
89225d1c DB	171
89225d1c DB	172	unsigned char mc_qrv; /* Query Robustness Variable */
1da177e4 LT	173	unsigned char mc_gq_running;
1da177e4 LT	174	unsigned char mc_ifc_count;
b173ee48	175	unsigned char mc_dad_count;
89225d1c DB	176
	177	unsigned long mc_v1_seen; /* Max time we stay in MLDv1 mode */
	178	unsigned long mc_qi; /* Query Interval */
	179	unsigned long mc_qri; /* Query Response Interval */
4e7e5cfe	180	unsigned long mc_maxdelay;
89225d1c	181
1da177e4 LT	182	struct timer_list mc_gq_timer; /* general query timer */
1da177e4 LT	183	struct timer_list mc_ifc_timer; /* interface change timer */
b173ee48	184	struct timer_list mc_dad_timer; /* dad complete mc timer */
1da177e4 LT	185
	186	struct ifacaddr6 *ac_list;
	187	rwlock_t lock;
1be92460	188	refcount_t refcnt;
1da177e4 LT	189	__u32 if_flags;
	190	int dead;
	191
76506a98	192	u32 desync_factor;
372e6c8f	193	struct list_head tempaddr_list;
1da177e4	194
f53adae4 DB	195	struct in6_addr token;
f53adae4 DB	196
1da177e4	197	struct neigh_parms *nd_parms;
1da177e4 LT	198	struct ipv6_devconf cnf;
1da177e4 LT	199	struct ipv6_devstat stats;
b7b1bfce HFS	200
b7b1bfce HFS	201	struct timer_list rs_timer;
bd11f074	202	__s32 rs_interval; /* in jiffies */
b7b1bfce HFS	203	__u8 rs_probes;
b7b1bfce HFS	204
1da177e4	205	unsigned long tstamp; /* ipv6InterfaceTable update timestamp */
8814c4b5	206	struct rcu_head rcu;
1da177e4 LT	207	};
1da177e4 LT	208
b71d1d42	209	static inline void ipv6_eth_mc_map(const struct in6_addr addr, char buf)
1da177e4 LT	210	{
	211	/*
	212	* +-------+-------+-------+-------+-------+-------+
	213	* \| 33 \| 33 \| DST13 \| DST14 \| DST15 \| DST16 \|
	214	* +-------+-------+-------+-------+-------+-------+
	215	*/
	216
	217	buf[0]= 0x33;
	218	buf[1]= 0x33;
	219
	220	memcpy(buf + 2, &addr->s6_addr32[3], sizeof(__u32));
	221	}
	222
1da177e4 LT	223	static inline void ipv6_arcnet_mc_map(const struct in6_addr addr, char buf)
	224	{
	225	buf[0] = 0x00;
	226	}
	227
a9e527e3 RM	228	static inline void ipv6_ib_mc_map(const struct in6_addr *addr,
a9e527e3 RM	229	const unsigned char broadcast, char buf)
1da177e4	230	{
a9e527e3 RM	231	unsigned char scope = broadcast[5] & 0xF;
a9e527e3 RM	232
1da177e4 LT	233	buf[0] = 0; /* Reserved */
	234	buf[1] = 0xff; /* Multicast QPN */
	235	buf[2] = 0xff;
	236	buf[3] = 0xff;
	237	buf[4] = 0xff;
a9e527e3	238	buf[5] = 0x10 \| scope; /* scope from broadcast address */
1da177e4 LT	239	buf[6] = 0x60; /* IPv6 signature */
1da177e4 LT	240	buf[7] = 0x1b;
a9e527e3 RM	241	buf[8] = broadcast[8]; /* P_Key */
a9e527e3 RM	242	buf[9] = broadcast[9];
1da177e4 LT	243	memcpy(buf + 10, addr->s6_addr + 6, 10);
1da177e4 LT	244	}
93ca3bb5 TT	245
	246	static inline int ipv6_ipgre_mc_map(const struct in6_addr *addr,
	247	const unsigned char broadcast, char buf)
	248	{
	249	if ((broadcast[0] \| broadcast[1] \| broadcast[2] \| broadcast[3]) != 0) {
	250	memcpy(buf, broadcast, 4);
	251	} else {
	252	/* v4mapped? */
	253	if ((addr->s6_addr32[0] \| addr->s6_addr32[1] \|
	254	(addr->s6_addr32[2] ^ htonl(0x0000ffff))) != 0)
	255	return -EINVAL;
	256	memcpy(buf, &addr->s6_addr32[3], 4);
	257	}
	258	return 0;
	259	}
	260
1da177e4	261	#endif