xref: /original-bsd/sys/net/if.h (revision 79386b64)
1 /*
2  * Copyright (c) 1982, 1986 Regents of the University of California.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms are permitted
6  * provided that the above copyright notice and this paragraph are
7  * duplicated in all such forms and that any documentation,
8  * advertising materials, and other materials related to such
9  * distribution and use acknowledge that the software was developed
10  * by the University of California, Berkeley.  The name of the
11  * University may not be used to endorse or promote products derived
12  * from this software without specific prior written permission.
13  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
14  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
15  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
16  *
17  *	@(#)if.h	7.4 (Berkeley) 10/12/88
18  */
19 
20 /*
21  * Structures defining a network interface, providing a packet
22  * transport mechanism (ala level 0 of the PUP protocols).
23  *
24  * Each interface accepts output datagrams of a specified maximum
25  * length, and provides higher level routines with input datagrams
26  * received from its medium.
27  *
28  * Output occurs when the routine if_output is called, with three parameters:
29  *	(*ifp->if_output)(ifp, m, dst)
30  * Here m is the mbuf chain to be sent and dst is the destination address.
31  * The output routine encapsulates the supplied datagram if necessary,
32  * and then transmits it on its medium.
33  *
34  * On input, each interface unwraps the data received by it, and either
35  * places it on the input queue of a internetwork datagram routine
36  * and posts the associated software interrupt, or passes the datagram to a raw
37  * packet input routine.
38  *
39  * Routines exist for locating interfaces by their addresses
40  * or for locating a interface on a certain network, as well as more general
41  * routing and gateway routines maintaining information used to locate
42  * interfaces.  These routines live in the files if.c and route.c
43  */
44 
45 /*
46  * Structure defining a queue for a network interface.
47  *
48  * (Would like to call this struct ``if'', but C isn't PL/1.)
49  */
50 struct ifnet {
51 	char	*if_name;		/* name, e.g. ``en'' or ``lo'' */
52 	short	if_unit;		/* sub-unit for lower level driver */
53 	short	if_mtu;			/* maximum transmission unit */
54 	short	if_flags;		/* up/down, broadcast, etc. */
55 	short	if_timer;		/* time 'til if_watchdog called */
56 	int	if_metric;		/* routing metric (external only) */
57 	struct	ifaddr *if_addrlist;	/* linked list of addresses per if */
58 	struct	ifqueue {
59 		struct	mbuf *ifq_head;
60 		struct	mbuf *ifq_tail;
61 		int	ifq_len;
62 		int	ifq_maxlen;
63 		int	ifq_drops;
64 	} if_snd;			/* output queue */
65 /* procedure handles */
66 	int	(*if_init)();		/* init routine */
67 	int	(*if_output)();		/* output routine (enqueue) */
68 	int	(*if_start)();		/* initiate output routine */
69 	int	(*if_done)();		/* output complete routine */
70 	int	(*if_ioctl)();		/* ioctl routine */
71 	int	(*if_reset)();		/* bus reset routine */
72 	int	(*if_watchdog)();	/* timer routine */
73 /* generic interface statistics */
74 	int	if_ipackets;		/* packets received on interface */
75 	int	if_ierrors;		/* input errors on interface */
76 	int	if_opackets;		/* packets sent on interface */
77 	int	if_oerrors;		/* output errors on interface */
78 	int	if_collisions;		/* collisions on csma interfaces */
79 /* end statistics */
80 	struct	ifnet *if_next;
81 };
82 
83 #define	IFF_UP		0x1		/* interface is up */
84 #define	IFF_BROADCAST	0x2		/* broadcast address valid */
85 #define	IFF_DEBUG	0x4		/* turn on debugging */
86 #define	IFF_LOOPBACK	0x8		/* is a loopback net */
87 #define	IFF_POINTOPOINT	0x10		/* interface is point-to-point link */
88 #define	IFF_NOTRAILERS	0x20		/* avoid use of trailers */
89 #define	IFF_RUNNING	0x40		/* resources allocated */
90 #define	IFF_NOARP	0x80		/* no address resolution protocol */
91 /* next two not supported now, but reserved: */
92 #define	IFF_PROMISC	0x100		/* receive all packets */
93 #define	IFF_ALLMULTI	0x200		/* receive all multicast packets */
94 #define	IFF_OACTIVE	0x400		/* transmission in progress */
95 #define	IFF_SIMPLEX	0x800		/* can't hear own transmissions */
96 
97 /* flags set internally only: */
98 #define	IFF_CANTCHANGE	(IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE)
99 
100 /*
101  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
102  * input routines have queues of messages stored on ifqueue structures
103  * (defined above).  Entries are added to and deleted from these structures
104  * by these macros, which should be called with ipl raised to splimp().
105  */
106 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
107 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
108 #define	IF_ENQUEUE(ifq, m) { \
109 	(m)->m_act = 0; \
110 	if ((ifq)->ifq_tail == 0) \
111 		(ifq)->ifq_head = m; \
112 	else \
113 		(ifq)->ifq_tail->m_act = m; \
114 	(ifq)->ifq_tail = m; \
115 	(ifq)->ifq_len++; \
116 }
117 #define	IF_PREPEND(ifq, m) { \
118 	(m)->m_act = (ifq)->ifq_head; \
119 	if ((ifq)->ifq_tail == 0) \
120 		(ifq)->ifq_tail = (m); \
121 	(ifq)->ifq_head = (m); \
122 	(ifq)->ifq_len++; \
123 }
124 #define	IF_DEQUEUE(ifq, m) { \
125 	(m) = (ifq)->ifq_head; \
126 	if (m) { \
127 		if (((ifq)->ifq_head = (m)->m_act) == 0) \
128 			(ifq)->ifq_tail = 0; \
129 		(m)->m_act = 0; \
130 		(ifq)->ifq_len--; \
131 	} \
132 }
133 
134 #define	IFQ_MAXLEN	50
135 #define	IFNET_SLOWHZ	1		/* granularity is 1 second */
136 
137 /*
138  * The ifaddr structure contains information about one address
139  * of an interface.  They are maintained by the different address families,
140  * are allocated and attached when an address is set, and are linked
141  * together so all addresses for an interface can be located.
142  */
143 struct ifaddr {
144 	struct	sockaddr ifa_addr;	/* address of interface */
145 	union {
146 		struct	sockaddr ifu_broadaddr;
147 		struct	sockaddr ifu_dstaddr;
148 	} ifa_ifu;
149 #define	ifa_broadaddr	ifa_ifu.ifu_broadaddr	/* broadcast address */
150 #define	ifa_dstaddr	ifa_ifu.ifu_dstaddr	/* other end of p-to-p link */
151 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
152 	struct	ifaddr *ifa_next;	/* next address for interface */
153 };
154 
155 /*
156  * Interface request structure used for socket
157  * ioctl's.  All interface ioctl's must have parameter
158  * definitions which begin with ifr_name.  The
159  * remainder may be interface specific.
160  */
161 struct	ifreq {
162 #define	IFNAMSIZ	16
163 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
164 	union {
165 		struct	sockaddr ifru_addr;
166 		struct	sockaddr ifru_dstaddr;
167 		struct	sockaddr ifru_broadaddr;
168 		short	ifru_flags;
169 		int	ifru_metric;
170 		caddr_t	ifru_data;
171 	} ifr_ifru;
172 #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
173 #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
174 #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
175 #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
176 #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
177 #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
178 };
179 
180 /*
181  * Structure used in SIOCGIFCONF request.
182  * Used to retrieve interface configuration
183  * for machine (useful for programs which
184  * must know all networks accessible).
185  */
186 struct	ifconf {
187 	int	ifc_len;		/* size of associated buffer */
188 	union {
189 		caddr_t	ifcu_buf;
190 		struct	ifreq *ifcu_req;
191 	} ifc_ifcu;
192 #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
193 #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
194 };
195 
196 #ifdef KERNEL
197 #include "../net/if_arp.h"
198 struct	ifqueue rawintrq;		/* raw packet input queue */
199 struct	ifnet *ifnet;
200 struct	ifaddr *ifa_ifwithaddr(), *ifa_ifwithnet();
201 struct	ifaddr *ifa_ifwithdstaddr();
202 #else KERNEL
203 #include <net/if_arp.h>
204 #endif KERNEL
205