if_lagg.h revision 253687
1167802Sjkim/* $OpenBSD: if_trunk.h,v 1.11 2007/01/31 06:20:19 reyk Exp $ */ 2167802Sjkim 3167802Sjkim/* 4167802Sjkim * Copyright (c) 2005, 2006 Reyk Floeter <reyk@openbsd.org> 5167802Sjkim * 6167802Sjkim * Permission to use, copy, modify, and distribute this software for any 7217365Sjkim * purpose with or without fee is hereby granted, provided that the above 8306536Sjkim * copyright notice and this permission notice appear in all copies. 9167802Sjkim * 10167802Sjkim * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11217365Sjkim * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12217365Sjkim * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13217365Sjkim * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14217365Sjkim * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15217365Sjkim * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16217365Sjkim * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17217365Sjkim * 18217365Sjkim * $FreeBSD: head/sys/net/if_lagg.h 253687 2013-07-26 19:41:13Z adrian $ 19217365Sjkim */ 20217365Sjkim 21217365Sjkim#ifndef _NET_LAGG_H 22217365Sjkim#define _NET_LAGG_H 23217365Sjkim 24217365Sjkim/* 25167802Sjkim * Global definitions 26217365Sjkim */ 27217365Sjkim 28217365Sjkim#define LAGG_MAX_PORTS 32 /* logically */ 29167802Sjkim#define LAGG_MAX_NAMESIZE 32 /* name of a protocol */ 30217365Sjkim#define LAGG_MAX_STACKING 4 /* maximum number of stacked laggs */ 31217365Sjkim 32217365Sjkim/* Lagg flags */ 33217365Sjkim#define LAGG_F_HASHL2 0x00000001 /* hash layer 2 */ 34217365Sjkim#define LAGG_F_HASHL3 0x00000002 /* hash layer 3 */ 35217365Sjkim#define LAGG_F_HASHL4 0x00000004 /* hash layer 4 */ 36217365Sjkim#define LAGG_F_HASHMASK 0x00000007 37217365Sjkim 38217365Sjkim/* Port flags */ 39217365Sjkim#define LAGG_PORT_SLAVE 0x00000000 /* normal enslaved port */ 40217365Sjkim#define LAGG_PORT_MASTER 0x00000001 /* primary port */ 41217365Sjkim#define LAGG_PORT_STACK 0x00000002 /* stacked lagg port */ 42217365Sjkim#define LAGG_PORT_ACTIVE 0x00000004 /* port is active */ 43167802Sjkim#define LAGG_PORT_COLLECTING 0x00000008 /* port is receiving frames */ 44193529Sjkim#define LAGG_PORT_DISTRIBUTING 0x00000010 /* port is sending frames */ 45193529Sjkim#define LAGG_PORT_DISABLED 0x00000020 /* port is disabled */ 46193529Sjkim#define LAGG_PORT_BITS "\20\01MASTER\02STACK\03ACTIVE\04COLLECTING" \ 47193529Sjkim "\05DISTRIBUTING\06DISABLED" 48209746Sjkim 49209746Sjkim/* Supported lagg PROTOs */ 50167802Sjkim#define LAGG_PROTO_NONE 0 /* no lagg protocol defined */ 51167802Sjkim#define LAGG_PROTO_ROUNDROBIN 1 /* simple round robin */ 52167802Sjkim#define LAGG_PROTO_FAILOVER 2 /* active failover */ 53167802Sjkim#define LAGG_PROTO_LOADBALANCE 3 /* loadbalance */ 54167802Sjkim#define LAGG_PROTO_LACP 4 /* 802.3ad lacp */ 55167802Sjkim#define LAGG_PROTO_ETHERCHANNEL 5 /* Cisco FEC */ 56284460Sjkim#define LAGG_PROTO_MAX 6 57284460Sjkim 58284460Sjkimstruct lagg_protos { 59284460Sjkim const char *lpr_name; 60284460Sjkim int lpr_proto; 61220663Sjkim}; 62220663Sjkim 63220663Sjkim#define LAGG_PROTO_DEFAULT LAGG_PROTO_FAILOVER 64220663Sjkim#define LAGG_PROTOS { \ 65220663Sjkim { "failover", LAGG_PROTO_FAILOVER }, \ 66220663Sjkim { "fec", LAGG_PROTO_ETHERCHANNEL }, \ 67220663Sjkim { "lacp", LAGG_PROTO_LACP }, \ 68167802Sjkim { "loadbalance", LAGG_PROTO_LOADBALANCE }, \ 69167802Sjkim { "roundrobin", LAGG_PROTO_ROUNDROBIN }, \ 70193529Sjkim { "none", LAGG_PROTO_NONE }, \ 71193529Sjkim { "default", LAGG_PROTO_DEFAULT } \ 72193529Sjkim} 73193529Sjkim 74193529Sjkim/* 75193529Sjkim * lagg ioctls. 76193529Sjkim */ 77284460Sjkim 78193529Sjkim/* 79193529Sjkim * LACP current operational parameters structure. 80167802Sjkim */ 81167802Sjkimstruct lacp_opreq { 82167802Sjkim uint16_t actor_prio; 83167802Sjkim uint8_t actor_mac[ETHER_ADDR_LEN]; 84193529Sjkim uint16_t actor_key; 85197104Sjkim uint16_t actor_portprio; 86281075Sdim uint16_t actor_portno; 87284460Sjkim uint8_t actor_state; 88167802Sjkim uint16_t partner_prio; 89167802Sjkim uint8_t partner_mac[ETHER_ADDR_LEN]; 90281075Sdim uint16_t partner_key; 91281075Sdim uint16_t partner_portprio; 92281075Sdim uint16_t partner_portno; 93281075Sdim uint8_t partner_state; 94281075Sdim}; 95281075Sdim 96281075Sdim/* lagg port settings */ 97281075Sdimstruct lagg_reqport { 98281075Sdim char rp_ifname[IFNAMSIZ]; /* name of the lagg */ 99281075Sdim char rp_portname[IFNAMSIZ]; /* name of the port */ 100281075Sdim u_int32_t rp_prio; /* port priority */ 101209746Sjkim u_int32_t rp_flags; /* port flags */ 102209746Sjkim union { 103209746Sjkim struct lacp_opreq rpsc_lacp; 104209746Sjkim } rp_psc; 105209746Sjkim#define rp_lacpreq rp_psc.rpsc_lacp 106209746Sjkim}; 107209746Sjkim 108209746Sjkim#define SIOCGLAGGPORT _IOWR('i', 140, struct lagg_reqport) 109209746Sjkim#define SIOCSLAGGPORT _IOW('i', 141, struct lagg_reqport) 110209746Sjkim#define SIOCSLAGGDELPORT _IOW('i', 142, struct lagg_reqport) 111252279Sjkim 112306536Sjkim/* lagg, ports and options */ 113209746Sjkimstruct lagg_reqall { 114209746Sjkim char ra_ifname[IFNAMSIZ]; /* name of the lagg */ 115209746Sjkim u_int ra_proto; /* lagg protocol */ 116209746Sjkim 117209746Sjkim size_t ra_size; /* size of buffer */ 118209746Sjkim struct lagg_reqport *ra_port; /* allocated buffer */ 119209746Sjkim int ra_ports; /* total port count */ 120209746Sjkim union { 121209746Sjkim struct lacp_opreq rpsc_lacp; 122209746Sjkim } ra_psc; 123252279Sjkim#define ra_lacpreq ra_psc.rpsc_lacp 124209746Sjkim}; 125209746Sjkim 126209746Sjkim#define SIOCGLAGG _IOWR('i', 143, struct lagg_reqall) 127209746Sjkim#define SIOCSLAGG _IOW('i', 144, struct lagg_reqall) 128209746Sjkim 129209746Sjkimstruct lagg_reqflags { 130209746Sjkim char rf_ifname[IFNAMSIZ]; /* name of the lagg */ 131209746Sjkim uint32_t rf_flags; /* lagg protocol */ 132209746Sjkim}; 133209746Sjkim 134209746Sjkim#define SIOCGLAGGFLAGS _IOWR('i', 145, struct lagg_reqflags) 135209746Sjkim#define SIOCSLAGGHASH _IOW('i', 146, struct lagg_reqflags) 136209746Sjkim 137209746Sjkim#ifdef _KERNEL 138209746Sjkim 139209746Sjkim#include <sys/counter.h> 140209746Sjkim 141209746Sjkim/* 142209746Sjkim * Internal kernel part 143209746Sjkim */ 144209746Sjkim 145306536Sjkim#define lp_ifname lp_ifp->if_xname /* interface name */ 146209746Sjkim#define lp_link_state lp_ifp->if_link_state /* link state */ 147209746Sjkim 148209746Sjkim#define LAGG_PORTACTIVE(_tp) ( \ 149209746Sjkim ((_tp)->lp_link_state == LINK_STATE_UP) && \ 150209746Sjkim ((_tp)->lp_ifp->if_flags & IFF_UP) \ 151209746Sjkim) 152209746Sjkim 153209746Sjkimstruct lagg_ifreq { 154209746Sjkim union { 155209746Sjkim struct ifreq ifreq; 156209746Sjkim struct { 157209746Sjkim char ifr_name[IFNAMSIZ]; 158209746Sjkim struct sockaddr_storage ifr_ss; 159209746Sjkim } ifreq_storage; 160209746Sjkim } ifreq; 161209746Sjkim}; 162209746Sjkim 163209746Sjkim#define sc_ifflags sc_ifp->if_flags /* flags */ 164209746Sjkim#define sc_ifname sc_ifp->if_xname /* name */ 165209746Sjkim#define sc_capabilities sc_ifp->if_capabilities /* capabilities */ 166209746Sjkim 167209746Sjkim#define IFCAP_LAGG_MASK 0xffff0000 /* private capabilities */ 168209746Sjkim#define IFCAP_LAGG_FULLDUPLEX 0x00010000 /* full duplex with >1 ports */ 169209746Sjkim 170209746Sjkim/* Private data used by the loadbalancing protocol */ 171209746Sjkimstruct lagg_lb { 172209746Sjkim u_int32_t lb_key; 173281075Sdim struct lagg_port *lb_ports[LAGG_MAX_PORTS]; 174281075Sdim}; 175281075Sdim 176281075Sdimstruct lagg_mc { 177284460Sjkim struct ifmultiaddr *mc_ifma; 178281075Sdim SLIST_ENTRY(lagg_mc) mc_entries; 179281075Sdim}; 180193529Sjkim 181193529Sjkim/* List of interfaces to have the MAC address modified */ 182197104Sjkimstruct lagg_llq { 183197104Sjkim struct ifnet *llq_ifp; 184197104Sjkim uint8_t llq_lladdr[ETHER_ADDR_LEN]; 185197104Sjkim SLIST_ENTRY(lagg_llq) llq_entries; 186197104Sjkim}; 187197104Sjkim 188193529Sjkimstruct lagg_softc { 189193529Sjkim struct ifnet *sc_ifp; /* virtual interface */ 190193529Sjkim struct rwlock sc_mtx; 191193529Sjkim int sc_proto; /* lagg protocol */ 192306536Sjkim u_int sc_count; /* number of ports */ 193284460Sjkim u_int sc_active; /* active port count */ 194193529Sjkim u_int sc_flapping; /* number of flapping 195193529Sjkim * events */ 196193529Sjkim struct lagg_port *sc_primary; /* primary port */ 197193529Sjkim struct ifmedia sc_media; /* media config */ 198193529Sjkim caddr_t sc_psc; /* protocol data */ 199193529Sjkim uint32_t sc_seq; /* sequence counter */ 200193529Sjkim uint32_t sc_flags; 201193529Sjkim 202193529Sjkim counter_u64_t sc_ipackets; 203252279Sjkim counter_u64_t sc_opackets; 204252279Sjkim counter_u64_t sc_ibytes; 205306536Sjkim counter_u64_t sc_obytes; 206306536Sjkim 207306536Sjkim SLIST_HEAD(__tplhd, lagg_port) sc_ports; /* list of interfaces */ 208306536Sjkim SLIST_ENTRY(lagg_softc) sc_entries; 209193529Sjkim 210193529Sjkim struct task sc_lladdr_task; 211193529Sjkim SLIST_HEAD(__llqhd, lagg_llq) sc_llq_head; /* interfaces to program 212167802Sjkim the lladdr on */ 213167802Sjkim 214281075Sdim /* lagg protocol callbacks */ 215281075Sdim int (*sc_detach)(struct lagg_softc *); 216281075Sdim int (*sc_start)(struct lagg_softc *, struct mbuf *); 217281075Sdim struct mbuf *(*sc_input)(struct lagg_softc *, struct lagg_port *, 218281075Sdim struct mbuf *); 219281075Sdim int (*sc_port_create)(struct lagg_port *); 220281075Sdim void (*sc_port_destroy)(struct lagg_port *); 221281075Sdim void (*sc_linkstate)(struct lagg_port *); 222281075Sdim void (*sc_init)(struct lagg_softc *); 223281075Sdim void (*sc_stop)(struct lagg_softc *); 224281075Sdim void (*sc_lladdr)(struct lagg_softc *); 225281075Sdim void (*sc_req)(struct lagg_softc *, caddr_t); 226281075Sdim void (*sc_portreq)(struct lagg_port *, caddr_t); 227281075Sdim eventhandler_tag vlan_attach; 228281075Sdim eventhandler_tag vlan_detach; 229284460Sjkim struct callout sc_callout; 230284460Sjkim struct sysctl_ctx_list ctx; /* sysctl variables */ 231167802Sjkim struct sysctl_oid *sc_oid; /* sysctl tree oid */ 232167802Sjkim int use_flowid; /* use M_FLOWID */ 233284460Sjkim}; 234284460Sjkim 235284460Sjkimstruct lagg_port { 236284460Sjkim struct ifnet *lp_ifp; /* physical interface */ 237284460Sjkim struct lagg_softc *lp_softc; /* parent lagg */ 238284460Sjkim uint8_t lp_lladdr[ETHER_ADDR_LEN]; 239284460Sjkim 240284460Sjkim u_char lp_iftype; /* interface type */ 241284460Sjkim uint32_t lp_prio; /* port priority */ 242284460Sjkim uint32_t lp_flags; /* port flags */ 243284460Sjkim int lp_ifflags; /* saved ifp flags */ 244284460Sjkim void *lh_cookie; /* if state hook */ 245281075Sdim caddr_t lp_psc; /* protocol data */ 246281075Sdim int lp_detaching; /* ifnet is detaching */ 247281075Sdim 248284460Sjkim SLIST_HEAD(__mclhd, lagg_mc) lp_mc_head; /* multicast addresses */ 249306536Sjkim 250284460Sjkim /* Redirected callbacks */ 251281075Sdim int (*lp_ioctl)(struct ifnet *, u_long, caddr_t); 252281075Sdim int (*lp_output)(struct ifnet *, struct mbuf *, 253228110Sjkim const struct sockaddr *, struct route *); 254228110Sjkim 255228110Sjkim SLIST_ENTRY(lagg_port) lp_entries; 256228110Sjkim}; 257228110Sjkim 258284460Sjkim#define LAGG_LOCK_INIT(_sc) rw_init(&(_sc)->sc_mtx, "if_lagg rwlock") 259228110Sjkim#define LAGG_LOCK_DESTROY(_sc) rw_destroy(&(_sc)->sc_mtx) 260228110Sjkim#define LAGG_RLOCK(_sc) rw_rlock(&(_sc)->sc_mtx) 261167802Sjkim#define LAGG_WLOCK(_sc) rw_wlock(&(_sc)->sc_mtx) 262167802Sjkim#define LAGG_RUNLOCK(_sc) rw_runlock(&(_sc)->sc_mtx) 263167802Sjkim#define LAGG_WUNLOCK(_sc) rw_wunlock(&(_sc)->sc_mtx) 264167802Sjkim#define LAGG_RLOCK_ASSERT(_sc) rw_assert(&(_sc)->sc_mtx, RA_RLOCKED) 265193529Sjkim#define LAGG_WLOCK_ASSERT(_sc) rw_assert(&(_sc)->sc_mtx, RA_WLOCKED) 266281075Sdim 267284460Sjkimextern struct mbuf *(*lagg_input_p)(struct ifnet *, struct mbuf *); 268167802Sjkimextern void (*lagg_linkstate_p)(struct ifnet *, int ); 269167802Sjkim 270197104Sjkimint lagg_enqueue(struct ifnet *, struct mbuf *); 271197104Sjkimuint32_t lagg_hashmbuf(struct lagg_softc *, struct mbuf *, uint32_t); 272197104Sjkim 273197104SjkimSYSCTL_DECL(_net_link_lagg); 274284460Sjkim 275197104Sjkim#endif /* _KERNEL */ 276167802Sjkim 277281075Sdim#endif /* _NET_LAGG_H */ 278281075Sdim