Home | History | Annotate | Line # | Download | only in netinet
in_var.h revision 1.46
      1 /*	$NetBSD: in_var.h,v 1.46 2003/06/26 00:43:32 itojun Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Public Access Networks Corporation ("Panix").  It was developed under
      9  * contract to Panix by Eric Haszlakiewicz and Thor Lancelot Simon.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions and the following disclaimer.
     16  * 2. Redistributions in binary form must reproduce the above copyright
     17  *    notice, this list of conditions and the following disclaimer in the
     18  *    documentation and/or other materials provided with the distribution.
     19  * 3. All advertising materials mentioning features or use of this software
     20  *    must display the following acknowledgement:
     21  *	This product includes software developed by the NetBSD
     22  *	Foundation, Inc. and its contributors.
     23  * 4. Neither the name of The NetBSD Foundation nor the names of its
     24  *    contributors may be used to endorse or promote products derived
     25  *    from this software without specific prior written permission.
     26  *
     27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     37  * POSSIBILITY OF SUCH DAMAGE.
     38  */
     39 
     40 /*
     41  * Copyright (c) 1985, 1986, 1993
     42  *	The Regents of the University of California.  All rights reserved.
     43  *
     44  * Redistribution and use in source and binary forms, with or without
     45  * modification, are permitted provided that the following conditions
     46  * are met:
     47  * 1. Redistributions of source code must retain the above copyright
     48  *    notice, this list of conditions and the following disclaimer.
     49  * 2. Redistributions in binary form must reproduce the above copyright
     50  *    notice, this list of conditions and the following disclaimer in the
     51  *    documentation and/or other materials provided with the distribution.
     52  * 3. All advertising materials mentioning features or use of this software
     53  *    must display the following acknowledgement:
     54  *	This product includes software developed by the University of
     55  *	California, Berkeley and its contributors.
     56  * 4. Neither the name of the University nor the names of its contributors
     57  *    may be used to endorse or promote products derived from this software
     58  *    without specific prior written permission.
     59  *
     60  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     61  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     62  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     63  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     64  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     65  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     66  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     67  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     68  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     69  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     70  * SUCH DAMAGE.
     71  *
     72  *	@(#)in_var.h	8.2 (Berkeley) 1/9/95
     73  */
     74 
     75 #ifndef _NETINET_IN_VAR_H_
     76 #define _NETINET_IN_VAR_H_
     77 
     78 #include <sys/queue.h>
     79 
     80 /*
     81  * Interface address, Internet version.  One of these structures
     82  * is allocated for each interface with an Internet address.
     83  * The ifaddr structure contains the protocol-independent part
     84  * of the structure and is assumed to be first.
     85  */
     86 struct in_ifaddr {
     87 	struct	ifaddr ia_ifa;		/* protocol-independent info */
     88 #define	ia_ifp		ia_ifa.ifa_ifp
     89 #define ia_flags	ia_ifa.ifa_flags
     90 					/* ia_{,sub}net{,mask} in host order */
     91 	u_int32_t ia_net;		/* network number of interface */
     92 	u_int32_t ia_netmask;		/* mask of net part */
     93 	u_int32_t ia_subnet;		/* subnet number, including net */
     94 	u_int32_t ia_subnetmask;	/* mask of subnet part */
     95 	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
     96 	LIST_ENTRY(in_ifaddr) ia_hash;	/* entry in bucket of inet addresses */
     97 	TAILQ_ENTRY(in_ifaddr) ia_list;	/* list of internet addresses */
     98 	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
     99 	struct	sockaddr_in ia_dstaddr;	/* reserve space for broadcast addr */
    100 #define	ia_broadaddr	ia_dstaddr
    101 	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
    102 	LIST_HEAD(, in_multi) ia_multiaddrs; /* list of multicast addresses */
    103 	struct	in_multi *ia_allhosts;	/* multicast address record for
    104 					   the allhosts multicast group */
    105 	LIST_HEAD(, inpcb) ia_inpcbs;	/* list of pcbs with this source */
    106 };
    107 
    108 struct	in_aliasreq {
    109 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    110 	struct	sockaddr_in ifra_addr;
    111 	struct	sockaddr_in ifra_dstaddr;
    112 #define	ifra_broadaddr	ifra_dstaddr
    113 	struct	sockaddr_in ifra_mask;
    114 };
    115 /*
    116  * Given a pointer to an in_ifaddr (ifaddr),
    117  * return a pointer to the addr as a sockaddr_in.
    118  */
    119 #define	IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
    120 
    121 
    122 #ifdef	_KERNEL
    123 #ifndef IN_IFADDR_HASH_SIZE
    124 #define IN_IFADDR_HASH_SIZE 509	/* 61, 127, 251, 509, 1021, 2039 are good */
    125 #endif
    126 #ifndef IN_MULTI_HASH_SIZE
    127 #define IN_MULTI_HASH_SIZE 509	/* 61, 127, 251, 509, 1021, 2039 are good */
    128 #endif
    129 
    130 /*
    131  * This is a bit unconventional, and wastes a little bit of space, but
    132  * because we want a very even hash function we don't use & in_ifaddrhash
    133  * here, but rather % the hash size, which should obviously be prime.
    134  */
    135 
    136 #define	IN_IFADDR_HASH(x) in_ifaddrhashtbl[(u_long)(x) % IN_IFADDR_HASH_SIZE]
    137 #define IN_MULTI_HASH(x, ifp) \
    138 	(in_multihashtbl[(u_long)((x) ^ (ifp->if_index)) % IN_MULTI_HASH_SIZE])
    139 
    140 LIST_HEAD(in_ifaddrhashhead, in_ifaddr);	/* Type of the hash head */
    141 TAILQ_HEAD(in_ifaddrhead, in_ifaddr);		/* Type of the list head */
    142 LIST_HEAD(in_multihashhead, in_multi);		/* Type of the hash head */
    143 LIST_HEAD(in_multihead, in_multi);		/* Type of the list head */
    144 
    145 
    146 extern	u_long in_ifaddrhash;			/* size of hash table - 1 */
    147 extern	int	in_ifaddrentries;		/* total number of addrs */
    148 extern  struct in_ifaddrhashhead *in_ifaddrhashtbl;	/* Hash table head */
    149 extern  struct in_ifaddrhead in_ifaddr;		/* List head (in ip_input) */
    150 
    151 extern	u_long in_multihash;			/* size of hash table - 1 */
    152 extern	int	in_multientries;		/* total number of addrs */
    153 extern  struct in_multihashhead *in_multihashtbl;	/* Hash table head */
    154 extern  struct in_multihead in_multi;		/* List head (in ip_input) */
    155 
    156 extern	struct	ifqueue	ipintrq;		/* ip packet input queue */
    157 extern	const	int	inetctlerrmap[];
    158 
    159 
    160 /*
    161  * Macro for finding whether an internet address (in_addr) belongs to one
    162  * of our interfaces (in_ifaddr).  NULL if the address isn't ours.
    163  *
    164  * Note that even if we find an interface with the address we're looking
    165  * for, we should skip that interface if it is not up.
    166  */
    167 #define INADDR_TO_IA(addr, ia) \
    168 	/* struct in_addr addr; */ \
    169 	/* struct in_ifaddr *ia; */ \
    170 { \
    171 	LIST_FOREACH(ia, &IN_IFADDR_HASH((addr).s_addr), ia_hash) { \
    172 		if (in_hosteq(ia->ia_addr.sin_addr, (addr)) && \
    173 		    (ia->ia_ifp->if_flags & IFF_UP) != 0) \
    174 			break; \
    175 	} \
    176 }
    177 
    178 /*
    179  * Macro for finding the next in_ifaddr structure with the same internet
    180  * address as ia. Call only with a valid ia pointer.
    181  * Will set ia to NULL if none found.
    182  */
    183 
    184 #define NEXT_IA_WITH_SAME_ADDR(ia) \
    185 	/* struct in_ifaddr *ia; */ \
    186 { \
    187 	struct in_addr addr; \
    188 	addr = ia->ia_addr.sin_addr; \
    189 	do { \
    190 		ia = LIST_NEXT(ia, ia_hash); \
    191 	} while ((ia != NULL) && !in_hosteq(ia->ia_addr.sin_addr, addr)); \
    192 }
    193 
    194 /*
    195  * Macro for finding the interface (ifnet structure) corresponding to one
    196  * of our IP addresses.
    197  */
    198 #define INADDR_TO_IFP(addr, ifp) \
    199 	/* struct in_addr addr; */ \
    200 	/* struct ifnet *ifp; */ \
    201 { \
    202 	struct in_ifaddr *ia; \
    203 \
    204 	INADDR_TO_IA(addr, ia); \
    205 	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
    206 }
    207 
    208 /*
    209  * Macro for finding an internet address structure (in_ifaddr) corresponding
    210  * to a given interface (ifnet structure).
    211  */
    212 #define IFP_TO_IA(ifp, ia) \
    213 	/* struct ifnet *ifp; */ \
    214 	/* struct in_ifaddr *ia; */ \
    215 { \
    216 	struct ifaddr *ifa; \
    217 \
    218 	TAILQ_FOREACH(ifa, &(ifp)->if_addrlist, ifa_list) { \
    219 		if (ifa->ifa_addr->sa_family == AF_INET) \
    220 			break; \
    221 	} \
    222 	(ia) = ifatoia(ifa); \
    223 }
    224 #endif
    225 
    226 /*
    227  * Per-interface router version information.
    228  */
    229 struct router_info {
    230 	LIST_ENTRY(router_info) rti_link;
    231 	struct	ifnet *rti_ifp;
    232 	int	rti_type;	/* type of router on this interface */
    233 	int	rti_age;	/* time since last v1 query */
    234 };
    235 
    236 /*
    237  * Internet multicast address structure.  There is one of these for each IP
    238  * multicast group to which this host belongs on a given network interface.
    239  * They are kept in a linked list, rooted in the interface's in_ifaddr
    240  * structure.
    241  */
    242 struct in_multi {
    243 	LIST_ENTRY(in_multi) inm_list;	/* list of multicast addresses */
    244 	struct	router_info *inm_rti;	/* router version info */
    245 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
    246 	struct	in_addr inm_addr;	/* IP multicast address */
    247 	u_int	inm_refcount;		/* no. membership claims by sockets */
    248 	u_int	inm_timer;		/* IGMP membership report timer */
    249 	u_int	inm_state;		/* state of membership */
    250 };
    251 
    252 #ifdef _KERNEL
    253 /*
    254  * Structure used by macros below to remember position when stepping through
    255  * all of the in_multi records.
    256  */
    257 struct in_multistep {
    258 	struct in_multi *i_inm;
    259 };
    260 
    261 /*
    262  * Macro for looking up the in_multi record for a given IP multicast address
    263  * on a given interface.  If no matching record is found, "inm" returns NULL.
    264  */
    265 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
    266 	/* struct in_addr addr; */ \
    267 	/* struct ifnet *ifp; */ \
    268 	/* struct in_multi *inm; */ \
    269 { \
    270 	LIST_FOREACH((inm), &IN_MULTI_HASH(((addr).s_addr), (ifp)), inm_list) {\
    271 		if (in_hosteq((inm)->inm_addr, (addr)) && \
    272 		    (inm)->inm_ifp == (ifp)) \
    273 			break; \
    274 	} \
    275 }
    276 
    277 /*
    278  * Macro to step through all of the in_multi records, one at a time.
    279  * The current position is remembered in "step", which the caller must
    280  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
    281  * and get the first record.  Both macros return a NULL "inm" when there
    282  * are no remaining records.
    283  */
    284 #define IN_NEXT_MULTI(step, inm) \
    285 	/* struct in_multistep  step; */ \
    286 	/* struct in_multi *inm; */ \
    287 { \
    288 	if (((inm) = (step).i_inm) != NULL) \
    289 		(step).i_inm = LIST_NEXT((inm), inm_list); \
    290 }
    291 
    292 #define IN_FIRST_MULTI(step, inm) \
    293 	/* struct in_multistep step; */ \
    294 	/* struct in_multi *inm; */ \
    295 { \
    296 	(step).i_inm = LIST_FIRST(&in_multi); \
    297 	IN_NEXT_MULTI((step), (inm)); \
    298 }
    299 
    300 struct ifaddr;
    301 
    302 int	in_ifinit __P((struct ifnet *,
    303 	    struct in_ifaddr *, struct sockaddr_in *, int));
    304 void	in_savemkludge __P((struct in_ifaddr *));
    305 void	in_restoremkludge __P((struct in_ifaddr *, struct ifnet *));
    306 void	in_purgemkludge __P((struct ifnet *));
    307 struct	in_multi *in_addmulti __P((struct in_addr *, struct ifnet *));
    308 void	in_delmulti __P((struct in_multi *));
    309 void	in_ifscrub __P((struct ifnet *, struct in_ifaddr *));
    310 void	in_setmaxmtu __P((void));
    311 const char *in_fmtaddr __P((struct in_addr));
    312 int	in_control __P((struct socket *, u_long, caddr_t, struct ifnet *,
    313 	    struct proc *));
    314 void	in_purgeaddr __P((struct ifaddr *, struct ifnet *));
    315 void	in_purgeif __P((struct ifnet *));
    316 void	ip_input __P((struct mbuf *));
    317 int	ipflow_fastforward __P((struct mbuf *));
    318 
    319 #endif
    320 
    321 /* INET6 stuff */
    322 #include <netinet6/in6_var.h>
    323 
    324 #endif /* _NETINET_IN_VAR_H_ */
    325