Home | History | Annotate | Line # | Download | only in netinet
in_var.h revision 1.22
      1 /*	$NetBSD: in_var.h,v 1.22 1998/02/15 18:24:26 tls 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 };
    104 
    105 struct	in_aliasreq {
    106 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    107 	struct	sockaddr_in ifra_addr;
    108 	struct	sockaddr_in ifra_dstaddr;
    109 #define	ifra_broadaddr	ifra_dstaddr
    110 	struct	sockaddr_in ifra_mask;
    111 };
    112 /*
    113  * Given a pointer to an in_ifaddr (ifaddr),
    114  * return a pointer to the addr as a sockaddr_in.
    115  */
    116 #define	IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
    117 
    118 
    119 #ifdef	_KERNEL
    120 #ifndef IN_IFADDR_HASH_SIZE
    121 #define IN_IFADDR_HASH_SIZE 293
    122 #endif
    123 
    124 #define IN_IFADDR_HASH(x) in_ifaddrhashtbl[(u_long)(x) % IN_IFADDR_HASH_SIZE]
    125 
    126 u_long in_ifaddrhash;				/* size of hash table - 1 */
    127 int	in_ifaddrentries;			/* total number of addrs */
    128 LIST_HEAD(in_ifaddrhashhead, in_ifaddr);	/* Type of the hash head */
    129 TAILQ_HEAD(in_ifaddrhead, in_ifaddr);		/* Type of the list head */
    130 
    131 extern  struct in_ifaddrhashhead *in_ifaddrhashtbl;	/* Hash table head */
    132 extern  struct in_ifaddrhead in_ifaddr;		/* List head (in ip_input) */
    133 
    134 extern	struct	ifqueue	ipintrq;		/* ip packet input queue */
    135 void	in_socktrim __P((struct sockaddr_in *));
    136 
    137 
    138 /*
    139  * Macro for finding whether an internet address (in_addr) belongs to one
    140  * of our interfaces (in_ifaddr).  NULL if the address isn't ours.
    141  */
    142 #define INADDR_TO_IA(addr, ia) \
    143 	/* struct in_addr addr; */ \
    144 	/* struct in_ifaddr *ia; */ \
    145 { \
    146 	for (ia = IN_IFADDR_HASH((addr).s_addr).lh_first; \
    147 	    ia != NULL && !in_hosteq(ia->ia_addr.sin_addr, (addr)); \
    148 	    ia = ia->ia_hash.le_next) \
    149 		 continue; \
    150 }
    151 
    152 /*
    153  * Macro for finding the interface (ifnet structure) corresponding to one
    154  * of our IP addresses.
    155  */
    156 #define INADDR_TO_IFP(addr, ifp) \
    157 	/* struct in_addr addr; */ \
    158 	/* struct ifnet *ifp; */ \
    159 { \
    160 	register struct in_ifaddr *ia; \
    161 \
    162 	INADDR_TO_IA(addr, ia); \
    163 	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
    164 }
    165 
    166 /*
    167  * Macro for finding an internet address structure (in_ifaddr) corresponding
    168  * to a given interface (ifnet structure).
    169  */
    170 #define IFP_TO_IA(ifp, ia) \
    171 	/* struct ifnet *ifp; */ \
    172 	/* struct in_ifaddr *ia; */ \
    173 { \
    174 	register struct ifaddr *ifa; \
    175 \
    176 	for (ifa = (ifp)->if_addrlist.tqh_first; \
    177 	    ifa != NULL && ifa->ifa_addr->sa_family != AF_INET; \
    178 	    ifa = ifa->ifa_list.tqe_next) \
    179 		continue; \
    180 	(ia) = ifatoia(ifa); \
    181 }
    182 #endif
    183 
    184 /*
    185  * Per-interface router version information.
    186  */
    187 struct router_info {
    188 	struct	ifnet *rti_ifp;
    189 	int	rti_type;	/* type of router on this interface */
    190 	int	rti_age;	/* time since last v1 query */
    191 	struct	router_info *rti_next;
    192 };
    193 
    194 /*
    195  * Internet multicast address structure.  There is one of these for each IP
    196  * multicast group to which this host belongs on a given network interface.
    197  * They are kept in a linked list, rooted in the interface's in_ifaddr
    198  * structure.
    199  */
    200 struct in_multi {
    201 	struct	in_addr inm_addr;	/* IP multicast address */
    202 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
    203 	struct	in_ifaddr *inm_ia;	/* back pointer to in_ifaddr */
    204 	u_int	inm_refcount;		/* no. membership claims by sockets */
    205 	u_int	inm_timer;		/* IGMP membership report timer */
    206 	LIST_ENTRY(in_multi) inm_list;	/* list of multicast addresses */
    207 	u_int	inm_state;		/* state of membership */
    208 	struct	router_info *inm_rti;	/* router version info */
    209 };
    210 
    211 #ifdef _KERNEL
    212 /*
    213  * Structure used by macros below to remember position when stepping through
    214  * all of the in_multi records.
    215  */
    216 struct in_multistep {
    217 	struct in_ifaddr *i_ia;
    218 	struct in_multi *i_inm;
    219 };
    220 
    221 /*
    222  * Macro for looking up the in_multi record for a given IP multicast address
    223  * on a given interface.  If no matching record is found, "inm" returns NULL.
    224  */
    225 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
    226 	/* struct in_addr addr; */ \
    227 	/* struct ifnet *ifp; */ \
    228 	/* struct in_multi *inm; */ \
    229 { \
    230 	register struct in_ifaddr *ia; \
    231 \
    232 	IFP_TO_IA((ifp), ia); 			/* multicast */ \
    233 	if (ia == NULL) \
    234 		(inm) = NULL; \
    235 	else \
    236 		for ((inm) = ia->ia_multiaddrs.lh_first; \
    237 		    (inm) != NULL && !in_hosteq((inm)->inm_addr, (addr)); \
    238 		     (inm) = inm->inm_list.le_next) \
    239 			 continue; \
    240 }
    241 
    242 /*
    243  * Macro to step through all of the in_multi records, one at a time.
    244  * The current position is remembered in "step", which the caller must
    245  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
    246  * and get the first record.  Both macros return a NULL "inm" when there
    247  * are no remaining records.
    248  */
    249 #define IN_NEXT_MULTI(step, inm) \
    250 	/* struct in_multistep  step; */ \
    251 	/* struct in_multi *inm; */ \
    252 { \
    253 	if (((inm) = (step).i_inm) != NULL) \
    254 		(step).i_inm = (inm)->inm_list.le_next; \
    255 	else \
    256 		while ((step).i_ia != NULL) { \
    257 			(inm) = (step).i_ia->ia_multiaddrs.lh_first; \
    258 			(step).i_ia = (step).i_ia->ia_list.tqe_next; \
    259 			if ((inm) != NULL) { \
    260 				(step).i_inm = (inm)->inm_list.le_next; \
    261 				break; \
    262 			} \
    263 		} \
    264 }
    265 
    266 #define IN_FIRST_MULTI(step, inm) \
    267 	/* struct in_multistep step; */ \
    268 	/* struct in_multi *inm; */ \
    269 { \
    270 	(step).i_ia = in_ifaddr.tqh_first; \
    271 	(step).i_inm = NULL; \
    272 	IN_NEXT_MULTI((step), (inm)); \
    273 }
    274 
    275 int	in_ifinit __P((struct ifnet *,
    276 	    struct in_ifaddr *, struct sockaddr_in *, int));
    277 struct	in_multi *in_addmulti __P((struct in_addr *, struct ifnet *));
    278 void	in_delmulti __P((struct in_multi *));
    279 void	in_ifscrub __P((struct ifnet *, struct in_ifaddr *));
    280 void	in_setmaxmtu __P ((void));
    281 int	in_control __P((struct socket *, u_long, caddr_t, struct ifnet *,
    282 	    struct proc *));
    283 #endif
    284 
    285 #endif /* _NETINET_IN_VAR_H_ */
    286