1 /* $OpenBSD: if_var.h,v 1.135 2025/01/24 09:19:07 mvs Exp $ */ 2 /* $NetBSD: if.h,v 1.23 1996/05/07 02:40:27 thorpej Exp $ */ 3 4 /* 5 * Copyright (c) 2012-2013 Henning Brauer <henning@openbsd.org> 6 * Copyright (c) 1982, 1986, 1989, 1993 7 * The Regents of the University of California. All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * @(#)if.h 8.1 (Berkeley) 6/10/93 34 */ 35 36 #ifndef _NET_IF_VAR_H_ 37 #define _NET_IF_VAR_H_ 38 39 #ifdef _KERNEL 40 41 #include <sys/queue.h> 42 #include <sys/mbuf.h> 43 #include <sys/srp.h> 44 #include <sys/refcnt.h> 45 #include <sys/task.h> 46 #include <sys/timeout.h> 47 48 #include <net/ifq.h> 49 50 /* 51 * Structures defining a network interface, providing a packet 52 * transport mechanism (ala level 0 of the PUP protocols). 53 * 54 * Each interface accepts output datagrams of a specified maximum 55 * length, and provides higher level routines with input datagrams 56 * received from its medium. 57 * 58 * Output occurs when the routine if_output is called, with four parameters: 59 * (*ifp->if_output)(ifp, m, dst, rt) 60 * Here m is the mbuf chain to be sent and dst is the destination address. 61 * The output routine encapsulates the supplied datagram if necessary, 62 * and then transmits it on its medium. 63 * 64 * On input, each interface unwraps the data received by it, and either 65 * places it on the input queue of an internetwork datagram routine 66 * and posts the associated software interrupt, or passes the datagram to a raw 67 * packet input routine. 68 * 69 * Routines exist for locating interfaces by their addresses 70 * or for locating an interface on a certain network, as well as more general 71 * routing and gateway routines maintaining information used to locate 72 * interfaces. These routines live in the files if.c and route.c 73 */ 74 75 /* 76 * Locks used to protect struct members in this file: 77 * I immutable after creation 78 * d protection left to the driver 79 * c only used in ioctl or routing socket contexts (kernel lock) 80 * K kernel lock 81 * N net lock 82 * T if_tmplist_lock 83 * 84 * For SRP related structures that allow lock-free reads, the write lock 85 * is indicated below. 86 */ 87 88 struct rtentry; 89 struct ifnet; 90 struct task; 91 struct cpumem; 92 93 /* 94 * Structure describing a `cloning' interface. 95 */ 96 struct if_clone { 97 LIST_ENTRY(if_clone) ifc_list; /* [I] on list of cloners */ 98 const char *ifc_name; /* name of device, e.g. `gif' */ 99 size_t ifc_namelen; /* length of name */ 100 101 int (*ifc_create)(struct if_clone *, int); 102 int (*ifc_destroy)(struct ifnet *); 103 }; 104 105 #define IF_CLONE_INITIALIZER(name, create, destroy) \ 106 { \ 107 .ifc_list = { NULL, NULL }, \ 108 .ifc_name = name, \ 109 .ifc_namelen = sizeof(name) - 1, \ 110 .ifc_create = create, \ 111 .ifc_destroy = destroy, \ 112 } 113 114 enum if_counters { 115 ifc_ipackets, /* packets received on interface */ 116 ifc_ierrors, /* input errors on interface */ 117 ifc_opackets, /* packets sent on interface */ 118 ifc_oerrors, /* output errors on interface */ 119 ifc_collisions, /* collisions on csma interfaces */ 120 ifc_ibytes, /* total number of octets received */ 121 ifc_obytes, /* total number of octets sent */ 122 ifc_imcasts, /* packets received via multicast */ 123 ifc_omcasts, /* packets sent via multicast */ 124 ifc_iqdrops, /* dropped on input, this interface */ 125 ifc_oqdrops, /* dropped on output, this interface */ 126 ifc_noproto, /* destined for unsupported protocol */ 127 128 ifc_ncounters 129 }; 130 131 /* 132 * Structure defining a queue for a network interface. 133 * 134 * (Would like to call this struct ``if'', but C isn't PL/1.) 135 */ 136 TAILQ_HEAD(ifnet_head, ifnet); /* the actual queue head */ 137 138 struct ifnet { /* and the entries */ 139 void *if_softc; /* [I] lower-level data for this if */ 140 struct refcnt if_refcnt; 141 TAILQ_ENTRY(ifnet) if_list; /* [NK] all struct ifnets are chained */ 142 TAILQ_ENTRY(ifnet) if_tmplist; /* [T] temporary list */ 143 TAILQ_HEAD(, ifaddr) if_addrlist; /* [N] list of addresses per if */ 144 TAILQ_HEAD(, ifmaddr) if_maddrlist; /* [N] list of multicast records */ 145 TAILQ_HEAD(, ifg_list) if_groups; /* [N] list of groups per if */ 146 struct task_list if_addrhooks; /* [I] address change callbacks */ 147 struct task_list if_linkstatehooks; /* [I] link change callbacks*/ 148 struct task_list if_detachhooks; /* [I] detach callbacks */ 149 /* [I] check or clean routes (+ or -)'d */ 150 void (*if_rtrequest)(struct ifnet *, int, struct rtentry *); 151 char if_xname[IFNAMSIZ]; /* [I] external name (name + unit) */ 152 int if_pcount; /* [N] # of promiscuous listeners */ 153 unsigned int if_bridgeidx; /* [K] used by bridge ports */ 154 caddr_t if_bpf; /* packet filter structure */ 155 caddr_t if_mcast; /* used by multicast code */ 156 caddr_t if_mcast6; /* used by IPv6 multicast code */ 157 caddr_t if_pf_kif; /* pf interface abstraction */ 158 union { 159 struct srpl carp_s; /* carp if list (used by !carp ifs) */ 160 unsigned int carp_idx; /* index of carpdev (used by carp 161 ifs) */ 162 } if_carp_ptr; 163 #define if_carp if_carp_ptr.carp_s 164 #define if_carpdevidx if_carp_ptr.carp_idx 165 unsigned int if_index; /* [I] unique index for this if */ 166 short if_timer; /* time 'til if_watchdog called */ 167 unsigned short if_flags; /* [N] up/down, broadcast, etc. */ 168 int if_xflags; /* [N] extra softnet flags */ 169 170 /* Stats and other data about if. Should be in sync with if_data. */ 171 u_char if_type; 172 u_char if_addrlen; 173 u_char if_hdrlen; 174 u_char if_link_state; 175 uint32_t if_mtu; 176 uint32_t if_metric; 177 uint64_t if_baudrate; 178 uint32_t if_capabilities; 179 uint32_t if_rdomain; 180 struct timeval if_lastchange; /* [c] last op. state change */ 181 uint64_t if_data_counters[ifc_ncounters]; 182 183 struct cpumem *if_counters; /* per cpu stats */ 184 uint32_t if_hardmtu; /* [d] maximum MTU device supports */ 185 char if_description[IFDESCRSIZE]; /* [c] interface description */ 186 u_short if_rtlabelid; /* [c] next route label */ 187 uint8_t if_priority; /* [c] route priority offset */ 188 uint8_t if_llprio; /* [N] link layer priority */ 189 struct timeout if_slowtimo; /* [I] watchdog timeout */ 190 struct task if_watchdogtask; /* [I] watchdog task */ 191 struct task if_linkstatetask; /* [I] task to do route updates */ 192 193 /* procedure handles */ 194 void (*if_input)(struct ifnet *, struct mbuf *); 195 int (*if_bpf_mtap)(caddr_t, const struct mbuf *, u_int); 196 int (*if_output)(struct ifnet *, struct mbuf *, struct sockaddr *, 197 struct rtentry *); /* output routine (enqueue) */ 198 /* link level output function */ 199 int (*if_ll_output)(struct ifnet *, struct mbuf *, 200 struct sockaddr *, struct rtentry *); 201 int (*if_enqueue)(struct ifnet *, struct mbuf *); 202 void (*if_start)(struct ifnet *); /* initiate output */ 203 int (*if_ioctl)(struct ifnet *, u_long, caddr_t); /* ioctl hook */ 204 void (*if_watchdog)(struct ifnet *); /* timer routine */ 205 int (*if_wol)(struct ifnet *, int); /* WoL routine **/ 206 207 /* queues */ 208 struct ifqueue if_snd; /* transmit queue */ 209 struct ifqueue **if_ifqs; /* [I] pointer to an array of sndqs */ 210 void (*if_qstart)(struct ifqueue *); 211 unsigned int if_nifqs; /* [I] number of output queues */ 212 unsigned int if_txmit; /* [c] txmitigation amount */ 213 214 struct ifiqueue if_rcv; /* rx/input queue */ 215 struct ifiqueue **if_iqs; /* [I] pointer to the array of iqs */ 216 unsigned int if_niqs; /* [I] number of input queues */ 217 218 struct sockaddr_dl *if_sadl; /* [N] pointer to our sockaddr_dl */ 219 220 struct nd_ifinfo *if_nd; /* [I] IPv6 Neighbor Discovery info */ 221 }; 222 223 #define if_ipackets if_data_counters[ifc_ipackets] 224 #define if_ierrors if_data_counters[ifc_ierrors] 225 #define if_opackets if_data_counters[ifc_opackets] 226 #define if_oerrors if_data_counters[ifc_oerrors] 227 #define if_collisions if_data_counters[ifc_collisions] 228 #define if_ibytes if_data_counters[ifc_ibytes] 229 #define if_obytes if_data_counters[ifc_obytes] 230 #define if_imcasts if_data_counters[ifc_imcasts] 231 #define if_omcasts if_data_counters[ifc_omcasts] 232 #define if_iqdrops if_data_counters[ifc_iqdrops] 233 #define if_oqdrops if_data_counters[ifc_oqdrops] 234 #define if_noproto if_data_counters[ifc_noproto] 235 236 /* 237 * The ifaddr structure contains information about one address 238 * of an interface. They are maintained by the different address families, 239 * are allocated and attached when an address is set, and are linked 240 * together so all addresses for an interface can be located. 241 */ 242 struct ifaddr { 243 struct sockaddr *ifa_addr; /* address of interface */ 244 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 245 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 246 struct sockaddr *ifa_netmask; /* used to determine subnet */ 247 struct ifnet *ifa_ifp; /* back-pointer to interface */ 248 TAILQ_ENTRY(ifaddr) ifa_list; /* [N] list of addresses for 249 interface */ 250 u_int ifa_flags; /* interface flags, see below */ 251 struct refcnt ifa_refcnt; /* number of `rt_ifa` references */ 252 int ifa_metric; /* cost of going out this interface */ 253 }; 254 255 #define IFA_ROUTE 0x01 /* Auto-magically installed route */ 256 257 /* 258 * Interface multicast address. 259 */ 260 struct ifmaddr { 261 struct sockaddr *ifma_addr; /* Protocol address */ 262 unsigned int ifma_ifidx; /* Index of the interface */ 263 struct refcnt ifma_refcnt; /* Count of references */ 264 TAILQ_ENTRY(ifmaddr) ifma_list; /* Per-interface list */ 265 }; 266 267 /* 268 * interface groups 269 */ 270 271 struct ifg_group { 272 char ifg_group[IFNAMSIZ]; /* [I] group name */ 273 u_int ifg_refcnt; /* [N] group reference count */ 274 caddr_t ifg_pf_kif; /* [I] pf interface group */ 275 int ifg_carp_demoted; /* [K] carp demotion counter */ 276 TAILQ_HEAD(, ifg_member) ifg_members; /* [N] list of members per group */ 277 TAILQ_ENTRY(ifg_group) ifg_next; /* [N] all groups are chained */ 278 279 struct refcnt ifg_tmprefcnt; 280 TAILQ_ENTRY(ifg_group) ifg_tmplist; /* [T] temporary list */ 281 }; 282 283 struct ifg_member { 284 TAILQ_ENTRY(ifg_member) ifgm_next; /* [N] all members are chained */ 285 struct ifnet *ifgm_ifp; /* [I] member interface */ 286 }; 287 288 struct ifg_list { 289 struct ifg_group *ifgl_group; /* [I] interface group */ 290 TAILQ_ENTRY(ifg_list) ifgl_next; /* [N] all groups are chained */ 291 }; 292 293 #define IFNET_SLOWTIMO 1 /* granularity is 1 second */ 294 295 #define IF_TXMIT_MIN 1 296 #define IF_TXMIT_DEFAULT 16 297 298 /* default interface priorities */ 299 #define IF_WIRED_DEFAULT_PRIORITY 0 300 #define IF_WIRELESS_DEFAULT_PRIORITY 4 301 #define IF_WWAN_DEFAULT_PRIORITY 6 302 #define IF_CARP_DEFAULT_PRIORITY 15 303 304 /* 305 * Network stack input queues. 306 */ 307 struct niqueue { 308 struct mbuf_queue ni_q; 309 u_int ni_isr; 310 }; 311 312 #define NIQUEUE_INITIALIZER(_len, _isr) \ 313 { MBUF_QUEUE_INITIALIZER((_len), IPL_NET), (_isr) } 314 315 void niq_init(struct niqueue *, u_int, u_int); 316 int niq_enqueue(struct niqueue *, struct mbuf *); 317 int niq_enlist(struct niqueue *, struct mbuf_list *); 318 319 #define niq_dequeue(_q) mq_dequeue(&(_q)->ni_q) 320 #define niq_dechain(_q) mq_dechain(&(_q)->ni_q) 321 #define niq_delist(_q, _ml) mq_delist(&(_q)->ni_q, (_ml)) 322 #define niq_len(_q) mq_len(&(_q)->ni_q) 323 #define niq_drops(_q) mq_drops(&(_q)->ni_q) 324 #define sysctl_niq(_n, _l, _op, _olp, _np, _nl, _niq) \ 325 sysctl_mq((_n), (_l), (_op), (_olp), (_np), (_nl), &(_niq)->ni_q) 326 327 extern struct ifnet_head ifnetlist; 328 329 void if_start(struct ifnet *); 330 int if_enqueue(struct ifnet *, struct mbuf *); 331 int if_enqueue_ifq(struct ifnet *, struct mbuf *); 332 void if_input(struct ifnet *, struct mbuf_list *); 333 void if_vinput(struct ifnet *, struct mbuf *); 334 void if_input_process(struct ifnet *, struct mbuf_list *); 335 int if_input_local(struct ifnet *, struct mbuf *, sa_family_t); 336 int if_output_ml(struct ifnet *, struct mbuf_list *, 337 struct sockaddr *, struct rtentry *); 338 int if_output_mq(struct ifnet *, struct mbuf_queue *, unsigned int *, 339 struct sockaddr *, struct rtentry *); 340 int if_output_tso(struct ifnet *, struct mbuf **, struct sockaddr *, 341 struct rtentry *, u_int); 342 int if_output_local(struct ifnet *, struct mbuf *, sa_family_t); 343 void if_rtrequest_dummy(struct ifnet *, int, struct rtentry *); 344 void p2p_rtrequest(struct ifnet *, int, struct rtentry *); 345 void p2p_input(struct ifnet *, struct mbuf *); 346 int p2p_bpf_mtap(caddr_t, const struct mbuf *, u_int); 347 348 struct ifaddr *ifa_ifwithaddr(const struct sockaddr *, u_int); 349 struct ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, u_int); 350 struct ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *); 351 struct ifaddr *ifaref(struct ifaddr *); 352 void ifafree(struct ifaddr *); 353 354 int if_isconnected(const struct ifnet *, unsigned int); 355 356 void if_clone_attach(struct if_clone *); 357 358 int if_clone_create(const char *, int); 359 int if_clone_destroy(const char *); 360 361 struct if_clone * 362 if_clone_lookup(const char *, int *); 363 364 void ifa_add(struct ifnet *, struct ifaddr *); 365 void ifa_del(struct ifnet *, struct ifaddr *); 366 void ifa_update_broadaddr(struct ifnet *, struct ifaddr *, 367 struct sockaddr *); 368 369 void if_addrhook_add(struct ifnet *, struct task *); 370 void if_addrhook_del(struct ifnet *, struct task *); 371 void if_addrhooks_run(struct ifnet *); 372 void if_linkstatehook_add(struct ifnet *, struct task *); 373 void if_linkstatehook_del(struct ifnet *, struct task *); 374 void if_detachhook_add(struct ifnet *, struct task *); 375 void if_detachhook_del(struct ifnet *, struct task *); 376 377 void if_rxr_livelocked(struct if_rxring *); 378 void if_rxr_init(struct if_rxring *, u_int, u_int); 379 u_int if_rxr_get(struct if_rxring *, u_int); 380 381 #define if_rxr_put(_r, _c) do { (_r)->rxr_alive -= (_c); } while (0) 382 #define if_rxr_needrefill(_r) ((_r)->rxr_alive < (_r)->rxr_lwm) 383 #define if_rxr_inuse(_r) ((_r)->rxr_alive) 384 #define if_rxr_cwm(_r) ((_r)->rxr_cwm) 385 386 int if_rxr_info_ioctl(struct if_rxrinfo *, u_int, struct if_rxring_info *); 387 int if_rxr_ioctl(struct if_rxrinfo *, const char *, u_int, 388 struct if_rxring *); 389 390 void if_counters_alloc(struct ifnet *); 391 void if_counters_free(struct ifnet *); 392 393 int if_txhprio_l2_check(int); 394 int if_txhprio_l3_check(int); 395 int if_rxhprio_l2_check(int); 396 int if_rxhprio_l3_check(int); 397 398 #endif /* _KERNEL */ 399 400 #endif /* _NET_IF_VAR_H_ */ 401