Home | History | Annotate | Line # | Download | only in netinet
in_var.h revision 1.21
      1 /*	$NetBSD: in_var.h,v 1.21 1998/02/13 18:21:42 tls Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1985, 1986, 1993
      5  *	The Regents of the University of California.  All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. All advertising materials mentioning features or use of this software
     16  *    must display the following acknowledgement:
     17  *	This product includes software developed by the University of
     18  *	California, Berkeley and its contributors.
     19  * 4. Neither the name of the University nor the names of its contributors
     20  *    may be used to endorse or promote products derived from this software
     21  *    without specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     33  * SUCH DAMAGE.
     34  *
     35  *	@(#)in_var.h	8.2 (Berkeley) 1/9/95
     36  */
     37 
     38 #ifndef _NETINET_IN_VAR_H_
     39 #define _NETINET_IN_VAR_H_
     40 
     41 #include <sys/queue.h>
     42 
     43 /*
     44  * Interface address, Internet version.  One of these structures
     45  * is allocated for each interface with an Internet address.
     46  * The ifaddr structure contains the protocol-independent part
     47  * of the structure and is assumed to be first.
     48  */
     49 struct in_ifaddr {
     50 	struct	ifaddr ia_ifa;		/* protocol-independent info */
     51 #define	ia_ifp		ia_ifa.ifa_ifp
     52 #define ia_flags	ia_ifa.ifa_flags
     53 					/* ia_{,sub}net{,mask} in host order */
     54 	u_int32_t ia_net;		/* network number of interface */
     55 	u_int32_t ia_netmask;		/* mask of net part */
     56 	u_int32_t ia_subnet;		/* subnet number, including net */
     57 	u_int32_t ia_subnetmask;	/* mask of subnet part */
     58 	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
     59 	LIST_ENTRY(in_ifaddr) ia_hash;	/* entry in bucket of inet addresses */
     60 	TAILQ_ENTRY(in_ifaddr) ia_list;	/* list of internet addresses */
     61 	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
     62 	struct	sockaddr_in ia_dstaddr;	/* reserve space for broadcast addr */
     63 #define	ia_broadaddr	ia_dstaddr
     64 	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
     65 	LIST_HEAD(, in_multi) ia_multiaddrs; /* list of multicast addresses */
     66 };
     67 
     68 struct	in_aliasreq {
     69 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
     70 	struct	sockaddr_in ifra_addr;
     71 	struct	sockaddr_in ifra_dstaddr;
     72 #define	ifra_broadaddr	ifra_dstaddr
     73 	struct	sockaddr_in ifra_mask;
     74 };
     75 /*
     76  * Given a pointer to an in_ifaddr (ifaddr),
     77  * return a pointer to the addr as a sockaddr_in.
     78  */
     79 #define	IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
     80 
     81 
     82 #ifdef	_KERNEL
     83 #ifndef IN_IFADDR_HASH_SIZE
     84 #define IN_IFADDR_HASH_SIZE 293
     85 #endif
     86 
     87 #define IN_IFADDR_HASH(x) in_ifaddrhashtbl[(u_long)(x) % IN_IFADDR_HASH_SIZE]
     88 
     89 u_long in_ifaddrhash;				/* size of hash table - 1 */
     90 int	in_ifaddrentries;			/* total number of addrs */
     91 LIST_HEAD(in_ifaddrhashhead, in_ifaddr);	/* Type of the hash head */
     92 TAILQ_HEAD(in_ifaddrhead, in_ifaddr);		/* Type of the list head */
     93 
     94 extern  struct in_ifaddrhashhead *in_ifaddrhashtbl;	/* Hash table head */
     95 extern  struct in_ifaddrhead in_ifaddr;		/* List head (in ip_input) */
     96 
     97 extern	struct	ifqueue	ipintrq;		/* ip packet input queue */
     98 void	in_socktrim __P((struct sockaddr_in *));
     99 
    100 
    101 /*
    102  * Macro for finding whether an internet address (in_addr) belongs to one
    103  * of our interfaces (in_ifaddr).  NULL if the address isn't ours.
    104  */
    105 #define INADDR_TO_IA(addr, ia) \
    106 	/* struct in_addr addr; */ \
    107 	/* struct in_ifaddr *ia; */ \
    108 { \
    109 	for (ia = IN_IFADDR_HASH((addr).s_addr).lh_first; \
    110 	    ia != NULL && !in_hosteq(ia->ia_addr.sin_addr, (addr)); \
    111 	    ia = ia->ia_hash.le_next) \
    112 		 continue; \
    113 }
    114 
    115 /*
    116  * Macro for finding the interface (ifnet structure) corresponding to one
    117  * of our IP addresses.
    118  */
    119 #define INADDR_TO_IFP(addr, ifp) \
    120 	/* struct in_addr addr; */ \
    121 	/* struct ifnet *ifp; */ \
    122 { \
    123 	register struct in_ifaddr *ia; \
    124 \
    125 	INADDR_TO_IA(addr, ia); \
    126 	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
    127 }
    128 
    129 /*
    130  * Macro for finding an internet address structure (in_ifaddr) corresponding
    131  * to a given interface (ifnet structure).
    132  */
    133 #define IFP_TO_IA(ifp, ia) \
    134 	/* struct ifnet *ifp; */ \
    135 	/* struct in_ifaddr *ia; */ \
    136 { \
    137 	register struct ifaddr *ifa; \
    138 \
    139 	for (ifa = (ifp)->if_addrlist.tqh_first; \
    140 	    ifa != NULL && ifa->ifa_addr->sa_family != AF_INET; \
    141 	    ifa = ifa->ifa_list.tqe_next) \
    142 		continue; \
    143 	(ia) = ifatoia(ifa); \
    144 }
    145 #endif
    146 
    147 /*
    148  * Per-interface router version information.
    149  */
    150 struct router_info {
    151 	struct	ifnet *rti_ifp;
    152 	int	rti_type;	/* type of router on this interface */
    153 	int	rti_age;	/* time since last v1 query */
    154 	struct	router_info *rti_next;
    155 };
    156 
    157 /*
    158  * Internet multicast address structure.  There is one of these for each IP
    159  * multicast group to which this host belongs on a given network interface.
    160  * They are kept in a linked list, rooted in the interface's in_ifaddr
    161  * structure.
    162  */
    163 struct in_multi {
    164 	struct	in_addr inm_addr;	/* IP multicast address */
    165 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
    166 	struct	in_ifaddr *inm_ia;	/* back pointer to in_ifaddr */
    167 	u_int	inm_refcount;		/* no. membership claims by sockets */
    168 	u_int	inm_timer;		/* IGMP membership report timer */
    169 	LIST_ENTRY(in_multi) inm_list;	/* list of multicast addresses */
    170 	u_int	inm_state;		/* state of membership */
    171 	struct	router_info *inm_rti;	/* router version info */
    172 };
    173 
    174 #ifdef _KERNEL
    175 /*
    176  * Structure used by macros below to remember position when stepping through
    177  * all of the in_multi records.
    178  */
    179 struct in_multistep {
    180 	struct in_ifaddr *i_ia;
    181 	struct in_multi *i_inm;
    182 };
    183 
    184 /*
    185  * Macro for looking up the in_multi record for a given IP multicast address
    186  * on a given interface.  If no matching record is found, "inm" returns NULL.
    187  */
    188 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
    189 	/* struct in_addr addr; */ \
    190 	/* struct ifnet *ifp; */ \
    191 	/* struct in_multi *inm; */ \
    192 { \
    193 	register struct in_ifaddr *ia; \
    194 \
    195 	IFP_TO_IA((ifp), ia); 			/* multicast */ \
    196 	if (ia == NULL) \
    197 		(inm) = NULL; \
    198 	else \
    199 		for ((inm) = ia->ia_multiaddrs.lh_first; \
    200 		    (inm) != NULL && !in_hosteq((inm)->inm_addr, (addr)); \
    201 		     (inm) = inm->inm_list.le_next) \
    202 			 continue; \
    203 }
    204 
    205 /*
    206  * Macro to step through all of the in_multi records, one at a time.
    207  * The current position is remembered in "step", which the caller must
    208  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
    209  * and get the first record.  Both macros return a NULL "inm" when there
    210  * are no remaining records.
    211  */
    212 #define IN_NEXT_MULTI(step, inm) \
    213 	/* struct in_multistep  step; */ \
    214 	/* struct in_multi *inm; */ \
    215 { \
    216 	if (((inm) = (step).i_inm) != NULL) \
    217 		(step).i_inm = (inm)->inm_list.le_next; \
    218 	else \
    219 		while ((step).i_ia != NULL) { \
    220 			(inm) = (step).i_ia->ia_multiaddrs.lh_first; \
    221 			(step).i_ia = (step).i_ia->ia_list.tqe_next; \
    222 			if ((inm) != NULL) { \
    223 				(step).i_inm = (inm)->inm_list.le_next; \
    224 				break; \
    225 			} \
    226 		} \
    227 }
    228 
    229 #define IN_FIRST_MULTI(step, inm) \
    230 	/* struct in_multistep step; */ \
    231 	/* struct in_multi *inm; */ \
    232 { \
    233 	(step).i_ia = in_ifaddr.tqh_first; \
    234 	(step).i_inm = NULL; \
    235 	IN_NEXT_MULTI((step), (inm)); \
    236 }
    237 
    238 int	in_ifinit __P((struct ifnet *,
    239 	    struct in_ifaddr *, struct sockaddr_in *, int));
    240 struct	in_multi *in_addmulti __P((struct in_addr *, struct ifnet *));
    241 void	in_delmulti __P((struct in_multi *));
    242 void	in_ifscrub __P((struct ifnet *, struct in_ifaddr *));
    243 void	in_setmaxmtu __P ((void));
    244 int	in_control __P((struct socket *, u_long, caddr_t, struct ifnet *,
    245 	    struct proc *));
    246 #endif
    247 
    248 #endif /* _NETINET_IN_VAR_H_ */
    249