Home | History | Annotate | Line # | Download | only in netinet
in_var.h revision 1.68
      1 /*	$NetBSD: in_var.h,v 1.68 2014/05/29 23:02:48 rmind 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  *
     20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     30  * POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 
     33 /*
     34  * Copyright (c) 1985, 1986, 1993
     35  *	The Regents of the University of California.  All rights reserved.
     36  *
     37  * Redistribution and use in source and binary forms, with or without
     38  * modification, are permitted provided that the following conditions
     39  * are met:
     40  * 1. Redistributions of source code must retain the above copyright
     41  *    notice, this list of conditions and the following disclaimer.
     42  * 2. Redistributions in binary form must reproduce the above copyright
     43  *    notice, this list of conditions and the following disclaimer in the
     44  *    documentation and/or other materials provided with the distribution.
     45  * 3. Neither the name of the University nor the names of its contributors
     46  *    may be used to endorse or promote products derived from this software
     47  *    without specific prior written permission.
     48  *
     49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     59  * SUCH DAMAGE.
     60  *
     61  *	@(#)in_var.h	8.2 (Berkeley) 1/9/95
     62  */
     63 
     64 #ifndef _NETINET_IN_VAR_H_
     65 #define _NETINET_IN_VAR_H_
     66 
     67 #include <sys/queue.h>
     68 
     69 /*
     70  * Interface address, Internet version.  One of these structures
     71  * is allocated for each interface with an Internet address.
     72  * The ifaddr structure contains the protocol-independent part
     73  * of the structure and is assumed to be first.
     74  */
     75 struct in_ifaddr {
     76 	struct	ifaddr ia_ifa;		/* protocol-independent info */
     77 #define	ia_ifp		ia_ifa.ifa_ifp
     78 #define ia_flags	ia_ifa.ifa_flags
     79 					/* ia_{,sub}net{,mask} in host order */
     80 	u_int32_t ia_net;		/* network number of interface */
     81 	u_int32_t ia_netmask;		/* mask of net part */
     82 	u_int32_t ia_subnet;		/* subnet number, including net */
     83 	u_int32_t ia_subnetmask;	/* mask of subnet part */
     84 	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
     85 	LIST_ENTRY(in_ifaddr) ia_hash;	/* entry in bucket of inet addresses */
     86 	TAILQ_ENTRY(in_ifaddr) ia_list;	/* list of internet addresses */
     87 	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
     88 	struct	sockaddr_in ia_dstaddr;	/* reserve space for broadcast addr */
     89 #define	ia_broadaddr	ia_dstaddr
     90 	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
     91 	LIST_HEAD(, in_multi) ia_multiaddrs; /* list of multicast addresses */
     92 	struct	in_multi *ia_allhosts;	/* multicast address record for
     93 					   the allhosts multicast group */
     94 	uint16_t ia_idsalt;		/* ip_id salt for this ia */
     95 };
     96 
     97 struct	in_aliasreq {
     98 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
     99 	struct	sockaddr_in ifra_addr;
    100 	struct	sockaddr_in ifra_dstaddr;
    101 #define	ifra_broadaddr	ifra_dstaddr
    102 	struct	sockaddr_in ifra_mask;
    103 };
    104 /*
    105  * Given a pointer to an in_ifaddr (ifaddr),
    106  * return a pointer to the addr as a sockaddr_in.
    107  */
    108 #define	IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
    109 
    110 #ifdef _KERNEL
    111 
    112 /* Note: 61, 127, 251, 509, 1021, 2039 are good. */
    113 #ifndef IN_IFADDR_HASH_SIZE
    114 #define IN_IFADDR_HASH_SIZE	509
    115 #endif
    116 
    117 /*
    118  * This is a bit unconventional, and wastes a little bit of space, but
    119  * because we want a very even hash function we don't use & in_ifaddrhash
    120  * here, but rather % the hash size, which should obviously be prime.
    121  */
    122 
    123 #define	IN_IFADDR_HASH(x) in_ifaddrhashtbl[(u_long)(x) % IN_IFADDR_HASH_SIZE]
    124 
    125 LIST_HEAD(in_ifaddrhashhead, in_ifaddr);	/* Type of the hash head */
    126 TAILQ_HEAD(in_ifaddrhead, in_ifaddr);		/* Type of the list head */
    127 
    128 extern	u_long in_ifaddrhash;			/* size of hash table - 1 */
    129 extern  struct in_ifaddrhashhead *in_ifaddrhashtbl;	/* Hash table head */
    130 extern  struct in_ifaddrhead in_ifaddrhead;		/* List head (in ip_input) */
    131 
    132 extern	struct	ifqueue	ipintrq;		/* ip packet input queue */
    133 extern	const	int	inetctlerrmap[];
    134 
    135 /*
    136  * Macro for finding whether an internet address (in_addr) belongs to one
    137  * of our interfaces (in_ifaddr).  NULL if the address isn't ours.
    138  */
    139 #define INADDR_TO_IA(addr, ia) \
    140 	/* struct in_addr addr; */ \
    141 	/* struct in_ifaddr *ia; */ \
    142 { \
    143 	LIST_FOREACH(ia, &IN_IFADDR_HASH((addr).s_addr), ia_hash) { \
    144 		if (in_hosteq(ia->ia_addr.sin_addr, (addr))) \
    145 			break; \
    146 	} \
    147 }
    148 
    149 /*
    150  * Macro for finding the next in_ifaddr structure with the same internet
    151  * address as ia. Call only with a valid ia pointer.
    152  * Will set ia to NULL if none found.
    153  */
    154 
    155 #define NEXT_IA_WITH_SAME_ADDR(ia) \
    156 	/* struct in_ifaddr *ia; */ \
    157 { \
    158 	struct in_addr addr; \
    159 	addr = ia->ia_addr.sin_addr; \
    160 	do { \
    161 		ia = LIST_NEXT(ia, ia_hash); \
    162 	} while ((ia != NULL) && !in_hosteq(ia->ia_addr.sin_addr, addr)); \
    163 }
    164 
    165 /*
    166  * Macro for finding the interface (ifnet structure) corresponding to one
    167  * of our IP addresses.
    168  */
    169 #define INADDR_TO_IFP(addr, ifp) \
    170 	/* struct in_addr addr; */ \
    171 	/* struct ifnet *ifp; */ \
    172 { \
    173 	struct in_ifaddr *ia; \
    174 \
    175 	INADDR_TO_IA(addr, ia); \
    176 	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
    177 }
    178 
    179 /*
    180  * Macro for finding an internet address structure (in_ifaddr) corresponding
    181  * to a given interface (ifnet structure).
    182  */
    183 #define IFP_TO_IA(ifp, ia) \
    184 	/* struct ifnet *ifp; */ \
    185 	/* struct in_ifaddr *ia; */ \
    186 { \
    187 	struct ifaddr *ifa; \
    188 \
    189 	IFADDR_FOREACH(ifa, ifp) { \
    190 		if (ifa->ifa_addr->sa_family == AF_INET) \
    191 			break; \
    192 	} \
    193 	(ia) = ifatoia(ifa); \
    194 }
    195 #endif
    196 
    197 /*
    198  * Internet multicast address structure.  There is one of these for each IP
    199  * multicast group to which this host belongs on a given network interface.
    200  * They are kept in a linked list, rooted in the interface's in_ifaddr
    201  * structure.
    202  */
    203 struct router_info;
    204 
    205 struct in_multi {
    206 	LIST_ENTRY(in_multi) inm_list;	/* list of multicast addresses */
    207 	struct	router_info *inm_rti;	/* router version info */
    208 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
    209 	struct	in_addr inm_addr;	/* IP multicast address */
    210 	u_int	inm_refcount;		/* no. membership claims by sockets */
    211 	u_int	inm_timer;		/* IGMP membership report timer */
    212 	u_int	inm_state;		/* state of membership */
    213 };
    214 
    215 #ifdef _KERNEL
    216 /*
    217  * Structure used by functions below to remember position when stepping
    218  * through all of the in_multi records.
    219  */
    220 struct in_multistep {
    221 	int i_n;
    222 	struct in_multi *i_inm;
    223 };
    224 
    225 bool in_multi_group(struct in_addr, struct ifnet *, int);
    226 struct in_multi *in_first_multi(struct in_multistep *);
    227 struct in_multi *in_next_multi(struct in_multistep *);
    228 struct in_multi *in_lookup_multi(struct in_addr, struct ifnet *);
    229 struct in_multi *in_addmulti(struct in_addr *, struct ifnet *);
    230 void in_delmulti(struct in_multi *);
    231 
    232 void in_multi_lock(int);
    233 void in_multi_unlock(void);
    234 int in_multi_lock_held(void);
    235 
    236 struct ifaddr;
    237 
    238 int	in_ifinit(struct ifnet *,
    239 	    struct in_ifaddr *, const struct sockaddr_in *, int);
    240 void	in_savemkludge(struct in_ifaddr *);
    241 void	in_restoremkludge(struct in_ifaddr *, struct ifnet *);
    242 void	in_purgemkludge(struct ifnet *);
    243 void	in_ifscrub(struct ifnet *, struct in_ifaddr *);
    244 void	in_setmaxmtu(void);
    245 const char *in_fmtaddr(struct in_addr);
    246 int	in_control(struct socket *, u_long, void *, struct ifnet *,
    247 	    struct lwp *);
    248 void	in_purgeaddr(struct ifaddr *);
    249 void	in_purgeif(struct ifnet *);
    250 int	ipflow_fastforward(struct mbuf *);
    251 
    252 struct ipid_state;
    253 typedef struct ipid_state ipid_state_t;
    254 
    255 ipid_state_t *	ip_id_init(void);
    256 void		ip_id_fini(ipid_state_t *);
    257 uint16_t	ip_randomid(ipid_state_t *, uint16_t);
    258 
    259 extern ipid_state_t *	ip_ids;
    260 extern uint16_t		ip_id;
    261 extern int		ip_do_randomid;
    262 
    263 /*
    264  * ip_newid_range: "allocate" num contiguous IP IDs.
    265  *
    266  * => Return the first ID.
    267  */
    268 static __inline uint16_t
    269 ip_newid_range(const struct in_ifaddr *ia, u_int num)
    270 {
    271 	uint16_t id;
    272 
    273 	if (ip_do_randomid) {
    274 		/* XXX ignore num */
    275 		return ip_randomid(ip_ids, ia ? ia->ia_idsalt : 0);
    276 	}
    277 
    278 	/* Never allow an IP ID of 0 (detect wrap). */
    279 	if ((uint16_t)(ip_id + num) < ip_id) {
    280 		ip_id = 1;
    281 	}
    282 	id = htons(ip_id);
    283 	ip_id += num;
    284 	return id;
    285 }
    286 
    287 static __inline uint16_t
    288 ip_newid(const struct in_ifaddr *ia)
    289 {
    290 
    291 	return ip_newid_range(ia, 1);
    292 }
    293 
    294 #ifdef SYSCTLFN_PROTO
    295 int	sysctl_inpcblist(SYSCTLFN_PROTO);
    296 #endif
    297 
    298 #endif	/* !_KERNEL */
    299 
    300 /* INET6 stuff */
    301 #include <netinet6/in6_var.h>
    302 
    303 #endif /* !_NETINET_IN_VAR_H_ */
    304