Home | History | Annotate | Line # | Download | only in netinet
in_var.h revision 1.12
      1 /*	$NetBSD: in_var.h,v 1.12 1995/05/31 06:08:29 mycroft 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.1 (Berkeley) 6/10/93
     36  */
     37 
     38 /*
     39  * Interface address, Internet version.  One of these structures
     40  * is allocated for each interface with an Internet address.
     41  * The ifaddr structure contains the protocol-independent part
     42  * of the structure and is assumed to be first.
     43  */
     44 struct in_ifaddr {
     45 	struct	ifaddr ia_ifa;		/* protocol-independent info */
     46 #define	ia_ifp		ia_ifa.ifa_ifp
     47 #define ia_flags	ia_ifa.ifa_flags
     48 					/* ia_{,sub}net{,mask} in host order */
     49 	u_int32_t ia_net;		/* network number of interface */
     50 	u_int32_t ia_netmask;		/* mask of net part */
     51 	u_int32_t ia_subnet;		/* subnet number, including net */
     52 	u_int32_t ia_subnetmask;	/* mask of subnet part */
     53 	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
     54 	struct	in_ifaddr *ia_next;	/* next in list of internet addresses */
     55 	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
     56 	struct	sockaddr_in ia_dstaddr;	/* reserve space for broadcast addr */
     57 #define	ia_broadaddr	ia_dstaddr
     58 	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
     59 	struct	in_multi *ia_multiaddrs; /* list of multicast addresses */
     60 };
     61 
     62 struct	in_aliasreq {
     63 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
     64 	struct	sockaddr_in ifra_addr;
     65 	struct	sockaddr_in ifra_broadaddr;
     66 #define ifra_dstaddr ifra_broadaddr
     67 	struct	sockaddr_in ifra_mask;
     68 };
     69 /*
     70  * Given a pointer to an in_ifaddr (ifaddr),
     71  * return a pointer to the addr as a sockaddr_in.
     72  */
     73 #define	IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
     74 
     75 #define IN_LNAOF(in, ifa) \
     76 	((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
     77 
     78 
     79 #ifdef	_KERNEL
     80 extern	struct	in_ifaddr *in_ifaddr;
     81 extern	struct	ifqueue	ipintrq;		/* ip packet input queue */
     82 void	in_socktrim __P((struct sockaddr_in *));
     83 
     84 
     85 /*
     86  * Macro for finding the interface (ifnet structure) corresponding to one
     87  * of our IP addresses.
     88  */
     89 #define INADDR_TO_IFP(addr, ifp) \
     90 	/* struct in_addr addr; */ \
     91 	/* struct ifnet *ifp; */ \
     92 { \
     93 	register struct in_ifaddr *ia; \
     94 \
     95 	for (ia = in_ifaddr; \
     96 	    ia != NULL && IA_SIN(ia)->sin_addr.s_addr != (addr).s_addr; \
     97 	    ia = ia->ia_next) \
     98 		 continue; \
     99 	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
    100 }
    101 
    102 /*
    103  * Macro for finding the internet address structure (in_ifaddr) corresponding
    104  * to a given interface (ifnet structure).
    105  */
    106 #define IFP_TO_IA(ifp, ia) \
    107 	/* struct ifnet *ifp; */ \
    108 	/* struct in_ifaddr *ia; */ \
    109 { \
    110 	for ((ia) = in_ifaddr; \
    111 	    (ia) != NULL && (ia)->ia_ifp != (ifp); \
    112 	    (ia) = (ia)->ia_next) \
    113 		continue; \
    114 }
    115 #endif
    116 
    117 /*
    118  * Per-interface router version information.
    119  */
    120 struct router_info {
    121 	struct	ifnet *rti_ifp;
    122 	int	rti_type;	/* type of router on this interface */
    123 	int	rti_age;	/* time since last v1 query */
    124 	struct	router_info *rti_next;
    125 };
    126 
    127 /*
    128  * Internet multicast address structure.  There is one of these for each IP
    129  * multicast group to which this host belongs on a given network interface.
    130  * They are kept in a linked list, rooted in the interface's in_ifaddr
    131  * structure.
    132  */
    133 struct in_multi {
    134 	struct	in_addr inm_addr;	/* IP multicast address */
    135 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
    136 	struct	in_ifaddr *inm_ia;	/* back pointer to in_ifaddr */
    137 	u_int	inm_refcount;		/* no. membership claims by sockets */
    138 	u_int	inm_timer;		/* IGMP membership report timer */
    139 	struct	in_multi *inm_next;	/* ptr to next multicast address */
    140 	u_int	inm_state;		/* state of membership */
    141 	struct	router_info *inm_rti;	/* router version info */
    142 };
    143 
    144 #ifdef _KERNEL
    145 /*
    146  * Structure used by macros below to remember position when stepping through
    147  * all of the in_multi records.
    148  */
    149 struct in_multistep {
    150 	struct in_ifaddr *i_ia;
    151 	struct in_multi *i_inm;
    152 };
    153 
    154 /*
    155  * Macro for looking up the in_multi record for a given IP multicast address
    156  * on a given interface.  If no matching record is found, "inm" returns NULL.
    157  */
    158 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
    159 	/* struct in_addr addr; */ \
    160 	/* struct ifnet *ifp; */ \
    161 	/* struct in_multi *inm; */ \
    162 { \
    163 	register struct in_ifaddr *ia; \
    164 \
    165 	IFP_TO_IA((ifp), ia); \
    166 	if (ia == NULL) \
    167 		(inm) = NULL; \
    168 	else \
    169 		for ((inm) = ia->ia_multiaddrs; \
    170 		    (inm) != NULL && (inm)->inm_addr.s_addr != (addr).s_addr; \
    171 		     (inm) = inm->inm_next) \
    172 			 continue; \
    173 }
    174 
    175 /*
    176  * Macro to step through all of the in_multi records, one at a time.
    177  * The current position is remembered in "step", which the caller must
    178  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
    179  * and get the first record.  Both macros return a NULL "inm" when there
    180  * are no remaining records.
    181  */
    182 #define IN_NEXT_MULTI(step, inm) \
    183 	/* struct in_multistep  step; */ \
    184 	/* struct in_multi *inm; */ \
    185 { \
    186 	if (((inm) = (step).i_inm) != NULL) \
    187 		(step).i_inm = (inm)->inm_next; \
    188 	else \
    189 		while ((step).i_ia != NULL) { \
    190 			(inm) = (step).i_ia->ia_multiaddrs; \
    191 			(step).i_ia = (step).i_ia->ia_next; \
    192 			if ((inm) != NULL) { \
    193 				(step).i_inm = (inm)->inm_next; \
    194 				break; \
    195 			} \
    196 		} \
    197 }
    198 
    199 #define IN_FIRST_MULTI(step, inm) \
    200 	/* struct in_multistep step; */ \
    201 	/* struct in_multi *inm; */ \
    202 { \
    203 	(step).i_ia = in_ifaddr; \
    204 	(step).i_inm = NULL; \
    205 	IN_NEXT_MULTI((step), (inm)); \
    206 }
    207 
    208 int	in_ifinit __P((struct ifnet *,
    209 	    struct in_ifaddr *, struct sockaddr_in *, int));
    210 struct	in_multi *in_addmulti __P((struct in_addr *, struct ifnet *));
    211 int	in_delmulti __P((struct in_multi *));
    212 void	in_ifscrub __P((struct ifnet *, struct in_ifaddr *));
    213 int	in_control __P((struct socket *, u_long, caddr_t, struct ifnet *));
    214 #endif
    215