summaryrefslogtreecommitdiff
path: root/sys/net/if_trunk.h
blob: 21c575f4933ccce2eae7db2281ccdcd11156fc5f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
/*	$OpenBSD: if_trunk.h,v 1.27 2019/04/29 04:26:47 dlg Exp $	*/

/*
 * Copyright (c) 2005, 2006, 2007 Reyk Floeter <reyk@openbsd.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef _NET_TRUNK_H
#define _NET_TRUNK_H

/*
 * Global definitions
 */

#define TRUNK_MAX_PORTS		32	/* logically */
#define TRUNK_MAX_NAMESIZE	32	/* name of a protocol */
#define TRUNK_MAX_STACKING	4	/* maximum number of stacked trunks */

/* Port flags */
#define TRUNK_PORT_SLAVE		0x00000000 /* normal enslaved port */
#define TRUNK_PORT_MASTER		0x00000001 /* primary port */
#define TRUNK_PORT_STACK		0x00000002 /* stacked trunk port */
#define TRUNK_PORT_ACTIVE		0x00000004 /* port is active */
#define TRUNK_PORT_COLLECTING		0x00000008 /* port is receiving frames */
#define TRUNK_PORT_DISTRIBUTING	0x00000010 /* port is sending frames */
#define TRUNK_PORT_DISABLED		0x00000020 /* port is disabled */
#define TRUNK_PORT_GLOBAL		0x80000000 /* IOCTL: global flag */
#define TRUNK_PORT_BITS		"\20\01MASTER\02STACK\03ACTIVE" \
					 "\04COLLECTING\05DISTRIBUTING\06DISABLED"

/* Supported trunk PROTOs */
enum trunk_proto {
	TRUNK_PROTO_NONE	= 0,		/* no trunk protocol defined */
	TRUNK_PROTO_ROUNDROBIN	= 1,		/* simple round robin */
	TRUNK_PROTO_FAILOVER	= 2,		/* active failover */
	TRUNK_PROTO_LOADBALANCE	= 3,		/* loadbalance */
	TRUNK_PROTO_BROADCAST	= 4,		/* broadcast */
	TRUNK_PROTO_LACP	= 5,		/* 802.3ad LACP */
	TRUNK_PROTO_MAX		= 6
};

struct trunk_protos {
	const char		*tpr_name;
	enum trunk_proto	tpr_proto;
};

#define	TRUNK_PROTO_DEFAULT	TRUNK_PROTO_ROUNDROBIN
#define TRUNK_PROTOS	{						\
	{ "roundrobin",		TRUNK_PROTO_ROUNDROBIN },		\
	{ "failover",		TRUNK_PROTO_FAILOVER },			\
	{ "lacp",		TRUNK_PROTO_LACP },			\
	{ "loadbalance",	TRUNK_PROTO_LOADBALANCE },		\
	{ "broadcast",		TRUNK_PROTO_BROADCAST },		\
	{ "none",		TRUNK_PROTO_NONE },			\
	{ "default",		TRUNK_PROTO_DEFAULT }			\
}

/*
 * Trunk ioctls.
 */

/*
 * LACP current operational parameters structure.
 */
struct lacp_opreq {
	u_int16_t		actor_prio;
	u_int8_t		actor_mac[ETHER_ADDR_LEN];
	u_int16_t		actor_key;
	u_int16_t		actor_portprio;
	u_int16_t		actor_portno;
	u_int8_t		actor_state;
	u_int16_t		partner_prio;
	u_int8_t		partner_mac[ETHER_ADDR_LEN];
	u_int16_t		partner_key;
	u_int16_t		partner_portprio;
	u_int16_t		partner_portno;
	u_int8_t		partner_state;
};

/* Trunk port settings */
struct trunk_reqport {
	char			rp_ifname[IFNAMSIZ];	/* name of the trunk */
	char			rp_portname[IFNAMSIZ];	/* name of the port */
	u_int32_t		rp_prio;		/* port priority */
	u_int32_t		rp_flags;		/* port flags */
	union {
		struct lacp_opreq rpsc_lacp;
	} rp_psc;
#define rp_lacpreq	rp_psc.rpsc_lacp
};

#define SIOCGTRUNKPORT		_IOWR('i', 140, struct trunk_reqport)
#define SIOCSTRUNKPORT		 _IOW('i', 141, struct trunk_reqport)
#define SIOCSTRUNKDELPORT	 _IOW('i', 142, struct trunk_reqport)

/* Trunk, ports and options */
struct trunk_reqall {
	char			ra_ifname[IFNAMSIZ];	/* name of the trunk */
	u_int			ra_proto;		/* trunk protocol */

	size_t			ra_size;		/* size of buffer */
	struct trunk_reqport	*ra_port;		/* allocated buffer */
	int			ra_ports;		/* total port count */
	union {
		struct lacp_opreq rpsc_lacp;
	} ra_psc;
#define ra_lacpreq	ra_psc.rpsc_lacp
};

#define SIOCGTRUNK		_IOWR('i', 143, struct trunk_reqall)
#define SIOCSTRUNK		 _IOW('i', 144, struct trunk_reqall)

/* LACP administrative options */
struct lacp_adminopts {
	u_int8_t		lacp_mode;		/* active or passive */
	u_int8_t		lacp_timeout;		/* fast or slow */
	u_int16_t		lacp_prio;		/* system priority */
	u_int16_t		lacp_portprio;		/* port priority */
	u_int8_t		lacp_ifqprio;		/* ifq priority */
};

