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