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: stable/11/sys/net/if_lagg.h 362366 2020-06-19 06:35:57Z rpokala $ 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 */ 50typedef enum { 51 LAGG_PROTO_NONE = 0, /* no lagg protocol defined */ 52 LAGG_PROTO_ROUNDROBIN, /* simple round robin */ 53 LAGG_PROTO_FAILOVER, /* active failover */ 54 LAGG_PROTO_LOADBALANCE, /* loadbalance */ 55 LAGG_PROTO_LACP, /* 802.3ad lacp */ 56 LAGG_PROTO_BROADCAST, /* broadcast */ 57 LAGG_PROTO_MAX, 58} lagg_proto; 59 60struct lagg_protos { 61 const char *lpr_name; 62 lagg_proto lpr_proto; 63}; 64 65#define LAGG_PROTO_DEFAULT LAGG_PROTO_FAILOVER 66#define LAGG_PROTOS { \ 67 { "failover", LAGG_PROTO_FAILOVER }, \ 68 { "lacp", LAGG_PROTO_LACP }, \ 69 { "loadbalance", LAGG_PROTO_LOADBALANCE }, \ 70 { "roundrobin", LAGG_PROTO_ROUNDROBIN }, \ 71 { "broadcast", LAGG_PROTO_BROADCAST }, \ 72 { "none", LAGG_PROTO_NONE }, \ 73 { "default", LAGG_PROTO_DEFAULT } \ 74} 75 76/* 77 * lagg ioctls. 78 */ 79 80/* 81 * LACP current operational parameters structure. 82 */ 83struct lacp_opreq { 84 uint16_t actor_prio; 85 uint8_t actor_mac[ETHER_ADDR_LEN]; 86 uint16_t actor_key; 87 uint16_t actor_portprio; 88 uint16_t actor_portno; 89 uint8_t actor_state; 90 uint16_t partner_prio; 91 uint8_t partner_mac[ETHER_ADDR_LEN]; 92 uint16_t partner_key; 93 uint16_t partner_portprio; 94 uint16_t partner_portno; 95 uint8_t partner_state; 96}; 97 98/* lagg port settings */ 99struct lagg_reqport { 100 char rp_ifname[IFNAMSIZ]; /* name of the lagg */ 101 char rp_portname[IFNAMSIZ]; /* name of the port */ 102 u_int32_t rp_prio; /* port priority */ 103 u_int32_t rp_flags; /* port flags */ 104 union { 105 struct lacp_opreq rpsc_lacp; 106 } rp_psc; 107#define rp_lacpreq rp_psc.rpsc_lacp 108}; 109 110#define SIOCGLAGGPORT _IOWR('i', 140, struct lagg_reqport) 111#define SIOCSLAGGPORT _IOW('i', 141, struct lagg_reqport) 112#define SIOCSLAGGDELPORT _IOW('i', 142, struct lagg_reqport) 113 114/* lagg, ports and options */ 115struct lagg_reqall { 116 char ra_ifname[IFNAMSIZ]; /* name of the lagg */ 117 u_int ra_proto; /* lagg protocol */ 118 119 size_t ra_size; /* size of buffer */ 120 struct lagg_reqport *ra_port; /* allocated buffer */ 121 int ra_ports; /* total port count */ 122 union { 123 struct lacp_opreq rpsc_lacp; 124 } ra_psc; 125#define ra_lacpreq ra_psc.rpsc_lacp 126}; 127 128#define SIOCGLAGG _IOWR('i', 143, struct lagg_reqall) 129#define SIOCSLAGG _IOW('i', 144, struct lagg_reqall) 130 131struct lagg_reqflags { 132 char rf_ifname[IFNAMSIZ]; /* name of the lagg */ 133 uint32_t rf_flags; /* lagg protocol */ 134}; 135 136#define SIOCGLAGGFLAGS _IOWR('i', 145, struct lagg_reqflags) 137#define SIOCSLAGGHASH _IOW('i', 146, struct lagg_reqflags) 138 139struct lagg_reqopts { 140 char ro_ifname[IFNAMSIZ]; /* name of the lagg */ 141 142 int ro_opts; /* Option bitmap */ 143#define LAGG_OPT_NONE 0x00 144#define LAGG_OPT_USE_FLOWID 0x01 /* enable use of flowid */ 145/* Pseudo flags which are used in ro_opts but not stored into sc_opts. */ 146#define LAGG_OPT_FLOWIDSHIFT 0x02 /* set flowid shift */ 147#define LAGG_OPT_FLOWIDSHIFT_MASK 0x1f /* flowid is uint32_t */ 148#define LAGG_OPT_LACP_STRICT 0x10 /* LACP strict mode */ 149#define LAGG_OPT_LACP_TXTEST 0x20 /* LACP debug: txtest */ 150#define LAGG_OPT_LACP_RXTEST 0x40 /* LACP debug: rxtest */ 151#define LAGG_OPT_LACP_FAST_TIMO 0x80 /* LACP fast timeout */ 152 u_int ro_count; /* number of ports */ 153 u_int ro_active; /* active port count */ 154 u_int ro_flapping; /* number of flapping */ 155 int ro_flowid_shift; /* shift the flowid */ 156 uint32_t ro_bkt; /* packet bucket for roundrobin */ 157}; 158 159#define SIOCGLAGGOPTS _IOWR('i', 152, struct lagg_reqopts) 160#define SIOCSLAGGOPTS _IOW('i', 153, struct lagg_reqopts) 161 162#define LAGG_OPT_BITS "\020\001USE_FLOWID\005LACP_STRICT" \ 163 "\006LACP_TXTEST\007LACP_RXTEST" \ 164 "\010LACP_FAST_TIMO" 165 166#ifdef _KERNEL 167 168/* 169 * Internal kernel part 170 */ 171 172#define LAGG_PORTACTIVE(_tp) ( \ 173 ((_tp)->lp_ifp->if_link_state == LINK_STATE_UP) && \ 174 ((_tp)->lp_ifp->if_flags & IFF_UP) \ 175) 176 177struct lagg_ifreq { 178 union { 179 struct ifreq ifreq; 180 struct { 181 char ifr_name[IFNAMSIZ]; 182 struct sockaddr_storage ifr_ss; 183 } ifreq_storage; 184 } ifreq; 185}; 186 187#define sc_ifflags sc_ifp->if_flags /* flags */ 188#define sc_ifname sc_ifp->if_xname /* name */ 189 190/* Private data used by the loadbalancing protocol */ 191struct lagg_lb { 192 u_int32_t lb_key; 193 struct lagg_port *lb_ports[LAGG_MAX_PORTS]; 194}; 195 196struct lagg_mc { 197 struct sockaddr_dl mc_addr; 198 struct ifmultiaddr *mc_ifma; 199 SLIST_ENTRY(lagg_mc) mc_entries; 200}; 201 202struct lagg_counters { 203 uint64_t val[IFCOUNTERS]; 204}; 205 206struct lagg_softc { 207 struct ifnet *sc_ifp; /* virtual interface */ 208 struct rmlock sc_mtx; 209 struct sx sc_sx; 210 int sc_proto; /* lagg protocol */ 211 u_int sc_count; /* number of ports */ 212 u_int sc_active; /* active port count */ 213 u_int sc_flapping; /* number of flapping 214 * events */ 215 struct lagg_port *sc_primary; /* primary port */ 216 struct ifmedia sc_media; /* media config */ 217 void *sc_psc; /* protocol data */ 218 uint32_t sc_seq; /* sequence counter */ 219 uint32_t sc_flags; 220 int sc_destroying; /* destroying lagg */ 221 222 SLIST_HEAD(__tplhd, lagg_port) sc_ports; /* list of interfaces */ 223 SLIST_ENTRY(lagg_softc) sc_entries; 224 225 eventhandler_tag vlan_attach; 226 eventhandler_tag vlan_detach; 227 struct callout sc_callout; 228 u_int sc_opts; 229 int flowid_shift; /* shift the flowid */ 230 uint32_t sc_bkt; /* packates bucket for roundrobin */ 231 uint32_t sc_bkt_count; /* packates bucket count for roundrobin */ 232 struct lagg_counters detached_counters; /* detached ports sum */ 233}; 234 235struct lagg_port { 236 struct ifnet *lp_ifp; /* physical interface */ 237 struct lagg_softc *lp_softc; /* parent lagg */ 238 uint8_t lp_lladdr[ETHER_ADDR_LEN]; 239 240 u_char lp_iftype; /* interface type */ 241 uint32_t lp_prio; /* port priority */ 242 uint32_t lp_flags; /* port flags */ 243 int lp_ifflags; /* saved ifp flags */ 244 int lp_ifcapenable; /* saved ifp capenable */ 245 void *lh_cookie; /* if state hook */ 246 void *lp_psc; /* protocol data */ 247 int lp_detaching; /* ifnet is detaching */ 248 SLIST_HEAD(__mclhd, lagg_mc) lp_mc_head; /* multicast addresses */ 249 250 /* Redirected callbacks */ 251 int (*lp_ioctl)(struct ifnet *, u_long, caddr_t); 252 int (*lp_output)(struct ifnet *, struct mbuf *, 253 const struct sockaddr *, struct route *); 254 struct lagg_counters port_counters; /* ifp counters copy */ 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#define LAGG_UNLOCK_ASSERT(_sc) rm_assert(&(_sc)->sc_mtx, RA_UNLOCKED) 268 269#define LAGG_SX_INIT(_sc) sx_init(&(_sc)->sc_sx, "if_lagg sx") 270#define LAGG_SX_DESTROY(_sc) sx_destroy(&(_sc)->sc_sx) 271#define LAGG_SLOCK(_sc) sx_slock(&(_sc)->sc_sx) 272#define LAGG_XLOCK(_sc) sx_xlock(&(_sc)->sc_sx) 273#define LAGG_SUNLOCK(_sc) sx_sunlock(&(_sc)->sc_sx) 274#define LAGG_XUNLOCK(_sc) sx_xunlock(&(_sc)->sc_sx) 275#define LAGG_SXLOCK_ASSERT(_sc) sx_assert(&(_sc)->sc_sx, SA_LOCKED) 276#define LAGG_SLOCK_ASSERT(_sc) sx_assert(&(_sc)->sc_sx, SA_SLOCKED) 277#define LAGG_XLOCK_ASSERT(_sc) sx_assert(&(_sc)->sc_sx, SA_XLOCKED) 278 279extern struct mbuf *(*lagg_input_p)(struct ifnet *, struct mbuf *); 280extern void (*lagg_linkstate_p)(struct ifnet *, int ); 281 282int lagg_enqueue(struct ifnet *, struct mbuf *); 283 284SYSCTL_DECL(_net_link_lagg); 285 286#endif /* _KERNEL */ 287 288#endif /* _NET_LAGG_H */ 289