/* Trunk administrative options */
struct trunk_opts {
	char			to_ifname[IFNAMSIZ];	/* name of the trunk */
	u_int			to_proto;		/* trunk protocol */
	int			to_opts;		/* option bitmap */
#define TRUNK_OPT_NONE			0x00
#define TRUNK_OPT_LACP_MODE		0x01		/* set active bit */
#define TRUNK_OPT_LACP_TIMEOUT		0x02		/* set timeout bit */
#define TRUNK_OPT_LACP_SYS_PRIO		0x04		/* set sys_prio bit */
#define TRUNK_OPT_LACP_PORT_PRIO	0x08		/* set port_prio bit */
#define TRUNK_OPT_LACP_IFQ_PRIO		0x10		/* set ifq_prio bit */

	union {
		struct lacp_adminopts rpsc_lacp;
	} to_psc;
#define to_lacpopts	to_psc.rpsc_lacp
};

#define SIOCGTRUNKOPTS		_IOWR('i', 145, struct trunk_opts)
#define SIOCSTRUNKOPTS		 _IOW('i', 146, struct trunk_opts)

#ifdef _KERNEL
/*
 * Internal kernel part
 */
struct trunk_softc;
struct trunk_port {
	struct ifnet			*tp_if;		/* physical interface */
	struct trunk_softc		*tp_trunk;	/* parent trunk */
	u_int8_t			tp_lladdr[ETHER_ADDR_LEN];
	caddr_t				tp_psc;		/* protocol data */

	u_char				tp_iftype;	/* interface type */
	u_int32_t			tp_prio;	/* port priority */
	u_int32_t			tp_flags;	/* port flags */
	void				*lh_cookie;	/* if state hook */
	void				*dh_cookie;	/* if detach hook */

	/* Redirected callbacks */
	int	(*tp_ioctl)(struct ifnet *, u_long, caddr_t);
	int	(*tp_output)(struct ifnet *, struct mbuf *, struct sockaddr *,
		    struct rtentry *);

	SLIST_ENTRY(trunk_port)		tp_entries;
};

#define tp_ifname		tp_if->if_xname		/* interface name */
#define tp_ifflags		tp_if->if_flags		/* interface flags */
#define tp_link_state		tp_if->if_link_state	/* link state */
#define tp_capabilities		tp_if->if_capabilities	/* capabilities */

#define TRUNK_PORTACTIVE(_tp)	(					\
	LINK_STATE_IS_UP((_tp)->tp_link_state) &&			\
	(_tp)->tp_ifflags & IFF_UP)

struct trunk_mc {
	union {
		struct ether_multi	*mcu_enm;
	} mc_u;
	struct sockaddr_storage		mc_addr;

	SLIST_ENTRY(trunk_mc)		mc_entries;
};

#define mc_enm	mc_u.mcu_enm

struct trunk_ifreq {
	union {
		struct ifreq ifreq;
		struct {
			char ifr_name[IFNAMSIZ];
			struct sockaddr_storage ifr_ss;
		} ifreq_storage;
	} ifreq;
};

struct trunk_softc {
	struct arpcom			tr_ac;		/* virtual interface */
	enum trunk_proto		tr_proto;	/* trunk protocol */
	u_int				tr_count;	/* number of ports */
	struct trunk_port		*tr_primary;	/* primary port */
	struct ifmedia			tr_media;	/* media config */
	caddr_t				tr_psc;		/* protocol data */

	SLIST_HEAD(__tplhd, trunk_port)	tr_ports;	/* list of interfaces */
	SLIST_ENTRY(trunk_softc)	tr_entries;

	SLIST_HEAD(__mclhd, trunk_mc)	tr_mc_head;	/* multicast addresses */

	/* Trunk protocol callbacks */
	int	(*tr_detach)(struct trunk_softc *);
	int	(*tr_start)(struct trunk_softc *, struct mbuf *);
	int	(*tr_input)(struct trunk_softc *, struct trunk_port *,
		    struct mbuf *);
	int	(*tr_port_create)(struct trunk_port *);
	void	(*tr_port_destroy)(struct trunk_port *);
	void	(*tr_linkstate)(struct trunk_port *);
	void	(*tr_init)(struct trunk_softc *);
	void	(*tr_stop)(struct trunk_softc *);
	void	(*tr_req)(struct trunk_softc *, caddr_t);
	void	(*tr_portreq)(struct trunk_port *, caddr_t);
};

#define tr_ifflags		tr_ac.ac_if.if_flags		/* flags */
#define tr_ifname		tr_ac.ac_if.if_xname		/* name */
#define tr_capabilities		tr_ac.ac_if.if_capabilities	/* capabilities */
#define tr_ifindex		tr_ac.ac_if.if_index		/* int index */
#define tr_lladdr		tr_ac.ac_enaddr			/* lladdr */

#define IFCAP_TRUNK_MASK	0xffff0000	/* private capabilities */
#define IFCAP_TRUNK_FULLDUPLEX	0x00010000	/* full duplex with >1 ports */

/* Private data used by the loadbalancing protocol */
struct trunk_lb {
	SIPHASH_KEY		lb_key;
	struct trunk_port	*lb_ports[TRUNK_MAX_PORTS];
};

int		trunk_enqueue(struct ifnet *, struct mbuf *);
u_int32_t	trunk_hashmbuf(struct mbuf *, SIPHASH_KEY *);
#endif /* _KERNEL */

#endif /* _NET_TRUNK_H */