xref: /netbsd/sys/netinet/in_pcb.h (revision 6550d01e)
1 /*	$NetBSD: in_pcb.h,v 1.47 2009/07/17 22:02:54 minskim Exp $	*/
2 
3 /*
4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5  * 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. Neither the name of the project nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 /*
33  * Copyright (c) 1982, 1986, 1990, 1993
34  *	The Regents of the University of California.  All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  * 3. Neither the name of the University nor the names of its contributors
45  *    may be used to endorse or promote products derived from this software
46  *    without specific prior written permission.
47  *
48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58  * SUCH DAMAGE.
59  *
60  *	@(#)in_pcb.h	8.1 (Berkeley) 6/10/93
61  */
62 
63 #ifndef _NETINET_IN_PCB_H_
64 #define _NETINET_IN_PCB_H_
65 
66 #include <sys/queue.h>
67 #include <netinet/in_pcb_hdr.h>
68 
69 /*
70  * Common structure pcb for internet protocol implementation.
71  * Here are stored pointers to local and foreign host table
72  * entries, local and foreign socket numbers, and pointers
73  * up (to a socket structure) and down (to a protocol-specific)
74  * control block.
75  */
76 struct inpcb {
77 	struct inpcb_hdr inp_head;
78 #define inp_hash	inp_head.inph_hash
79 #define inp_queue	inp_head.inph_queue
80 #define inp_af		inp_head.inph_af
81 #define inp_ppcb	inp_head.inph_ppcb
82 #define inp_state	inp_head.inph_state
83 #define inp_socket	inp_head.inph_socket
84 #define inp_table	inp_head.inph_table
85 #define inp_sp		inp_head.inph_sp
86 	struct	  route inp_route;	/* placeholder for routing entry */
87 	u_int16_t inp_fport;		/* foreign port */
88 	u_int16_t inp_lport;		/* local port */
89 	int	  inp_flags;		/* generic IP/datagram flags */
90 	struct	  ip inp_ip;		/* header prototype; should have more */
91 	struct	  mbuf *inp_options;	/* IP options */
92 	struct	  ip_moptions *inp_moptions; /* IP multicast options */
93 	int	  inp_errormtu;		/* MTU of last xmit status = EMSGSIZE */
94 	uint8_t	  inp_ip_minttl;
95 };
96 
97 #define	inp_faddr	inp_ip.ip_dst
98 #define	inp_laddr	inp_ip.ip_src
99 
100 /* flags in inp_flags: */
101 #define	INP_RECVOPTS		0x01	/* receive incoming IP options */
102 #define	INP_RECVRETOPTS		0x02	/* receive IP options for reply */
103 #define	INP_RECVDSTADDR		0x04	/* receive IP dst address */
104 #define	INP_HDRINCL		0x08	/* user supplies entire IP header */
105 #define	INP_HIGHPORT		0x10	/* (unused; FreeBSD compat) */
106 #define	INP_LOWPORT		0x20	/* user wants "low" port binding */
107 #define	INP_ANONPORT		0x40	/* port chosen for user */
108 #define	INP_RECVIF		0x80	/* receive incoming interface */
109 /* XXX should move to an UDP control block */
110 #define INP_ESPINUDP		0x100	/* ESP over UDP for NAT-T */
111 #define INP_ESPINUDP_NON_IKE	0x200	/* ESP over UDP for NAT-T */
112 #define INP_ESPINUDP_ALL	(INP_ESPINUDP|INP_ESPINUDP_NON_IKE)
113 #define INP_NOHEADER		0x400	/* Kernel removes IP header
114 					 * before feeding a packet
115 					 * to the raw socket user.
116 					 * The socket user will
117 					 * not supply an IP header.
118 					 * Cancels INP_HDRINCL.
119 					 */
120 #define	INP_RECVTTL		0x800	/* receive incoming IP TTL */
121 #define	INP_CONTROLOPTS		(INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
122 				INP_RECVIF|INP_RECVTTL)
123 
124 #define	sotoinpcb(so)		((struct inpcb *)(so)->so_pcb)
125 
126 #ifdef _KERNEL
127 void	in_losing(struct inpcb *);
128 int	in_pcballoc(struct socket *, void *);
129 int	in_pcbbind(void *, struct mbuf *, struct lwp *);
130 int	in_pcbconnect(void *, struct mbuf *, struct lwp *);
131 void	in_pcbdetach(void *);
132 void	in_pcbdisconnect(void *);
133 void	in_pcbinit(struct inpcbtable *, int, int);
134 struct inpcb *
135 	in_pcblookup_port(struct inpcbtable *,
136 	    struct in_addr, u_int, int);
137 struct inpcb *
138 	in_pcblookup_bind(struct inpcbtable *,
139 	    struct in_addr, u_int);
140 struct inpcb *
141 	in_pcblookup_connect(struct inpcbtable *,
142 	    struct in_addr, u_int, struct in_addr, u_int);
143 int	in_pcbnotify(struct inpcbtable *, struct in_addr, u_int,
144 	    struct in_addr, u_int, int, void (*)(struct inpcb *, int));
145 void	in_pcbnotifyall(struct inpcbtable *, struct in_addr, int,
146 	    void (*)(struct inpcb *, int));
147 void	in_pcbpurgeif0(struct inpcbtable *, struct ifnet *);
148 void	in_pcbpurgeif(struct inpcbtable *, struct ifnet *);
149 void	in_pcbstate(struct inpcb *, int);
150 void	in_rtchange(struct inpcb *, int);
151 void	in_setpeeraddr(struct inpcb *, struct mbuf *);
152 void	in_setsockaddr(struct inpcb *, struct mbuf *);
153 struct rtentry *
154 	in_pcbrtentry(struct inpcb *);
155 extern struct sockaddr_in *in_selectsrc(struct sockaddr_in *,
156 	struct route *, int, struct ip_moptions *, int *);
157 #endif
158 
159 #endif /* !_NETINET_IN_PCB_H_ */
160