Home | History | Annotate | Line # | Download | only in netinet
in_var.h revision 1.78
      1 /*	$NetBSD: in_var.h,v 1.78 2016/07/08 04:33:30 ozaki-r 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 #define IN_IFF_TENTATIVE	0x01	/* tentative address */
     70 #define IN_IFF_DUPLICATED	0x02	/* DAD detected duplicate */
     71 #define IN_IFF_DETACHED		0x04	/* may be detached from the link */
     72 #define IN_IFF_TRYTENTATIVE	0x08	/* intent to try DAD */
     73 
     74 /* do not input/output */
     75 #define IN_IFF_NOTREADY \
     76     (IN_IFF_TRYTENTATIVE | IN_IFF_TENTATIVE | IN_IFF_DUPLICATED)
     77 
     78 /*
     79  * Interface address, Internet version.  One of these structures
     80  * is allocated for each interface with an Internet address.
     81  * The ifaddr structure contains the protocol-independent part
     82  * of the structure and is assumed to be first.
     83  */
     84 struct in_ifaddr {
     85 	struct	ifaddr ia_ifa;		/* protocol-independent info */
     86 #define	ia_ifp		ia_ifa.ifa_ifp
     87 #define ia_flags	ia_ifa.ifa_flags
     88 					/* ia_{,sub}net{,mask} in host order */
     89 	u_int32_t ia_net;		/* network number of interface */
     90 	u_int32_t ia_netmask;		/* mask of net part */
     91 	u_int32_t ia_subnet;		/* subnet number, including net */
     92 	u_int32_t ia_subnetmask;	/* mask of subnet part */
     93 	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
     94 	LIST_ENTRY(in_ifaddr) ia_hash;	/* entry in bucket of inet addresses */
     95 	TAILQ_ENTRY(in_ifaddr) ia_list;	/* list of internet addresses */
     96 	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
     97 	struct	sockaddr_in ia_dstaddr;	/* reserve space for broadcast addr */
     98 #define	ia_broadaddr	ia_dstaddr
     99 	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
    100 	LIST_HEAD(, in_multi) ia_multiaddrs; /* list of multicast addresses */
    101 	struct	in_multi *ia_allhosts;	/* multicast address record for
    102 					   the allhosts multicast group */
    103 	uint16_t ia_idsalt;		/* ip_id salt for this ia */
    104 	int	ia4_flags;		/* address flags */
    105 	void	(*ia_dad_start) (struct ifaddr *);	/* DAD start function */
    106 	void	(*ia_dad_stop) (struct ifaddr *);	/* DAD stop function */
    107 
    108 #ifdef _KERNEL
    109 	struct pslist_entry	ia_hash_pslist_entry;
    110 	struct pslist_entry	ia_pslist_entry;
    111 #endif
    112 };
    113 
    114 struct	in_aliasreq {
    115 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    116 	struct	sockaddr_in ifra_addr;
    117 	struct	sockaddr_in ifra_dstaddr;
    118 #define	ifra_broadaddr	ifra_dstaddr
    119 	struct	sockaddr_in ifra_mask;
    120 };
    121 
    122 /*
    123  * Given a pointer to an in_ifaddr (ifaddr),
    124  * return a pointer to the addr as a sockaddr_in.
    125  */
    126 #define	IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
    127 
    128 #ifdef _KERNEL
    129 
    130 /* Note: 61, 127, 251, 509, 1021, 2039 are good. */
    131 #ifndef IN_IFADDR_HASH_SIZE
    132 #define IN_IFADDR_HASH_SIZE	509
    133 #endif
    134 
    135 /*
    136  * This is a bit unconventional, and wastes a little bit of space, but
    137  * because we want a very even hash function we don't use & in_ifaddrhash
    138  * here, but rather % the hash size, which should obviously be prime.
    139  */
    140 
    141 #define	IN_IFADDR_HASH(x) in_ifaddrhashtbl[(u_long)(x) % IN_IFADDR_HASH_SIZE]
    142 
    143 LIST_HEAD(in_ifaddrhashhead, in_ifaddr);	/* Type of the hash head */
    144 TAILQ_HEAD(in_ifaddrhead, in_ifaddr);		/* Type of the list head */
    145 
    146 extern	u_long in_ifaddrhash;			/* size of hash table - 1 */
    147 extern  struct in_ifaddrhashhead *in_ifaddrhashtbl;	/* Hash table head */
    148 extern  struct in_ifaddrhead in_ifaddrhead;		/* List head (in ip_input) */
    149 
    150 extern struct pslist_head *in_ifaddrhashtbl_pslist;
    151 extern u_long in_ifaddrhash_pslist;
    152 extern struct pslist_head in_ifaddrhead_pslist;
    153 
    154 #define IN_IFADDR_HASH_PSLIST(x)					\
    155 	in_ifaddrhashtbl_pslist[(u_long)(x) % IN_IFADDR_HASH_SIZE]
    156 
    157 #define IN_ADDRHASH_READER_FOREACH(__ia, __addr)			\
    158 	PSLIST_READER_FOREACH((__ia), &IN_IFADDR_HASH_PSLIST(__addr),	\
    159 	    struct in_ifaddr, ia_hash_pslist_entry)
    160 #define IN_ADDRHASH_WRITER_INSERT_HEAD(__ia)				\
    161 	PSLIST_WRITER_INSERT_HEAD(					\
    162 	    &IN_IFADDR_HASH_PSLIST((__ia)->ia_addr.sin_addr.s_addr),	\
    163 	    (__ia), ia_hash_pslist_entry)
    164 #define IN_ADDRHASH_WRITER_REMOVE(__ia)					\
    165 	PSLIST_WRITER_REMOVE((__ia), ia_hash_pslist_entry)
    166 #define IN_ADDRHASH_ENTRY_INIT(__ia)					\
    167 	PSLIST_ENTRY_INIT((__ia), ia_hash_pslist_entry);
    168 #define IN_ADDRHASH_ENTRY_DESTROY(__ia)					\
    169 	PSLIST_ENTRY_DESTROY((__ia), ia_hash_pslist_entry);
    170 #define IN_ADDRHASH_READER_NEXT(__ia)					\
    171 	PSLIST_READER_NEXT((__ia), struct in_ifaddr, ia_hash_pslist_entry)
    172 
    173 #define IN_ADDRLIST_ENTRY_INIT(__ia)					\
    174 	PSLIST_ENTRY_INIT((__ia), ia_pslist_entry)
    175 #define IN_ADDRLIST_ENTRY_DESTROY(__ia)					\
    176 	PSLIST_ENTRY_DESTROY((__ia), ia_pslist_entry);
    177 #define IN_ADDRLIST_READER_EMPTY()					\
    178 	(PSLIST_READER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr,	\
    179 	                     ia_pslist_entry) == NULL)
    180 #define IN_ADDRLIST_READER_FIRST()					\
    181 	PSLIST_READER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr,	\
    182 	                    ia_pslist_entry)
    183 #define IN_ADDRLIST_READER_NEXT(__ia)					\
    184 	PSLIST_READER_NEXT((__ia), struct in_ifaddr, ia_pslist_entry)
    185 #define IN_ADDRLIST_READER_FOREACH(__ia)				\
    186 	PSLIST_READER_FOREACH((__ia), &in_ifaddrhead_pslist,		\
    187 	                      struct in_ifaddr, ia_pslist_entry)
    188 #define IN_ADDRLIST_WRITER_INSERT_HEAD(__ia)				\
    189 	PSLIST_WRITER_INSERT_HEAD(&in_ifaddrhead_pslist, (__ia),	\
    190 	    ia_pslist_entry)
    191 #define IN_ADDRLIST_WRITER_REMOVE(__ia)					\
    192 	PSLIST_WRITER_REMOVE((__ia), ia_pslist_entry)
    193 #define IN_ADDRLIST_WRITER_FOREACH(__ia)				\
    194 	PSLIST_WRITER_FOREACH((__ia), &in_ifaddrhead_pslist,		\
    195 	                      struct in_ifaddr, ia_pslist_entry)
    196 #define IN_ADDRLIST_WRITER_FIRST()					\
    197 	PSLIST_WRITER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr,	\
    198 	                    ia_pslist_entry)
    199 #define IN_ADDRLIST_WRITER_NEXT(__ia)					\
    200 	PSLIST_WRITER_NEXT((__ia), struct in_ifaddr, ia_pslist_entry)
    201 #define IN_ADDRLIST_WRITER_INSERT_AFTER(__ia, __new)			\
    202 	PSLIST_WRITER_INSERT_AFTER((__ia), (__new), ia_pslist_entry)
    203 #define IN_ADDRLIST_WRITER_EMPTY()					\
    204 	(PSLIST_WRITER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr,	\
    205 	    ia_pslist_entry) == NULL)
    206 #define IN_ADDRLIST_WRITER_INSERT_TAIL(__new)				\
    207 	do {								\
    208 		if (IN_ADDRLIST_WRITER_EMPTY()) {			\
    209 			IN_ADDRLIST_WRITER_INSERT_HEAD((__new));	\
    210 		} else {						\
    211 			struct in_ifaddr *__ia;				\
    212 			IN_ADDRLIST_WRITER_FOREACH(__ia) {		\
    213 				if (IN_ADDRLIST_WRITER_NEXT(__ia) == NULL) { \
    214 					IN_ADDRLIST_WRITER_INSERT_AFTER(__ia,\
    215 					    (__new));			\
    216 					break;				\
    217 				}					\
    218 			}						\
    219 		}							\
    220 	} while (0)
    221 
    222 extern	const	int	inetctlerrmap[];
    223 
    224 /*
    225  * Find whether an internet address (in_addr) belongs to one
    226  * of our interfaces (in_ifaddr).  NULL if the address isn't ours.
    227  */
    228 static inline struct in_ifaddr *
    229 in_get_ia(struct in_addr addr)
    230 {
    231 	struct in_ifaddr *ia;
    232 
    233 	IN_ADDRHASH_READER_FOREACH(ia, addr.s_addr) {
    234 		if (in_hosteq(ia->ia_addr.sin_addr, addr))
    235 			break;
    236 	}
    237 
    238 	return ia;
    239 }
    240 
    241 /*
    242  * Find whether an internet address (in_addr) belongs to a specified
    243  * interface.  NULL if the address isn't ours.
    244  */
    245 static inline struct in_ifaddr *
    246 in_get_ia_on_iface(struct in_addr addr, struct ifnet *ifp)
    247 {
    248 	struct in_ifaddr *ia;
    249 
    250 	IN_ADDRHASH_READER_FOREACH(ia, addr.s_addr) {
    251 		if (in_hosteq(ia->ia_addr.sin_addr, addr) &&
    252 		    ia->ia_ifp == ifp)
    253 			break;
    254 	}
    255 
    256 	return ia;
    257 }
    258 
    259 /*
    260  * Find an internet address structure (in_ifaddr) corresponding
    261  * to a given interface (ifnet structure).
    262  */
    263 static inline struct in_ifaddr *
    264 in_get_ia_from_ifp(struct ifnet *ifp)
    265 {
    266 	struct ifaddr *ifa;
    267 
    268 	IFADDR_READER_FOREACH(ifa, ifp) {
    269 		if (ifa->ifa_addr->sa_family == AF_INET)
    270 			break;
    271 	}
    272 
    273 	return ifatoia(ifa);
    274 }
    275 
    276 #include <netinet/in_selsrc.h>
    277 /*
    278  * IPv4 per-interface state.
    279  */
    280 struct in_ifinfo {
    281 	struct lltable		*ii_llt;	/* ARP state */
    282 	struct in_ifsysctl	*ii_selsrc;
    283 };
    284 
    285 #endif /* _KERNEL */
    286 
    287 /*
    288  * Internet multicast address structure.  There is one of these for each IP
    289  * multicast group to which this host belongs on a given network interface.
    290  * They are kept in a linked list, rooted in the interface's in_ifaddr
    291  * structure.
    292  */
    293 struct router_info;
    294 
    295 struct in_multi {
    296 	LIST_ENTRY(in_multi) inm_list;	/* list of multicast addresses */
    297 	struct	router_info *inm_rti;	/* router version info */
    298 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
    299 	struct	in_addr inm_addr;	/* IP multicast address */
    300 	u_int	inm_refcount;		/* no. membership claims by sockets */
    301 	u_int	inm_timer;		/* IGMP membership report timer */
    302 	u_int	inm_state;		/* state of membership */
    303 };
    304 
    305 #ifdef _KERNEL
    306 
    307 #include <net/pktqueue.h>
    308 
    309 extern pktqueue_t *ip_pktq;
    310 
    311 extern int ip_dad_count;		/* Duplicate Address Detection probes */
    312 
    313 /*
    314  * Structure used by functions below to remember position when stepping
    315  * through all of the in_multi records.
    316  */
    317 struct in_multistep {
    318 	int i_n;
    319 	struct in_multi *i_inm;
    320 };
    321 
    322 bool in_multi_group(struct in_addr, struct ifnet *, int);
    323 struct in_multi *in_first_multi(struct in_multistep *);
    324 struct in_multi *in_next_multi(struct in_multistep *);
    325 struct in_multi *in_lookup_multi(struct in_addr, struct ifnet *);
    326 struct in_multi *in_addmulti(struct in_addr *, struct ifnet *);
    327 void in_delmulti(struct in_multi *);
    328 
    329 void in_multi_lock(int);
    330 void in_multi_unlock(void);
    331 int in_multi_lock_held(void);
    332 
    333 struct ifaddr;
    334 
    335 int	in_ifinit(struct ifnet *,
    336 	    struct in_ifaddr *, const struct sockaddr_in *, int, int);
    337 void	in_savemkludge(struct in_ifaddr *);
    338 void	in_restoremkludge(struct in_ifaddr *, struct ifnet *);
    339 void	in_purgemkludge(struct ifnet *);
    340 void	in_ifscrub(struct ifnet *, struct in_ifaddr *);
    341 void	in_setmaxmtu(void);
    342 const char *in_fmtaddr(struct in_addr);
    343 int	in_control(struct socket *, u_long, void *, struct ifnet *);
    344 void	in_purgeaddr(struct ifaddr *);
    345 void	in_purgeif(struct ifnet *);
    346 int	ipflow_fastforward(struct mbuf *);
    347 
    348 struct ipid_state;
    349 typedef struct ipid_state ipid_state_t;
    350 
    351 ipid_state_t *	ip_id_init(void);
    352 void		ip_id_fini(ipid_state_t *);
    353 uint16_t	ip_randomid(ipid_state_t *, uint16_t);
    354 
    355 extern ipid_state_t *	ip_ids;
    356 extern uint16_t		ip_id;
    357 extern int		ip_do_randomid;
    358 
    359 /*
    360  * ip_newid_range: "allocate" num contiguous IP IDs.
    361  *
    362  * => Return the first ID.
    363  */
    364 static __inline uint16_t
    365 ip_newid_range(const struct in_ifaddr *ia, u_int num)
    366 {
    367 	uint16_t id;
    368 
    369 	if (ip_do_randomid) {
    370 		/* XXX ignore num */
    371 		return ip_randomid(ip_ids, ia ? ia->ia_idsalt : 0);
    372 	}
    373 
    374 	/* Never allow an IP ID of 0 (detect wrap). */
    375 	if ((uint16_t)(ip_id + num) < ip_id) {
    376 		ip_id = 1;
    377 	}
    378 	id = htons(ip_id);
    379 	ip_id += num;
    380 	return id;
    381 }
    382 
    383 static __inline uint16_t
    384 ip_newid(const struct in_ifaddr *ia)
    385 {
    386 
    387 	return ip_newid_range(ia, 1);
    388 }
    389 
    390 #ifdef SYSCTLFN_PROTO
    391 int	sysctl_inpcblist(SYSCTLFN_PROTO);
    392 #endif
    393 
    394 #define LLTABLE(ifp)	\
    395 	((struct in_ifinfo *)(ifp)->if_afdata[AF_INET])->ii_llt
    396 
    397 #endif	/* !_KERNEL */
    398 
    399 /* INET6 stuff */
    400 #include <netinet6/in6_var.h>
    401 
    402 #endif /* !_NETINET_IN_VAR_H_ */
    403