if_laggproto.h revision 1.6
1/* $NetBSD: if_laggproto.h,v 1.6 2021/09/30 04:29:17 yamaguchi Exp $ */ 2 3/* 4 * Copyright (c) 2021 Internet Initiative Japan Inc. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29#ifndef _NET_LAGG_IF_LAGGPROTO_H_ 30#define _NET_LAGG_IF_LAGGPROTO_H_ 31 32struct lagg_softc; 33struct lagg_proto_softc; 34 35#define LAGG_MAX_PORTS 32 36#define LAGG_PORT_PRIO 0x8000U 37 38enum lagg_work_state { 39 LAGG_WORK_IDLE, 40 LAGG_WORK_ENQUEUED, 41 LAGG_WORK_STOPPING 42}; 43struct lagg_work { 44 struct work lw_cookie; 45 void (*lw_func)(struct lagg_work *, void *); 46 void *lw_arg; 47 int lw_state; 48}; 49 50static inline void 51lagg_work_set(struct lagg_work *w, 52 void (*func)(struct lagg_work *, void *), void *arg) 53{ 54 55 w->lw_func = func; 56 w->lw_arg = arg; 57} 58 59struct workqueue * 60 lagg_workq_create(const char *, pri_t, int, int); 61void lagg_workq_destroy(struct workqueue *); 62void lagg_workq_add(struct workqueue *, struct lagg_work *); 63void lagg_workq_wait(struct workqueue *, struct lagg_work *); 64 65struct lagg_port { 66 struct psref_target lp_psref; 67 struct ifnet *lp_ifp; /* physical interface */ 68 struct lagg_softc *lp_softc; /* parent lagg */ 69 void *lp_proto_ctx; 70 bool lp_ifdetaching; 71 void *lp_linkstate_hook; 72 void *lp_ifdetach_hook; 73 74 uint32_t lp_prio; /* port priority */ 75 uint32_t lp_flags; /* port flags */ 76 77 u_char lp_iftype; 78 uint8_t lp_lladdr[ETHER_ADDR_LEN]; 79 int (*lp_ioctl)(struct ifnet *, u_long, void *); 80 int (*lp_output)(struct ifnet *, struct mbuf *, 81 const struct sockaddr *, 82 const struct rtentry *); 83 uint64_t lp_ifcapenable; 84 uint64_t lp_mtu; 85 86 SIMPLEQ_ENTRY(lagg_port) 87 lp_entry; 88}; 89 90struct lagg_proto { 91 lagg_proto pr_num; 92 void (*pr_init)(void); 93 void (*pr_fini)(void); 94 int (*pr_attach)(struct lagg_softc *, 95 struct lagg_proto_softc **); 96 void (*pr_detach)(struct lagg_proto_softc *); 97 int (*pr_up)(struct lagg_proto_softc *); 98 void (*pr_down)(struct lagg_proto_softc *); 99 int (*pr_transmit)(struct lagg_proto_softc *, 100 struct mbuf *); 101 struct mbuf * (*pr_input)(struct lagg_proto_softc *, 102 struct lagg_port *, struct mbuf *); 103 int (*pr_allocport)(struct lagg_proto_softc *, 104 struct lagg_port *); 105 void (*pr_freeport)(struct lagg_proto_softc *, 106 struct lagg_port *); 107 void (*pr_startport)(struct lagg_proto_softc *, 108 struct lagg_port *); 109 void (*pr_stopport)(struct lagg_proto_softc *, 110 struct lagg_port *); 111 void (*pr_protostat)(struct lagg_proto_softc *, 112 struct laggreqproto *); 113 void (*pr_portstat)(struct lagg_proto_softc *, 114 struct lagg_port *, struct laggreqport *); 115 void (*pr_linkstate)(struct lagg_proto_softc *, 116 struct lagg_port *); 117 int (*pr_ioctl)(struct lagg_proto_softc *, 118 struct laggreqproto *); 119}; 120 121struct lagg_variant { 122 lagg_proto lv_proto; 123 struct lagg_proto_softc 124 *lv_psc; 125 126 struct psref_target lv_psref; 127}; 128 129struct lagg_mc_entry { 130 LIST_ENTRY(lagg_mc_entry) 131 mc_entry; 132 struct ether_multi *mc_enm; 133 struct sockaddr_storage mc_addr; 134}; 135 136struct lagg_vlantag { 137 uint16_t lvt_vtag; 138 TAILQ_ENTRY(lagg_vlantag) 139 lvt_entry; 140}; 141 142struct lagg_softc { 143 kmutex_t sc_lock; 144 struct ifmedia sc_media; 145 u_char sc_iftype; 146 147 /* interface link-layer address */ 148 uint8_t sc_lladdr[ETHER_ADDR_LEN]; 149 /* generated random lladdr */ 150 uint8_t sc_lladdr_rand[ETHER_ADDR_LEN]; 151 152 LIST_HEAD(, lagg_mc_entry) 153 sc_mclist; 154 TAILQ_HEAD(, lagg_vlantag) 155 sc_vtags; 156 pserialize_t sc_psz; 157 struct lagg_variant *sc_var; 158 SIMPLEQ_HEAD(, lagg_port) 159 sc_ports; 160 size_t sc_nports; 161 char sc_evgroup[16]; 162 struct evcnt sc_novar; 163 164 struct sysctllog *sc_sysctllog; 165 const struct sysctlnode *sc_sysctlnode; 166 bool sc_hash_mac; 167 bool sc_hash_ipaddr; 168 bool sc_hash_ip6addr; 169 bool sc_hash_tcp; 170 bool sc_hash_udp; 171 172 /* 173 * storage size of sc_if is a variable-length, 174 * should be the last 175 */ 176 struct ifnet sc_if; 177}; 178 179/* 180 * Locking notes: 181 * - sc_lock(LAGG_LOCK()) is an adaptive mutex and protects items 182 * of struct lagg_softc 183 * - a lock in struct lagg_proto_softc, for example LACP_LOCK(), is 184 * an adaptive mutex and protects member contained in the struct 185 * - sc_var is protected by both pselialize (sc_psz) and psref (lv_psref) 186 * - Updates of sc_var is serialized by sc_lock 187 * - Items in sc_ports is protected by both psref (lp_psref) and 188 * pserialize contained in struct lagg_proto_softc 189 * - details are discribed in if_laggport.c and if_lagg_lacp.c 190 * - Updates of items in sc_ports are serialized by sc_lock 191 * - an instance referenced by lp_proto_ctx in struct lagg_port is 192 * protected by a lock in struct lagg_proto_softc 193 * 194 * Locking order: 195 * - IFNET_LOCK(sc_if) -> LAGG_LOCK -> ETHER_LOCK(sc_if) -> a lock in 196 * struct lagg_port_softc 197 * - IFNET_LOCK(sc_if) -> LAGG_LOCK -> IFNET_LOCK(lp_ifp) 198 * - Currently, there is no combination of following locks 199 * - IFNET_LOCK(lp_ifp) and a lock in struct lagg_proto_softc 200 * - IFNET_LOCK(lp_ifp) and ETHER_LOCK(sc_if) 201 */ 202#define LAGG_LOCK(_sc) mutex_enter(&(_sc)->sc_lock) 203#define LAGG_UNLOCK(_sc) mutex_exit(&(_sc)->sc_lock) 204#define LAGG_LOCKED(_sc) mutex_owned(&(_sc)->sc_lock) 205#define LAGG_CLLADDR(_sc) CLLADDR((_sc)->sc_if.if_sadl) 206 207#define LAGG_PORTS_FOREACH(_sc, _lp) \ 208 SIMPLEQ_FOREACH((_lp), &(_sc)->sc_ports, lp_entry) 209#define LAGG_PORTS_FIRST(_sc) SIMPLEQ_FIRST(&(_sc)->sc_ports) 210#define LAGG_PORTS_EMPTY(_sc) SIMPLEQ_EMPTY(&(_sc)->sc_ports) 211#define LAGG_PORT_IOCTL(_lp, _cmd, _data) \ 212 (_lp)->lp_ioctl == NULL ? ENOTTY : \ 213 (_lp)->lp_ioctl((_lp)->lp_ifp, (_cmd), (_data)) 214 215 216static inline const void * 217lagg_m_extract(struct mbuf *m, size_t off, size_t reqlen, void *buf) 218{ 219 ssize_t len; 220 const void *rv; 221 222 KASSERT(ISSET(m->m_flags, M_PKTHDR)); 223 len = off + reqlen; 224 225 if (m->m_pkthdr.len < len) { 226 return NULL; 227 } 228 229 if (m->m_len >= len) { 230 rv = mtod(m, uint8_t *) + off; 231 } else { 232 m_copydata(m, off, reqlen, buf); 233 rv = buf; 234 } 235 236 return rv; 237} 238 239static inline int 240lagg_port_xmit(struct lagg_port *lp, struct mbuf *m) 241{ 242 243 return if_transmit_lock(lp->lp_ifp, m); 244} 245 246static inline bool 247lagg_portactive(struct lagg_port *lp) 248{ 249 struct ifnet *ifp; 250 251 ifp = lp->lp_ifp; 252 253 if (ifp->if_link_state != LINK_STATE_DOWN && 254 ISSET(ifp->if_flags, IFF_UP)) { 255 return true; 256 } 257 258 return false; 259} 260 261void lagg_log(struct lagg_softc *, int, const char *, ...) 262 __printflike(3, 4); 263void lagg_port_getref(struct lagg_port *, struct psref *); 264void lagg_port_putref(struct lagg_port *, struct psref *); 265void lagg_enqueue(struct lagg_softc *, 266 struct lagg_port *, struct mbuf *); 267uint32_t lagg_hashmbuf(struct lagg_softc *, struct mbuf *); 268 269void lagg_common_detach(struct lagg_proto_softc *); 270int lagg_common_allocport(struct lagg_proto_softc *, 271 struct lagg_port *); 272void lagg_common_freeport(struct lagg_proto_softc *, 273 struct lagg_port *); 274void lagg_common_startport(struct lagg_proto_softc *, 275 struct lagg_port *); 276void lagg_common_stopport(struct lagg_proto_softc *, 277 struct lagg_port *); 278void lagg_common_linkstate(struct lagg_proto_softc *, 279 struct lagg_port *); 280 281int lagg_none_attach(struct lagg_softc *, 282 struct lagg_proto_softc **); 283int lagg_none_up(struct lagg_proto_softc *); 284 285int lagg_fail_attach(struct lagg_softc *, 286 struct lagg_proto_softc **); 287int lagg_fail_transmit(struct lagg_proto_softc *, struct mbuf *); 288struct mbuf * lagg_fail_input(struct lagg_proto_softc *, struct lagg_port *, 289 struct mbuf *); 290void lagg_fail_portstat(struct lagg_proto_softc *, 291 struct lagg_port *, struct laggreqport *); 292int lagg_fail_ioctl(struct lagg_proto_softc *, 293 struct laggreqproto *); 294 295int lagg_lb_attach(struct lagg_softc *, struct lagg_proto_softc **); 296void lagg_lb_startport(struct lagg_proto_softc *, 297 struct lagg_port *); 298void lagg_lb_stopport(struct lagg_proto_softc *, struct lagg_port *); 299int lagg_lb_transmit(struct lagg_proto_softc *, struct mbuf *); 300struct mbuf * lagg_lb_input(struct lagg_proto_softc *, struct lagg_port *, 301 struct mbuf *); 302void lagg_lb_portstat(struct lagg_proto_softc *, 303 struct lagg_port *, struct laggreqport *); 304 305int lacp_attach(struct lagg_softc *, struct lagg_proto_softc **); 306void lacp_detach(struct lagg_proto_softc *); 307int lacp_up(struct lagg_proto_softc *); 308void lacp_down(struct lagg_proto_softc *); 309int lacp_transmit(struct lagg_proto_softc *, struct mbuf *); 310struct mbuf * lacp_input(struct lagg_proto_softc *, struct lagg_port *, 311 struct mbuf *); 312int lacp_allocport(struct lagg_proto_softc *, struct lagg_port *); 313void lacp_freeport(struct lagg_proto_softc *, struct lagg_port *); 314void lacp_startport(struct lagg_proto_softc *, struct lagg_port *); 315void lacp_stopport(struct lagg_proto_softc *, struct lagg_port *); 316void lacp_protostat(struct lagg_proto_softc *, 317 struct laggreqproto *); 318void lacp_portstat(struct lagg_proto_softc *, struct lagg_port *, 319 struct laggreqport *); 320void lacp_linkstate(struct lagg_proto_softc *, struct lagg_port *); 321int lacp_ioctl(struct lagg_proto_softc *, struct laggreqproto *); 322#endif 323