1 /* $OpenBSD: if_trunk.h,v 1.11 2007/01/31 06:20:19 reyk Exp $ */ 2 3 /* 4 * Copyright (c) 2005, 2006 Reyk Floeter <reyk@openbsd.org> 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 * 18 * $FreeBSD$ 19 */ 20 21 #ifndef _NET_LAGG_H 22 #define _NET_LAGG_H 23 24 /* 25 * Global definitions 26 */ 27 28 #define LAGG_MAX_PORTS 32 /* logically */ 29 #define LAGG_MAX_NAMESIZE 32 /* name of a protocol */ 30 #define LAGG_MAX_STACKING 4 /* maximum number of stacked laggs */ 31 32 /* Lagg flags */ 33 #define LAGG_F_HASHL2 0x00000001 /* hash layer 2 */ 34 #define LAGG_F_HASHL3 0x00000002 /* hash layer 3 */ 35 #define LAGG_F_HASHL4 0x00000004 /* hash layer 4 */ 36 #define LAGG_F_HASHMASK 0x00000007 37 38 /* Port flags */ 39 #define LAGG_PORT_SLAVE 0x00000000 /* normal enslaved port */ 40 #define LAGG_PORT_MASTER 0x00000001 /* primary port */ 41 #define LAGG_PORT_STACK 0x00000002 /* stacked lagg port */ 42 #define LAGG_PORT_ACTIVE 0x00000004 /* port is active */ 43 #define LAGG_PORT_COLLECTING 0x00000008 /* port is receiving frames */ 44 #define LAGG_PORT_DISTRIBUTING 0x00000010 /* port is sending frames */ 45 #define LAGG_PORT_DISABLED 0x00000020 /* port is disabled */ 46 #define LAGG_PORT_BITS "\20\01MASTER\02STACK\03ACTIVE\04COLLECTING" \ 47 "\05DISTRIBUTING\06DISABLED" 48 49 /* Supported lagg PROTOs */ 50 #define LAGG_PROTO_NONE 0 /* no lagg protocol defined */ 51 #define LAGG_PROTO_ROUNDROBIN 1 /* simple round robin */ 52 #define LAGG_PROTO_FAILOVER 2 /* active failover */ 53 #define LAGG_PROTO_LOADBALANCE 3 /* loadbalance */ 54 #define LAGG_PROTO_LACP 4 /* 802.3ad lacp */ 55 #define LAGG_PROTO_ETHERCHANNEL 5 /* Cisco FEC */ 56 #define LAGG_PROTO_MAX 6 57 58 struct lagg_protos { 59 const char *lpr_name; 60 int lpr_proto; 61 }; 62 63 #define LAGG_PROTO_DEFAULT LAGG_PROTO_FAILOVER 64 #define LAGG_PROTOS { \ 65 { "failover", LAGG_PROTO_FAILOVER }, \ 66 { "fec", LAGG_PROTO_ETHERCHANNEL }, \ 67 { "lacp", LAGG_PROTO_LACP }, \ 68 { "loadbalance", LAGG_PROTO_LOADBALANCE }, \ 69 { "roundrobin", LAGG_PROTO_ROUNDROBIN }, \ 70 { "none", LAGG_PROTO_NONE }, \ 71 { "default", LAGG_PROTO_DEFAULT } \ 72 } 73 74 /* 75 * lagg ioctls. 76 */ 77 78 /* 79 * LACP current operational parameters structure. 80 */ 81 struct lacp_opreq { 82 uint16_t actor_prio; 83 uint8_t actor_mac[ETHER_ADDR_LEN]; 84 uint16_t actor_key; 85 uint16_t actor_portprio; 86 uint16_t actor_portno; 87 uint8_t actor_state; 88 uint16_t partner_prio; 89 uint8_t partner_mac[ETHER_ADDR_LEN]; 90 uint16_t partner_key; 91 uint16_t partner_portprio; 92 uint16_t partner_portno; 93 uint8_t partner_state; 94 }; 95 96 /* lagg port settings */ 97 struct lagg_reqport { 98 char rp_ifname[IFNAMSIZ]; /* name of the lagg */ 99 char rp_portname[IFNAMSIZ]; /* name of the port */ 100 u_int32_t rp_prio; /* port priority */ 101 u_int32_t rp_flags; /* port flags */ 102 union { 103 struct lacp_opreq rpsc_lacp; 104 } rp_psc; 105 #define rp_lacpreq rp_psc.rpsc_lacp 106 }; 107 108 #define SIOCGLAGGPORT _IOWR('i', 140, struct lagg_reqport) 109 #define SIOCSLAGGPORT _IOW('i', 141, struct lagg_reqport) 110 #define SIOCSLAGGDELPORT _IOW('i', 142, struct lagg_reqport) 111 112 /* lagg, ports and options */ 113 struct lagg_reqall { 114 char ra_ifname[IFNAMSIZ]; /* name of the lagg */ 115 u_int ra_proto; /* lagg protocol */ 116 117 size_t ra_size; /* size of buffer */ 118 struct lagg_reqport *ra_port; /* allocated buffer */ 119 int ra_ports; /* total port count */ 120 union { 121 struct lacp_opreq rpsc_lacp; 122 } ra_psc; 123 #define ra_lacpreq ra_psc.rpsc_lacp 124 }; 125 126 #define SIOCGLAGG _IOWR('i', 143, struct lagg_reqall) 127 #define SIOCSLAGG _IOW('i', 144, struct lagg_reqall) 128 129 struct lagg_reqflags { 130 char rf_ifname[IFNAMSIZ]; /* name of the lagg */ 131 uint32_t rf_flags; /* lagg protocol */ 132 }; 133 134 #define SIOCGLAGGFLAGS _IOWR('i', 145, struct lagg_reqflags) 135 #define SIOCSLAGGHASH _IOW('i', 146, struct lagg_reqflags) 136 137 #ifdef _KERNEL 138 139 #include <sys/counter.h> 140 141 /* 142 * Internal kernel part 143 */ 144 145 #define lp_ifname lp_ifp->if_xname /* interface name */ 146 #define lp_link_state lp_ifp->if_link_state /* link state */ 147 148 #define LAGG_PORTACTIVE(_tp) ( \ 149 ((_tp)->lp_link_state == LINK_STATE_UP) && \ 150 ((_tp)->lp_ifp->if_flags & IFF_UP) \ 151 ) 152 153 struct lagg_ifreq { 154 union { 155 struct ifreq ifreq; 156 struct { 157 char ifr_name[IFNAMSIZ]; 158 struct sockaddr_storage ifr_ss; 159 } ifreq_storage; 160 } ifreq; 161 }; 162 163 #define sc_ifflags sc_ifp->if_flags /* flags */ 164 #define sc_ifname sc_ifp->if_xname /* name */ 165 #define sc_capabilities sc_ifp->if_capabilities /* capabilities */ 166 167 #define IFCAP_LAGG_MASK 0xffff0000 /* private capabilities */ 168 #define IFCAP_LAGG_FULLDUPLEX 0x00010000 /* full duplex with >1 ports */ 169 170 /* Private data used by the loadbalancing protocol */ 171 struct lagg_lb { 172 u_int32_t lb_key; 173 struct lagg_port *lb_ports[LAGG_MAX_PORTS]; 174 }; 175 176 struct lagg_mc { 177 struct ifmultiaddr *mc_ifma; 178 SLIST_ENTRY(lagg_mc) mc_entries; 179 }; 180 181 /* List of interfaces to have the MAC address modified */ 182 struct lagg_llq { 183 struct ifnet *llq_ifp; 184 uint8_t llq_lladdr[ETHER_ADDR_LEN]; 185 SLIST_ENTRY(lagg_llq) llq_entries; 186 }; 187 188 struct lagg_softc { 189 struct ifnet *sc_ifp; /* virtual interface */ 190 struct rmlock sc_mtx; 191 struct mtx sc_call_mtx; 192 int sc_proto; /* lagg protocol */ 193 u_int sc_count; /* number of ports */ 194 u_int sc_active; /* active port count */ 195 u_int sc_flapping; /* number of flapping 196 * events */ 197 struct lagg_port *sc_primary; /* primary port */ 198 struct ifmedia sc_media; /* media config */ 199 caddr_t sc_psc; /* protocol data */ 200 uint32_t sc_seq; /* sequence counter */ 201 uint32_t sc_flags; 202 203 counter_u64_t sc_ipackets; 204 counter_u64_t sc_opackets; 205 counter_u64_t sc_ibytes; 206 counter_u64_t sc_obytes; 207 208 SLIST_HEAD(__tplhd, lagg_port) sc_ports; /* list of interfaces */ 209 SLIST_ENTRY(lagg_softc) sc_entries; 210 211 struct task sc_lladdr_task; 212 SLIST_HEAD(__llqhd, lagg_llq) sc_llq_head; /* interfaces to program 213 the lladdr on */ 214 215 /* lagg protocol callbacks */ 216 int (*sc_detach)(struct lagg_softc *); 217 int (*sc_start)(struct lagg_softc *, struct mbuf *); 218 struct mbuf *(*sc_input)(struct lagg_softc *, struct lagg_port *, 219 struct mbuf *); 220 int (*sc_port_create)(struct lagg_port *); 221 void (*sc_port_destroy)(struct lagg_port *); 222 void (*sc_linkstate)(struct lagg_port *); 223 void (*sc_init)(struct lagg_softc *); 224 void (*sc_stop)(struct lagg_softc *); 225 void (*sc_lladdr)(struct lagg_softc *); 226 void (*sc_req)(struct lagg_softc *, caddr_t); 227 void (*sc_portreq)(struct lagg_port *, caddr_t); 228 eventhandler_tag vlan_attach; 229 eventhandler_tag vlan_detach; 230 struct callout sc_callout; 231 struct sysctl_ctx_list ctx; /* sysctl variables */ 232 struct sysctl_oid *sc_oid; /* sysctl tree oid */ 233 int use_flowid; /* use M_FLOWID */ 234 }; 235 236 struct lagg_port { 237 struct ifnet *lp_ifp; /* physical interface */ 238 struct lagg_softc *lp_softc; /* parent lagg */ 239 uint8_t lp_lladdr[ETHER_ADDR_LEN]; 240 241 u_char lp_iftype; /* interface type */ 242 uint32_t lp_prio; /* port priority */ 243 uint32_t lp_flags; /* port flags */ 244 int lp_ifflags; /* saved ifp flags */ 245 void *lh_cookie; /* if state hook */ 246 caddr_t lp_psc; /* protocol data */ 247 int lp_detaching; /* ifnet is detaching */ 248 249 SLIST_HEAD(__mclhd, lagg_mc) lp_mc_head; /* multicast addresses */ 250 251 /* Redirected callbacks */ 252 int (*lp_ioctl)(struct ifnet *, u_long, caddr_t); 253 int (*lp_output)(struct ifnet *, struct mbuf *, 254 const struct sockaddr *, struct route *); 255 256 SLIST_ENTRY(lagg_port) lp_entries; 257 }; 258 259 #define LAGG_LOCK_INIT(_sc) rm_init(&(_sc)->sc_mtx, "if_lagg rmlock") 260 #define LAGG_LOCK_DESTROY(_sc) rm_destroy(&(_sc)->sc_mtx) 261 #define LAGG_RLOCK(_sc, _p) rm_rlock(&(_sc)->sc_mtx, (_p)) 262 #define LAGG_WLOCK(_sc) rm_wlock(&(_sc)->sc_mtx) 263 #define LAGG_RUNLOCK(_sc, _p) rm_runlock(&(_sc)->sc_mtx, (_p)) 264 #define LAGG_WUNLOCK(_sc) rm_wunlock(&(_sc)->sc_mtx) 265 #define LAGG_RLOCK_ASSERT(_sc) rm_assert(&(_sc)->sc_mtx, RA_RLOCKED) 266 #define LAGG_WLOCK_ASSERT(_sc) rm_assert(&(_sc)->sc_mtx, RA_WLOCKED) 267 268 #define LAGG_CALLOUT_LOCK_INIT(_sc) \ 269 mtx_init(&(_sc)->sc_call_mtx, "if_lagg callout mutex", NULL,\ 270 MTX_DEF) 271 #define LAGG_CALLOUT_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->sc_call_mtx) 272 273 extern struct mbuf *(*lagg_input_p)(struct ifnet *, struct mbuf *); 274 extern void (*lagg_linkstate_p)(struct ifnet *, int ); 275 276 int lagg_enqueue(struct ifnet *, struct mbuf *); 277 uint32_t lagg_hashmbuf(struct lagg_softc *, struct mbuf *, uint32_t); 278 279 SYSCTL_DECL(_net_link_lagg); 280 281 #endif /* _KERNEL */ 282 283 #endif /* _NET_LAGG_H */ 284