xref: /netbsd-src/sys/netinet6/in6_pcb.h (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: in6_pcb.h,v 1.27 2005/11/15 18:39:46 dsl Exp $	*/
2 /*	$KAME: in6_pcb.h,v 1.45 2001/02/09 05:59:46 itojun Exp $	*/
3 
4 /*
5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the project nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1982, 1986, 1990, 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_pcb.h	8.1 (Berkeley) 6/10/93
62  */
63 
64 #ifndef _NETINET6_IN6_PCB_H_
65 #define _NETINET6_IN6_PCB_H_
66 
67 #include <sys/queue.h>
68 #include <netinet/in_pcb_hdr.h>
69 
70 /*
71  * Common structure pcb for internet protocol implementation.
72  * Here are stored pointers to local and foreign host table
73  * entries, local and foreign socket numbers, and pointers
74  * up (to a socket structure) and down (to a protocol-specific)
75  * control block.
76  */
77 struct icmp6_filter;
78 
79 struct	in6pcb {
80 	struct inpcb_hdr in6p_head;
81 #define in6p_hash	in6p_head.inph_hash
82 #define in6p_queue	in6p_head.inph_queue
83 #define in6p_af		in6p_head.inph_af
84 #define in6p_ppcb	in6p_head.inph_ppcb
85 #define in6p_state	in6p_head.inph_state
86 #define in6p_socket	in6p_head.inph_socket
87 #define in6p_table	in6p_head.inph_table
88 #define in6p_sp		in6p_head.inph_sp
89 	struct	route_in6 in6p_route;	/* placeholder for routing entry */
90 	u_int16_t in6p_fport;		/* foreign port */
91 	u_int16_t in6p_lport;		/* local port */
92 	u_int32_t in6p_flowinfo;	/* priority and flowlabel */
93 	int	in6p_flags;		/* generic IP6/datagram flags */
94 	int	in6p_hops;		/* default hop limit */
95 	struct	ip6_hdr in6p_ip6;	/* header prototype */
96 	struct	mbuf *in6p_options;   /* IP6 options */
97 	struct	ip6_pktopts *in6p_outputopts; /* IP6 options for outgoing packets */
98 	struct	ip6_moptions *in6p_moptions; /* IP6 multicast options */
99 	struct icmp6_filter *in6p_icmp6filt;
100 	int	in6p_cksum;		/* IPV6_CHECKSUM setsockopt */
101 };
102 
103 #define in6p_faddr	in6p_ip6.ip6_dst
104 #define in6p_laddr	in6p_ip6.ip6_src
105 
106 /* states in inp_state: */
107 #define	IN6P_ATTACHED		INP_ATTACHED
108 #define	IN6P_BOUND		INP_BOUND
109 #define	IN6P_CONNECTED		INP_CONNECTED
110 
111 /*
112  * Flags in in6p_flags
113  * We define KAME's original flags in higher 16 bits as much as possible
114  * for compatibility with *bsd*s.
115  */
116 #define IN6P_RECVOPTS		0x001000 /* receive incoming IP6 options */
117 #define IN6P_RECVRETOPTS	0x002000 /* receive IP6 options for reply */
118 #define IN6P_RECVDSTADDR	0x004000 /* receive IP6 dst address */
119 #define IN6P_IPV6_V6ONLY	0x008000 /* restrict AF_INET6 socket for v6 */
120 #define IN6P_PKTINFO		0x010000 /* receive IP6 dst and I/F */
121 #define IN6P_HOPLIMIT		0x020000 /* receive hoplimit */
122 #define IN6P_HOPOPTS		0x040000 /* receive hop-by-hop options */
123 #define IN6P_DSTOPTS		0x080000 /* receive dst options after rthdr */
124 #define IN6P_RTHDR		0x100000 /* receive routing header */
125 #define IN6P_RTHDRDSTOPTS	0x200000 /* receive dstoptions before rthdr */
126 
127 #define IN6P_HIGHPORT		0x1000000 /* user wants "high" port binding */
128 #define IN6P_LOWPORT		0x2000000 /* user wants "low" port binding */
129 #define IN6P_ANONPORT		0x4000000 /* port chosen for user */
130 #define IN6P_FAITH		0x8000000 /* accept FAITH'ed connections */
131 #if 0 /* obsoleted */
132 #define IN6P_BINDV6ONLY		0x10000000 /* do not grab IPv4 traffic */
133 #endif
134 #define IN6P_MINMTU		0x20000000 /* use minimum MTU */
135 
136 #define IN6P_CONTROLOPTS	(IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\
137 				 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\
138 				 IN6P_MINMTU)
139 
140 /* compute hash value for foreign and local in6_addr and port */
141 #define IN6_HASH(faddr, fport, laddr, lport) 			\
142 	(((faddr)->s6_addr32[0] ^ (faddr)->s6_addr32[1] ^	\
143 	  (faddr)->s6_addr32[2] ^ (faddr)->s6_addr32[3] ^	\
144 	  (laddr)->s6_addr32[0] ^ (laddr)->s6_addr32[1] ^	\
145 	  (laddr)->s6_addr32[2] ^ (laddr)->s6_addr32[3])	\
146 	 + (fport) + (lport))
147 
148 #define sotoin6pcb(so)	((struct in6pcb *)(so)->so_pcb)
149 
150 #ifdef _KERNEL
151 void	in6_losing __P((struct in6pcb *));
152 void	in6_pcbinit __P((struct inpcbtable *, int, int));
153 int	in6_pcballoc __P((struct socket *, void *));
154 int	in6_pcbbind __P((void *, struct mbuf *, struct proc *));
155 int	in6_pcbconnect __P((void *, struct mbuf *, struct proc *));
156 void	in6_pcbdetach __P((struct in6pcb *));
157 void	in6_pcbdisconnect __P((struct in6pcb *));
158 struct	in6pcb *in6_pcblookup_port __P((struct inpcbtable *, struct in6_addr *,
159 	u_int, int));
160 int	in6_pcbnotify __P((struct inpcbtable *, struct sockaddr *,
161 	u_int, const struct sockaddr *, u_int, int, void *,
162 	void (*)(struct in6pcb *, int)));
163 void	in6_pcbpurgeif0 __P((struct inpcbtable *, struct ifnet *));
164 void	in6_pcbpurgeif __P((struct inpcbtable *, struct ifnet *));
165 void	in6_pcbstate __P((struct in6pcb *, int));
166 void	in6_rtchange __P((struct in6pcb *, int));
167 void	in6_setpeeraddr __P((struct in6pcb *, struct mbuf *));
168 void	in6_setsockaddr __P((struct in6pcb *, struct mbuf *));
169 
170 /* in in6_src.c */
171 int	in6_selecthlim __P((struct in6pcb *, struct ifnet *));
172 int	in6_pcbsetport __P((struct in6_addr *, struct in6pcb *, struct proc *));
173 
174 extern struct rtentry *
175 	in6_pcbrtentry __P((struct in6pcb *));
176 extern struct in6pcb *in6_pcblookup_connect __P((struct inpcbtable *,
177 	struct in6_addr *, u_int, const struct in6_addr *, u_int, int));
178 extern struct in6pcb *in6_pcblookup_bind __P((struct inpcbtable *,
179 	struct in6_addr *, u_int, int));
180 #endif /* _KERNEL */
181 
182 #endif /* !_NETINET6_IN6_PCB_H_ */
183