xref: /netbsd/sys/netinet/in_pcb.h (revision c4a72b64)
1 /*	$NetBSD: in_pcb.h,v 1.32 2002/11/02 19:03:44 itojun 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. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed by the University of
47  *	California, Berkeley and its contributors.
48  * 4. Neither the name of the University nor the names of its contributors
49  *    may be used to endorse or promote products derived from this software
50  *    without specific prior written permission.
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
56  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
58  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
59  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
60  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
61  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62  * SUCH DAMAGE.
63  *
64  *	@(#)in_pcb.h	8.1 (Berkeley) 6/10/93
65  */
66 
67 #ifndef _NETINET_IN_PCB_H_
68 #define _NETINET_IN_PCB_H_
69 
70 #include <sys/queue.h>
71 
72 /*
73  * Common structure pcb for internet protocol implementation.
74  * Here are stored pointers to local and foreign host table
75  * entries, local and foreign socket numbers, and pointers
76  * up (to a socket structure) and down (to a protocol-specific)
77  * control block.
78  */
79 struct inpcbpolicy;
80 
81 struct inpcb {
82 	LIST_ENTRY(inpcb) inp_hash;
83 	CIRCLEQ_ENTRY(inpcb) inp_queue;
84 	caddr_t	  inp_ppcb;		/* pointer to per-protocol pcb */
85 	int	  inp_state;		/* bind/connect state */
86 	u_int16_t inp_fport;		/* foreign port */
87 	u_int16_t inp_lport;		/* local port */
88 	struct	  socket *inp_socket;	/* back pointer to socket */
89 	struct	  route inp_route;	/* placeholder for routing entry */
90 	int	  inp_flags;		/* generic IP/datagram flags */
91 	struct	  ip inp_ip;		/* header prototype; should have more */
92 	struct	  mbuf *inp_options;	/* IP options */
93 	struct	  ip_moptions *inp_moptions; /* IP multicast options */
94 	int	  inp_errormtu;		/* MTU of last xmit status = EMSGSIZE */
95 	struct	  inpcbtable *inp_table;
96 #if 1 /*IPSEC*/
97 	struct inpcbpolicy *inp_sp;     /* security policy. */
98 #endif
99 };
100 #define	inp_faddr	inp_ip.ip_dst
101 #define	inp_laddr	inp_ip.ip_src
102 
103 LIST_HEAD(inpcbhead, inpcb);
104 
105 struct inpcbtable {
106 	CIRCLEQ_HEAD(, inpcb) inpt_queue;
107 	struct	  inpcbhead *inpt_bindhashtbl;
108 	struct	  inpcbhead *inpt_connecthashtbl;
109 	u_long	  inpt_bindhash;
110 	u_long	  inpt_connecthash;
111 	u_int16_t inpt_lastport;
112 	u_int16_t inpt_lastlow;
113 };
114 #define inpt_lasthi inpt_lastport
115 
116 /* states in inp_state: */
117 #define	INP_ATTACHED		0
118 #define	INP_BOUND		1
119 #define	INP_CONNECTED		2
120 
121 /* flags in inp_flags: */
122 #define	INP_RECVOPTS		0x01	/* receive incoming IP options */
123 #define	INP_RECVRETOPTS		0x02	/* receive IP options for reply */
124 #define	INP_RECVDSTADDR		0x04	/* receive IP dst address */
125 #define	INP_HDRINCL		0x08	/* user supplies entire IP header */
126 #define	INP_HIGHPORT		0x10	/* (unused; FreeBSD compat) */
127 #define	INP_LOWPORT		0x20	/* user wants "low" port binding */
128 #define	INP_ANONPORT		0x40	/* port chosen for user */
129 #define	INP_RECVIF		0x80	/* receive incoming interface */
130 #define	INP_CONTROLOPTS		(INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
131 				INP_RECVIF)
132 
133 #define	sotoinpcb(so)		((struct inpcb *)(so)->so_pcb)
134 
135 #ifdef _KERNEL
136 void	in_losing __P((struct inpcb *));
137 int	in_pcballoc __P((struct socket *, void *));
138 int	in_pcbbind __P((void *, struct mbuf *, struct proc *));
139 int	in_pcbconnect __P((void *, struct mbuf *));
140 void	in_pcbdetach __P((void *));
141 void	in_pcbdisconnect __P((void *));
142 void	in_pcbinit __P((struct inpcbtable *, int, int));
143 struct inpcb *
144 	in_pcblookup_bind __P((struct inpcbtable *,
145 	    struct in_addr, u_int));
146 struct inpcb *
147 	in_pcblookup_connect __P((struct inpcbtable *,
148 	    struct in_addr, u_int, struct in_addr, u_int));
149 int	in_pcbnotify __P((struct inpcbtable *, struct in_addr, u_int,
150 	    struct in_addr, u_int, int, void (*)(struct inpcb *, int)));
151 void	in_pcbnotifyall __P((struct inpcbtable *, struct in_addr, int,
152 	    void (*)(struct inpcb *, int)));
153 void	in_pcbpurgeif0 __P((struct inpcbtable *, struct ifnet *));
154 void	in_pcbpurgeif __P((struct inpcbtable *, struct ifnet *));
155 void	in_pcbstate __P((struct inpcb *, int));
156 void	in_rtchange __P((struct inpcb *, int));
157 void	in_setpeeraddr __P((struct inpcb *, struct mbuf *));
158 void	in_setsockaddr __P((struct inpcb *, struct mbuf *));
159 struct rtentry *
160 	in_pcbrtentry __P((struct inpcb *));
161 extern struct sockaddr_in *in_selectsrc __P((struct sockaddr_in *,
162 	struct route *, int, struct ip_moptions *, int *));
163 #endif
164 
165 #endif /* _NETINET_IN_PCB_H_ */
166