Annotation of sys/netinet/in_pcb.h, Revision 1.1.1.1
1.1 nbrk 1: /* $OpenBSD: in_pcb.h,v 1.59 2007/02/22 20:23:07 millert Exp $ */
2: /* $NetBSD: in_pcb.h,v 1.14 1996/02/13 23:42:00 christos 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 _NETINET_IN_PCB_H_
65: #define _NETINET_IN_PCB_H_
66:
67: #include <sys/queue.h>
68: #include <netinet/ip6.h>
69: #include <netinet6/ip6_var.h>
70: #include <netinet/icmp6.h>
71: #include <netinet/ip_ipsp.h>
72:
73: union inpaddru {
74: struct in6_addr iau_addr6;
75: struct {
76: uint8_t pad[12];
77: struct in_addr inaddr; /* easier transition */
78: } iau_a4u;
79: };
80:
81: /*
82: * Common structure pcb for internet protocol implementation.
83: * Here are stored pointers to local and foreign host table
84: * entries, local and foreign socket numbers, and pointers
85: * up (to a socket structure) and down (to a protocol-specific)
86: * control block.
87: */
88: struct inpcb {
89: LIST_ENTRY(inpcb) inp_hash;
90: LIST_ENTRY(inpcb) inp_lhash; /* extra hash for lport */
91: CIRCLEQ_ENTRY(inpcb) inp_queue;
92: struct inpcbtable *inp_table;
93: union inpaddru inp_faddru; /* Foreign address. */
94: union inpaddru inp_laddru; /* Local address. */
95: #define inp_faddr inp_faddru.iau_a4u.inaddr
96: #define inp_faddr6 inp_faddru.iau_addr6
97: #define inp_laddr inp_laddru.iau_a4u.inaddr
98: #define inp_laddr6 inp_laddru.iau_addr6
99: u_int16_t inp_fport; /* foreign port */
100: u_int16_t inp_lport; /* local port */
101: struct socket *inp_socket; /* back pointer to socket */
102: caddr_t inp_ppcb; /* pointer to per-protocol pcb */
103: union { /* Route (notice increased size). */
104: struct route ru_route;
105: struct route_in6 ru_route6;
106: } inp_ru;
107: #define inp_route inp_ru.ru_route
108: #define inp_route6 inp_ru.ru_route6
109: int inp_flags; /* generic IP/datagram flags */
110: union { /* Header prototype. */
111: struct ip hu_ip;
112: struct ip6_hdr hu_ipv6;
113: } inp_hu;
114: #define inp_ip inp_hu.hu_ip
115: #define inp_ipv6 inp_hu.hu_ipv6
116: struct mbuf *inp_options; /* IP options */
117: struct ip6_pktopts *inp_outputopts6; /* IP6 options for outgoing packets */
118: int inp_hops;
119: union {
120: struct ip_moptions *mou_mo; /* IPv4 multicast options */
121: struct ip6_moptions *mou_mo6; /* IPv6 multicast options */
122: } inp_mou;
123: #define inp_moptions inp_mou.mou_mo
124: #define inp_moptions6 inp_mou.mou_mo6
125: u_char inp_seclevel[4];
126: #define SL_AUTH 0 /* Authentication level */
127: #define SL_ESP_TRANS 1 /* ESP transport level */
128: #define SL_ESP_NETWORK 2 /* ESP network (encapsulation) level */
129: #define SL_IPCOMP 3 /* Compression level */
130: u_int inp_secrequire:4, /* Condensed State from above */
131: inp_secresult:4; /* Result from Key Management */
132: #define SR_FAILED 1 /* Negotiation failed permanently */
133: #define SR_SUCCESS 2 /* SA successfully established */
134: #define SR_WAIT 3 /* Waiting for SA */
135: u_char inp_ip_minttl; /* minimum TTL or drop */
136: TAILQ_ENTRY(inpcb) inp_tdb_in_next, inp_tdb_out_next;
137: struct tdb *inp_tdb_in, *inp_tdb_out;
138: struct ipsec_policy *inp_ipo;
139: struct ipsec_ref *inp_ipsec_remotecred;
140: struct ipsec_ref *inp_ipsec_remoteauth;
141: #define inp_flowinfo inp_hu.hu_ipv6.ip6_flow
142:
143: int in6p_cksum;
144: #ifndef _KERNEL
145: #define inp_csumoffset in6p_cksum
146: #endif
147: struct icmp6_filter *inp_icmp6filt;
148: };
149:
150: struct inpcbtable {
151: CIRCLEQ_HEAD(, inpcb) inpt_queue;
152: LIST_HEAD(inpcbhead, inpcb) *inpt_hashtbl, *inpt_lhashtbl;
153: u_long inpt_hash, inpt_lhash;
154: u_int16_t inpt_lastport;
155: };
156:
157: /* flags in inp_flags: */
158: #define INP_RECVOPTS 0x001 /* receive incoming IP options */
159: #define INP_RECVRETOPTS 0x002 /* receive IP options for reply */
160: #define INP_RECVDSTADDR 0x004 /* receive IP dst address */
161:
162: #define INP_RXDSTOPTS INP_RECVOPTS
163: #define INP_RXHOPOPTS INP_RECVRETOPTS
164: #define INP_RXINFO INP_RECVDSTADDR
165: #define INP_RXSRCRT 0x010
166: #define INP_HOPLIMIT 0x020
167:
168: #define INP_HDRINCL 0x008 /* user supplies entire IP header */
169: #define INP_HIGHPORT 0x010 /* user wants "high" port binding */
170: #define INP_LOWPORT 0x020 /* user wants "low" port binding */
171: #define INP_RECVIF 0x080 /* receive incoming interface */
172: #define INP_RECVTTL 0x040 /* receive incoming IP TTL */
173:
174: #define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR| \
175: INP_RXSRCRT|INP_HOPLIMIT|INP_RECVIF|INP_RECVTTL)
176:
177: /*
178: * These flags' values should be determined by either the transport
179: * protocol at PRU_BIND, PRU_LISTEN, PRU_CONNECT, etc, or by in_pcb*().
180: */
181: #define INP_IPV6 0x100 /* sotopf(inp->inp_socket) == PF_INET6 */
182:
183: #if 1 /*KAME*/
184: /*
185: * Flags in in6p_flags
186: * We define KAME's original flags in higher 16 bits as much as possible
187: * for compatibility with *bsd*s.
188: * XXX: Should IN6P_HIGHPORT and IN6P_LOWPORT be moved as well?
189: */
190: #define IN6P_HIGHPORT INP_HIGHPORT /* user wants "high" port */
191: #define IN6P_LOWPORT INP_LOWPORT /* user wants "low" port */
192: #define IN6P_PKTINFO 0x010000 /* receive IP6 dst and I/F */
193: #define IN6P_HOPLIMIT 0x020000 /* receive hoplimit */
194: #define IN6P_HOPOPTS 0x040000 /* receive hop-by-hop options */
195: #define IN6P_DSTOPTS 0x080000 /* receive dst options after rthdr */
196: #define IN6P_RTHDR 0x100000 /* receive routing header */
197: #define IN6P_RTHDRDSTOPTS 0x200000 /* receive dstoptions before rthdr */
198: #define IN6P_TCLASS 0x400000 /* receive traffic class value */
199: #define IN6P_AUTOFLOWLABEL 0x800000 /* attach flowlabel automatically */
200:
201: #define IN6P_ANONPORT 0x4000000 /* port chosen for user */
202: #define IN6P_FAITH 0x8000000 /* accept FAITH'ed connections */
203: #define IN6P_RFC2292 0x40000000 /* used RFC2292 API on the socket */
204: #define IN6P_MTU 0x80000000 /* receive path MTU */
205:
206: #define IN6P_MINMTU 0x20000000 /* use minimum MTU */
207:
208: #define IN6P_CONTROLOPTS (IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\
209: IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\
210: IN6P_TCLASS|IN6P_AUTOFLOWLABEL|IN6P_RFC2292|\
211: IN6P_MTU)
212: #endif
213:
214: #define INPLOOKUP_WILDCARD 1
215: #define INPLOOKUP_SETLOCAL 2
216: #define INPLOOKUP_IPV6 4
217:
218: #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb)
219:
220: /* macros for handling bitmap of ports not to allocate dynamically */
221: #define DP_MAPBITS (sizeof(u_int32_t) * NBBY)
222: #define DP_MAPSIZE (howmany(IPPORT_RESERVED/2, DP_MAPBITS))
223: #define DP_SET(m, p) ((m)[((p) - IPPORT_RESERVED/2) / DP_MAPBITS] |= (1 << ((p) % DP_MAPBITS)))
224: #define DP_CLR(m, p) ((m)[((p) - IPPORT_RESERVED/2) / DP_MAPBITS] &= ~(1 << ((p) % DP_MAPBITS)))
225: #define DP_ISSET(m, p) ((m)[((p) - IPPORT_RESERVED/2) / DP_MAPBITS] & (1 << ((p) % DP_MAPBITS)))
226:
227: /* default values for baddynamicports [see ip_init()] */
228: #define DEFBADDYNAMICPORTS_TCP { 587, 749, 750, 751, 871, 0 }
229: #define DEFBADDYNAMICPORTS_UDP { 623, 664, 749, 750, 751, 0 }
230:
231: struct baddynamicports {
232: u_int32_t tcp[DP_MAPSIZE];
233: u_int32_t udp[DP_MAPSIZE];
234: };
235:
236: #ifdef _KERNEL
237:
238: #define sotopf(so) (so->so_proto->pr_domain->dom_family)
239:
240: void in_losing(struct inpcb *);
241: int in_pcballoc(struct socket *, void *);
242: int in_pcbbind(void *, struct mbuf *);
243: int in_pcbconnect(void *, struct mbuf *);
244: void in_pcbdetach(void *);
245: void in_pcbdisconnect(void *);
246: struct inpcb *
247: in_pcbhashlookup(struct inpcbtable *, struct in_addr,
248: u_int, struct in_addr, u_int);
249: struct inpcb *
250: in_pcblookup_listen(struct inpcbtable *, struct in_addr, u_int, int);
251: #ifdef INET6
252: struct inpcb *
253: in6_pcbhashlookup(struct inpcbtable *, struct in6_addr *,
254: u_int, struct in6_addr *, u_int);
255: struct inpcb *
256: in6_pcblookup_listen(struct inpcbtable *,
257: struct in6_addr *, u_int, int);
258: int in6_pcbbind(struct inpcb *, struct mbuf *);
259: int in6_pcbconnect(struct inpcb *, struct mbuf *);
260: int in6_setsockaddr(struct inpcb *, struct mbuf *);
261: int in6_setpeeraddr(struct inpcb *, struct mbuf *);
262: #endif /* INET6 */
263: void in_pcbinit(struct inpcbtable *, int);
264: struct inpcb *
265: in_pcblookup(struct inpcbtable *, void *, u_int, void *,
266: u_int, int);
267: void in_pcbnotifyall(struct inpcbtable *, struct sockaddr *,
268: int, void (*)(struct inpcb *, int));
269: void in_pcbrehash(struct inpcb *);
270: void in_rtchange(struct inpcb *, int);
271: void in_setpeeraddr(struct inpcb *, struct mbuf *);
272: void in_setsockaddr(struct inpcb *, struct mbuf *);
273: int in_baddynamic(u_int16_t, u_int16_t);
274: extern struct sockaddr_in *in_selectsrc(struct sockaddr_in *,
275: struct route *, int, struct ip_moptions *, int *);
276: struct rtentry *
277: in_pcbrtentry(struct inpcb *);
278:
279: /* INET6 stuff */
280: int in6_pcbnotify(struct inpcbtable *, struct sockaddr *,
281: u_int, struct sockaddr *, u_int, int, void *,
282: void (*)(struct inpcb *, int));
283: int in6_selecthlim(struct inpcb *, struct ifnet *);
284: int in6_pcbsetport(struct in6_addr *, struct inpcb *, struct proc *);
285: #endif /* _KERNEL */
286: #endif /* _NETINET_IN_PCB_H_ */
CVSweb