xref: /freebsd/sys/net/if_var.h (revision c1eb4109f3b1d90a9c1538179ea6a52a191899b2)
1  /*-
2   * Copyright (c) 1982, 1986, 1989, 1993
3   *	The Regents of the University of California.  All rights reserved.
4   *
5   * Redistribution and use in source and binary forms, with or without
6   * modification, are permitted provided that the following conditions
7   * are met:
8   * 1. Redistributions of source code must retain the above copyright
9   *    notice, this list of conditions and the following disclaimer.
10   * 2. Redistributions in binary form must reproduce the above copyright
11   *    notice, this list of conditions and the following disclaimer in the
12   *    documentation and/or other materials provided with the distribution.
13   * 4. Neither the name of the University nor the names of its contributors
14   *    may be used to endorse or promote products derived from this software
15   *    without specific prior written permission.
16   *
17   * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20   * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23   * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25   * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26   * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27   * SUCH DAMAGE.
28   *
29   *	From: @(#)if.h	8.1 (Berkeley) 6/10/93
30   * $FreeBSD$
31   */
32  
33  #ifndef	_NET_IF_VAR_H_
34  #define	_NET_IF_VAR_H_
35  
36  /*
37   * Structures defining a network interface, providing a packet
38   * transport mechanism (ala level 0 of the PUP protocols).
39   *
40   * Each interface accepts output datagrams of a specified maximum
41   * length, and provides higher level routines with input datagrams
42   * received from its medium.
43   *
44   * Output occurs when the routine if_output is called, with three parameters:
45   *	(*ifp->if_output)(ifp, m, dst, rt)
46   * Here m is the mbuf chain to be sent and dst is the destination address.
47   * The output routine encapsulates the supplied datagram if necessary,
48   * and then transmits it on its medium.
49   *
50   * On input, each interface unwraps the data received by it, and either
51   * places it on the input queue of an internetwork datagram routine
52   * and posts the associated software interrupt, or passes the datagram to a raw
53   * packet input routine.
54   *
55   * Routines exist for locating interfaces by their addresses
56   * or for locating an interface on a certain network, as well as more general
57   * routing and gateway routines maintaining information used to locate
58   * interfaces.  These routines live in the files if.c and route.c
59   */
60  
61  struct	rtentry;		/* ifa_rtrequest */
62  struct	rt_addrinfo;		/* ifa_rtrequest */
63  struct	socket;
64  struct	carp_if;
65  struct	carp_softc;
66  struct  ifvlantrunk;
67  struct	route;			/* if_output */
68  struct	vnet;
69  struct	ifmedia;
70  struct	netmap_adapter;
71  
72  #ifdef _KERNEL
73  #include <sys/mbuf.h>		/* ifqueue only? */
74  #include <sys/buf_ring.h>
75  #include <net/vnet.h>
76  #endif /* _KERNEL */
77  #include <sys/counter.h>
78  #include <sys/lock.h>		/* XXX */
79  #include <sys/mutex.h>		/* struct ifqueue */
80  #include <sys/rwlock.h>		/* XXX */
81  #include <sys/sx.h>		/* XXX */
82  #include <sys/_task.h>		/* if_link_task */
83  
84  #define	IF_DUNIT_NONE	-1
85  
86  #include <net/altq/if_altq.h>
87  
88  TAILQ_HEAD(ifnethead, ifnet);	/* we use TAILQs so that the order of */
89  TAILQ_HEAD(ifaddrhead, ifaddr);	/* instantiation is preserved in the list */
90  TAILQ_HEAD(ifmultihead, ifmultiaddr);
91  TAILQ_HEAD(ifgrouphead, ifg_group);
92  
93  #ifdef _KERNEL
94  VNET_DECLARE(struct pfil_head, link_pfil_hook);	/* packet filter hooks */
95  #define	V_link_pfil_hook	VNET(link_pfil_hook)
96  #endif /* _KERNEL */
97  
98  typedef enum {
99  	IFCOUNTER_IPACKETS = 0,
100  	IFCOUNTER_IERRORS,
101  	IFCOUNTER_OPACKETS,
102  	IFCOUNTER_OERRORS,
103  	IFCOUNTER_COLLISIONS,
104  	IFCOUNTER_IBYTES,
105  	IFCOUNTER_OBYTES,
106  	IFCOUNTER_IMCASTS,
107  	IFCOUNTER_OMCASTS,
108  	IFCOUNTER_IQDROPS,
109  	IFCOUNTER_OQDROPS,
110  	IFCOUNTER_NOPROTO,
111  	IFCOUNTERS /* Array size. */
112  } ift_counter;
113  
114  typedef struct ifnet * if_t;
115  
116  typedef	void (*if_start_fn_t)(if_t);
117  typedef	int (*if_ioctl_fn_t)(if_t, u_long, caddr_t);
118  typedef	void (*if_init_fn_t)(void *);
119  typedef void (*if_qflush_fn_t)(if_t);
120  typedef int (*if_transmit_fn_t)(if_t, struct mbuf *);
121  typedef	uint64_t (*if_get_counter_t)(if_t, ift_counter);
122  
123  struct ifnet_hw_tsomax {
124  	u_int	tsomaxbytes;	/* TSO total burst length limit in bytes */
125  	u_int	tsomaxsegcount;	/* TSO maximum segment count */
126  	u_int	tsomaxsegsize;	/* TSO maximum segment size in bytes */
127  };
128  
129  /*
130   * Structure defining a network interface.
131   *
132   * Size ILP32:  592 (approx)
133   *	 LP64: 1048 (approx)
134   */
135  struct ifnet {
136  	/* General book keeping of interface lists. */
137  	TAILQ_ENTRY(ifnet) if_link; 	/* all struct ifnets are chained */
138  	LIST_ENTRY(ifnet) if_clones;	/* interfaces of a cloner */
139  	TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
140  					/* protected by if_addr_lock */
141  	u_char	if_alloctype;		/* if_type at time of allocation */
142  
143  	/* Driver and protocol specific information that remains stable. */
144  	void	*if_softc;		/* pointer to driver state */
145  	void	*if_llsoftc;		/* link layer softc */
146  	void	*if_l2com;		/* pointer to protocol bits */
147  	const char *if_dname;		/* driver name */
148  	int	if_dunit;		/* unit or IF_DUNIT_NONE */
149  	u_short	if_index;		/* numeric abbreviation for this if  */
150  	short	if_index_reserved;	/* spare space to grow if_index */
151  	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
152  	char	*if_description;	/* interface description */
153  
154  	/* Variable fields that are touched by the stack and drivers. */
155  	int	if_flags;		/* up/down, broadcast, etc. */
156  	int	if_drv_flags;		/* driver-managed status flags */
157  	int	if_capabilities;	/* interface features & capabilities */
158  	int	if_capenable;		/* enabled features & capabilities */
159  	void	*if_linkmib;		/* link-type-specific MIB data */
160  	size_t	if_linkmiblen;		/* length of above data */
161  	u_int	if_refcount;		/* reference count */
162  
163  	/* These fields are shared with struct if_data. */
164  	uint8_t		if_type;	/* ethernet, tokenring, etc */
165  	uint8_t		if_addrlen;	/* media address length */
166  	uint8_t		if_hdrlen;	/* media header length */
167  	uint8_t		if_link_state;	/* current link state */
168  	uint32_t	if_mtu;		/* maximum transmission unit */
169  	uint32_t	if_metric;	/* routing metric (external only) */
170  	uint64_t	if_baudrate;	/* linespeed */
171  	uint64_t	if_hwassist;	/* HW offload capabilities, see IFCAP */
172  	time_t		if_epoch;	/* uptime at attach or stat reset */
173  	struct timeval	if_lastchange;	/* time of last administrative change */
174  
175  	struct  ifaltq if_snd;		/* output queue (includes altq) */
176  	struct	task if_linktask;	/* task for link change events */
177  
178  	/* Addresses of different protocol families assigned to this if. */
179  	struct	rwlock if_addr_lock;	/* lock to protect address lists */
180  		/*
181  		 * if_addrhead is the list of all addresses associated to
182  		 * an interface.
183  		 * Some code in the kernel assumes that first element
184  		 * of the list has type AF_LINK, and contains sockaddr_dl
185  		 * addresses which store the link-level address and the name
186  		 * of the interface.
187  		 * However, access to the AF_LINK address through this
188  		 * field is deprecated. Use if_addr or ifaddr_byindex() instead.
189  		 */
190  	struct	ifaddrhead if_addrhead;	/* linked list of addresses per if */
191  	struct	ifmultihead if_multiaddrs; /* multicast addresses configured */
192  	int	if_amcount;		/* number of all-multicast requests */
193  	struct	ifaddr	*if_addr;	/* pointer to link-level address */
194  	const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
195  	struct	rwlock if_afdata_lock;
196  	void	*if_afdata[AF_MAX];
197  	int	if_afdata_initialized;
198  
199  	/* Additional features hung off the interface. */
200  	u_int	if_fib;			/* interface FIB */
201  	struct	vnet *if_vnet;		/* pointer to network stack instance */
202  	struct	vnet *if_home_vnet;	/* where this ifnet originates from */
203  	struct  ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
204  	struct	bpf_if *if_bpf;		/* packet filter structure */
205  	int	if_pcount;		/* number of promiscuous listeners */
206  	void	*if_bridge;		/* bridge glue */
207  	void	*if_lagg;		/* lagg glue */
208  	void	*if_pf_kif;		/* pf glue */
209  	struct	carp_if *if_carp;	/* carp interface structure */
210  	struct	label *if_label;	/* interface MAC label */
211  	struct	netmap_adapter *if_netmap; /* netmap(4) softc */
212  
213  	/* Various procedures of the layer2 encapsulation and drivers. */
214  	int	(*if_output)		/* output routine (enqueue) */
215  		(struct ifnet *, struct mbuf *, const struct sockaddr *,
216  		     struct route *);
217  	void	(*if_input)		/* input routine (from h/w driver) */
218  		(struct ifnet *, struct mbuf *);
219  	if_start_fn_t	if_start;	/* initiate output routine */
220  	if_ioctl_fn_t	if_ioctl;	/* ioctl routine */
221  	if_init_fn_t	if_init;	/* Init routine */
222  	int	(*if_resolvemulti)	/* validate/resolve multicast */
223  		(struct ifnet *, struct sockaddr **, struct sockaddr *);
224  	if_qflush_fn_t	if_qflush;	/* flush any queue */
225  	if_transmit_fn_t if_transmit;   /* initiate output routine */
226  
227  	void	(*if_reassign)		/* reassign to vnet routine */
228  		(struct ifnet *, struct vnet *, char *);
229  	if_get_counter_t if_get_counter; /* get counter values */
230  
231  	/* Statistics. */
232  	counter_u64_t	if_counters[IFCOUNTERS];
233  
234  	/* Stuff that's only temporary and doesn't belong here. */
235  
236  	/*
237  	 * Network adapter TSO limits:
238  	 * ===========================
239  	 *
240  	 * If the "if_hw_tsomax" field is zero the maximum segment
241  	 * length limit does not apply. If the "if_hw_tsomaxsegcount"
242  	 * or the "if_hw_tsomaxsegsize" field is zero the TSO segment
243  	 * count limit does not apply. If all three fields are zero,
244  	 * there is no TSO limit.
245  	 *
246  	 * NOTE: The TSO limits only apply to the data payload part of
247  	 * a TCP/IP packet. That means there is no need to subtract
248  	 * space for ethernet-, vlan-, IP- or TCP- headers from the
249  	 * TSO limits unless the hardware driver in question requires
250  	 * so.
251  	 */
252  	u_int	if_hw_tsomax;		/* TSO maximum size in bytes */
253  	u_int	if_hw_tsomaxsegcount;	/* TSO maximum segment count */
254  	u_int	if_hw_tsomaxsegsize;	/* TSO maximum segment size in bytes */
255  
256  	/*
257  	 * Spare fields to be added before branching a stable branch, so
258  	 * that structure can be enhanced without changing the kernel
259  	 * binary interface.
260  	 */
261  };
262  
263  /* for compatibility with other BSDs */
264  #define	if_addrlist	if_addrhead
265  #define	if_list		if_link
266  #define	if_name(ifp)	((ifp)->if_xname)
267  
268  /*
269   * Locks for address lists on the network interface.
270   */
271  #define	IF_ADDR_LOCK_INIT(if)	rw_init(&(if)->if_addr_lock, "if_addr_lock")
272  #define	IF_ADDR_LOCK_DESTROY(if)	rw_destroy(&(if)->if_addr_lock)
273  #define	IF_ADDR_WLOCK(if)	rw_wlock(&(if)->if_addr_lock)
274  #define	IF_ADDR_WUNLOCK(if)	rw_wunlock(&(if)->if_addr_lock)
275  #define	IF_ADDR_RLOCK(if)	rw_rlock(&(if)->if_addr_lock)
276  #define	IF_ADDR_RUNLOCK(if)	rw_runlock(&(if)->if_addr_lock)
277  #define	IF_ADDR_LOCK_ASSERT(if)	rw_assert(&(if)->if_addr_lock, RA_LOCKED)
278  #define	IF_ADDR_WLOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_WLOCKED)
279  
280  /*
281   * Function variations on locking macros intended to be used by loadable
282   * kernel modules in order to divorce them from the internals of address list
283   * locking.
284   */
285  void	if_addr_rlock(struct ifnet *ifp);	/* if_addrhead */
286  void	if_addr_runlock(struct ifnet *ifp);	/* if_addrhead */
287  void	if_maddr_rlock(if_t ifp);	/* if_multiaddrs */
288  void	if_maddr_runlock(if_t ifp);	/* if_multiaddrs */
289  
290  #ifdef _KERNEL
291  #ifdef _SYS_EVENTHANDLER_H_
292  /* interface link layer address change event */
293  typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
294  EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
295  /* interface address change event */
296  typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
297  EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
298  /* new interface arrival event */
299  typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
300  EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
301  /* interface departure event */
302  typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
303  EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
304  /* Interface link state change event */
305  typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
306  EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
307  #endif /* _SYS_EVENTHANDLER_H_ */
308  
309  /*
310   * interface groups
311   */
312  struct ifg_group {
313  	char				 ifg_group[IFNAMSIZ];
314  	u_int				 ifg_refcnt;
315  	void				*ifg_pf_kif;
316  	TAILQ_HEAD(, ifg_member)	 ifg_members;
317  	TAILQ_ENTRY(ifg_group)		 ifg_next;
318  };
319  
320  struct ifg_member {
321  	TAILQ_ENTRY(ifg_member)	 ifgm_next;
322  	struct ifnet		*ifgm_ifp;
323  };
324  
325  struct ifg_list {
326  	struct ifg_group	*ifgl_group;
327  	TAILQ_ENTRY(ifg_list)	 ifgl_next;
328  };
329  
330  #ifdef _SYS_EVENTHANDLER_H_
331  /* group attach event */
332  typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
333  EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
334  /* group detach event */
335  typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
336  EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
337  /* group change event */
338  typedef void (*group_change_event_handler_t)(void *, const char *);
339  EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
340  #endif /* _SYS_EVENTHANDLER_H_ */
341  
342  #define	IF_AFDATA_LOCK_INIT(ifp)	\
343  	rw_init(&(ifp)->if_afdata_lock, "if_afdata")
344  
345  #define	IF_AFDATA_WLOCK(ifp)	rw_wlock(&(ifp)->if_afdata_lock)
346  #define	IF_AFDATA_RLOCK(ifp)	rw_rlock(&(ifp)->if_afdata_lock)
347  #define	IF_AFDATA_WUNLOCK(ifp)	rw_wunlock(&(ifp)->if_afdata_lock)
348  #define	IF_AFDATA_RUNLOCK(ifp)	rw_runlock(&(ifp)->if_afdata_lock)
349  #define	IF_AFDATA_LOCK(ifp)	IF_AFDATA_WLOCK(ifp)
350  #define	IF_AFDATA_UNLOCK(ifp)	IF_AFDATA_WUNLOCK(ifp)
351  #define	IF_AFDATA_TRYLOCK(ifp)	rw_try_wlock(&(ifp)->if_afdata_lock)
352  #define	IF_AFDATA_DESTROY(ifp)	rw_destroy(&(ifp)->if_afdata_lock)
353  
354  #define	IF_AFDATA_LOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
355  #define	IF_AFDATA_RLOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_RLOCKED)
356  #define	IF_AFDATA_WLOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_WLOCKED)
357  #define	IF_AFDATA_UNLOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
358  
359  /*
360   * 72 was chosen below because it is the size of a TCP/IP
361   * header (40) + the minimum mss (32).
362   */
363  #define	IF_MINMTU	72
364  #define	IF_MAXMTU	65535
365  
366  #define	TOEDEV(ifp)	((ifp)->if_llsoftc)
367  
368  /*
369   * The ifaddr structure contains information about one address
370   * of an interface.  They are maintained by the different address families,
371   * are allocated and attached when an address is set, and are linked
372   * together so all addresses for an interface can be located.
373   *
374   * NOTE: a 'struct ifaddr' is always at the beginning of a larger
375   * chunk of malloc'ed memory, where we store the three addresses
376   * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
377   */
378  struct ifaddr {
379  	struct	sockaddr *ifa_addr;	/* address of interface */
380  	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
381  #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
382  	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
383  	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
384  	struct	carp_softc *ifa_carp;	/* pointer to CARP data */
385  	TAILQ_ENTRY(ifaddr) ifa_link;	/* queue macro glue */
386  	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
387  		(int, struct rtentry *, struct rt_addrinfo *);
388  	u_short	ifa_flags;		/* mostly rt_flags for cloning */
389  #define	IFA_ROUTE	RTF_UP		/* route installed */
390  #define	IFA_RTSELF	RTF_HOST	/* loopback route to self installed */
391  	u_int	ifa_refcnt;		/* references to this structure */
392  
393  	counter_u64_t	ifa_ipackets;
394  	counter_u64_t	ifa_opackets;
395  	counter_u64_t	ifa_ibytes;
396  	counter_u64_t	ifa_obytes;
397  };
398  
399  /* For compatibility with other BSDs. SCTP uses it. */
400  #define	ifa_list	ifa_link
401  
402  struct ifaddr *	ifa_alloc(size_t size, int flags);
403  void	ifa_free(struct ifaddr *ifa);
404  void	ifa_ref(struct ifaddr *ifa);
405  
406  /*
407   * Multicast address structure.  This is analogous to the ifaddr
408   * structure except that it keeps track of multicast addresses.
409   */
410  struct ifmultiaddr {
411  	TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
412  	struct	sockaddr *ifma_addr; 	/* address this membership is for */
413  	struct	sockaddr *ifma_lladdr;	/* link-layer translation, if any */
414  	struct	ifnet *ifma_ifp;	/* back-pointer to interface */
415  	u_int	ifma_refcount;		/* reference count */
416  	void	*ifma_protospec;	/* protocol-specific state, if any */
417  	struct	ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
418  };
419  
420  extern	struct rwlock ifnet_rwlock;
421  extern	struct sx ifnet_sxlock;
422  
423  #define	IFNET_WLOCK() do {						\
424  	sx_xlock(&ifnet_sxlock);					\
425  	rw_wlock(&ifnet_rwlock);					\
426  } while (0)
427  
428  #define	IFNET_WUNLOCK() do {						\
429  	rw_wunlock(&ifnet_rwlock);					\
430  	sx_xunlock(&ifnet_sxlock);					\
431  } while (0)
432  
433  /*
434   * To assert the ifnet lock, you must know not only whether it's for read or
435   * write, but also whether it was acquired with sleep support or not.
436   */
437  #define	IFNET_RLOCK_ASSERT()		sx_assert(&ifnet_sxlock, SA_SLOCKED)
438  #define	IFNET_RLOCK_NOSLEEP_ASSERT()	rw_assert(&ifnet_rwlock, RA_RLOCKED)
439  #define	IFNET_WLOCK_ASSERT() do {					\
440  	sx_assert(&ifnet_sxlock, SA_XLOCKED);				\
441  	rw_assert(&ifnet_rwlock, RA_WLOCKED);				\
442  } while (0)
443  
444  #define	IFNET_RLOCK()		sx_slock(&ifnet_sxlock)
445  #define	IFNET_RLOCK_NOSLEEP()	rw_rlock(&ifnet_rwlock)
446  #define	IFNET_RUNLOCK()		sx_sunlock(&ifnet_sxlock)
447  #define	IFNET_RUNLOCK_NOSLEEP()	rw_runlock(&ifnet_rwlock)
448  
449  /*
450   * Look up an ifnet given its index; the _ref variant also acquires a
451   * reference that must be freed using if_rele().  It is almost always a bug
452   * to call ifnet_byindex() instead if ifnet_byindex_ref().
453   */
454  struct ifnet	*ifnet_byindex(u_short idx);
455  struct ifnet	*ifnet_byindex_locked(u_short idx);
456  struct ifnet	*ifnet_byindex_ref(u_short idx);
457  
458  /*
459   * Given the index, ifaddr_byindex() returns the one and only
460   * link-level ifaddr for the interface. You are not supposed to use
461   * it to traverse the list of addresses associated to the interface.
462   */
463  struct ifaddr	*ifaddr_byindex(u_short idx);
464  
465  VNET_DECLARE(struct ifnethead, ifnet);
466  VNET_DECLARE(struct ifgrouphead, ifg_head);
467  VNET_DECLARE(int, if_index);
468  VNET_DECLARE(struct ifnet *, loif);	/* first loopback interface */
469  
470  #define	V_ifnet		VNET(ifnet)
471  #define	V_ifg_head	VNET(ifg_head)
472  #define	V_if_index	VNET(if_index)
473  #define	V_loif		VNET(loif)
474  
475  int	if_addgroup(struct ifnet *, const char *);
476  int	if_delgroup(struct ifnet *, const char *);
477  int	if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
478  int	if_allmulti(struct ifnet *, int);
479  struct	ifnet* if_alloc(u_char);
480  void	if_attach(struct ifnet *);
481  void	if_dead(struct ifnet *);
482  int	if_delmulti(struct ifnet *, struct sockaddr *);
483  void	if_delmulti_ifma(struct ifmultiaddr *);
484  void	if_detach(struct ifnet *);
485  void	if_vmove(struct ifnet *, struct vnet *);
486  void	if_purgeaddrs(struct ifnet *);
487  void	if_delallmulti(struct ifnet *);
488  void	if_down(struct ifnet *);
489  struct ifmultiaddr *
490  	if_findmulti(struct ifnet *, const struct sockaddr *);
491  void	if_free(struct ifnet *);
492  void	if_initname(struct ifnet *, const char *, int);
493  void	if_link_state_change(struct ifnet *, int);
494  int	if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
495  void	if_ref(struct ifnet *);
496  void	if_rele(struct ifnet *);
497  int	if_setlladdr(struct ifnet *, const u_char *, int);
498  void	if_up(struct ifnet *);
499  int	ifioctl(struct socket *, u_long, caddr_t, struct thread *);
500  int	ifpromisc(struct ifnet *, int);
501  struct	ifnet *ifunit(const char *);
502  struct	ifnet *ifunit_ref(const char *);
503  
504  int	ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
505  int	ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
506  int	ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *, int fib);
507  
508  struct	ifaddr *ifa_ifwithaddr(const struct sockaddr *);
509  int		ifa_ifwithaddr_check(const struct sockaddr *);
510  struct	ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int);
511  struct	ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int);
512  struct	ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int);
513  struct	ifaddr *ifa_ifwithroute(int, const struct sockaddr *, struct sockaddr *,
514      u_int);
515  struct	ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
516  int	ifa_preferred(struct ifaddr *, struct ifaddr *);
517  
518  int	if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
519  
520  typedef	void *if_com_alloc_t(u_char type, struct ifnet *ifp);
521  typedef	void if_com_free_t(void *com, u_char type);
522  void	if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
523  void	if_deregister_com_alloc(u_char type);
524  void	if_data_copy(struct ifnet *, struct if_data *);
525  uint64_t if_get_counter_default(struct ifnet *, ift_counter);
526  void	if_inc_counter(struct ifnet *, ift_counter, int64_t);
527  
528  #define IF_LLADDR(ifp)							\
529      LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
530  
531  uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate);
532  uint64_t if_getbaudrate(if_t ifp);
533  int if_setcapabilities(if_t ifp, int capabilities);
534  int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit);
535  int if_getcapabilities(if_t ifp);
536  int if_togglecapenable(if_t ifp, int togglecap);
537  int if_setcapenable(if_t ifp, int capenable);
538  int if_setcapenablebit(if_t ifp, int setcap, int clearcap);
539  int if_getcapenable(if_t ifp);
540  const char *if_getdname(if_t ifp);
541  int if_setdev(if_t ifp, void *dev);
542  int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
543  int if_getdrvflags(if_t ifp);
544  int if_setdrvflags(if_t ifp, int flags);
545  int if_clearhwassist(if_t ifp);
546  int if_sethwassistbits(if_t ifp, int toset, int toclear);
547  int if_sethwassist(if_t ifp, int hwassist_bit);
548  int if_gethwassist(if_t ifp);
549  int if_setsoftc(if_t ifp, void *softc);
550  void *if_getsoftc(if_t ifp);
551  int if_setflags(if_t ifp, int flags);
552  int if_setmtu(if_t ifp, int mtu);
553  int if_getmtu(if_t ifp);
554  int if_getmtu_family(if_t ifp, int family);
555  int if_setflagbits(if_t ifp, int set, int clear);
556  int if_getflags(if_t ifp);
557  int if_sendq_empty(if_t ifp);
558  int if_setsendqready(if_t ifp);
559  int if_setsendqlen(if_t ifp, int tx_desc_count);
560  int if_input(if_t ifp, struct mbuf* sendmp);
561  int if_sendq_prepend(if_t ifp, struct mbuf *m);
562  struct mbuf *if_dequeue(if_t ifp);
563  int if_setifheaderlen(if_t ifp, int len);
564  void if_setrcvif(struct mbuf *m, if_t ifp);
565  void if_setvtag(struct mbuf *m, u_int16_t tag);
566  u_int16_t if_getvtag(struct mbuf *m);
567  int if_vlantrunkinuse(if_t ifp);
568  caddr_t if_getlladdr(if_t ifp);
569  void *if_gethandle(u_char);
570  void if_bpfmtap(if_t ifp, struct mbuf *m);
571  void if_etherbpfmtap(if_t ifp, struct mbuf *m);
572  void if_vlancap(if_t ifp);
573  
574  int if_setupmultiaddr(if_t ifp, void *mta, int *cnt, int max);
575  int if_multiaddr_array(if_t ifp, void *mta, int *cnt, int max);
576  int if_multiaddr_count(if_t ifp, int max);
577  
578  int if_getamcount(if_t ifp);
579  struct ifaddr * if_getifaddr(if_t ifp);
580  
581  /* Functions */
582  void if_setinitfn(if_t ifp, void (*)(void *));
583  void if_setioctlfn(if_t ifp, int (*)(if_t, u_long, caddr_t));
584  void if_setstartfn(if_t ifp, void (*)(if_t));
585  void if_settransmitfn(if_t ifp, if_transmit_fn_t);
586  void if_setqflushfn(if_t ifp, if_qflush_fn_t);
587  void if_setgetcounterfn(if_t ifp, if_get_counter_t);
588  
589  /* Revisit the below. These are inline functions originally */
590  int drbr_inuse_drv(if_t ifp, struct buf_ring *br);
591  struct mbuf* drbr_dequeue_drv(if_t ifp, struct buf_ring *br);
592  int drbr_needs_enqueue_drv(if_t ifp, struct buf_ring *br);
593  int drbr_enqueue_drv(if_t ifp, struct buf_ring *br, struct mbuf *m);
594  
595  /* TSO */
596  void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *);
597  int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *);
598  
599  #ifdef DEVICE_POLLING
600  enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
601  
602  typedef	int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count);
603  int    ether_poll_register(poll_handler_t *h, if_t ifp);
604  int    ether_poll_deregister(if_t ifp);
605  #endif /* DEVICE_POLLING */
606  
607  #endif /* _KERNEL */
608  
609  #include <net/ifq.h>	/* XXXAO: temporary unconditional include */
610  
611  #endif /* !_NET_IF_VAR_H_ */
612