xref: /netbsd-src/sys/netinet/in_pcb.h (revision 2a399c6883d870daece976daec6ffa7bb7f934ce)
1 /*	$NetBSD: in_pcb.h,v 1.23 1998/01/07 22:51:24 lukem Exp $	*/
2 
3 /*
4  * Copyright (c) 1982, 1986, 1990, 1993
5  *	The Regents of the University of California.  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. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the University of
18  *	California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)in_pcb.h	8.1 (Berkeley) 6/10/93
36  */
37 
38 #include <sys/queue.h>
39 
40 /*
41  * Common structure pcb for internet protocol implementation.
42  * Here are stored pointers to local and foreign host table
43  * entries, local and foreign socket numbers, and pointers
44  * up (to a socket structure) and down (to a protocol-specific)
45  * control block.
46  */
47 struct inpcb {
48 	LIST_ENTRY(inpcb) inp_hash;
49 	CIRCLEQ_ENTRY(inpcb) inp_queue;
50 	struct	  inpcbtable *inp_table;
51 	int	  inp_state;		/* bind/connect state */
52 	u_int16_t inp_fport;		/* foreign port */
53 	u_int16_t inp_lport;		/* local port */
54 	struct	  socket *inp_socket;	/* back pointer to socket */
55 	caddr_t	  inp_ppcb;		/* pointer to per-protocol pcb */
56 	struct	  route inp_route;	/* placeholder for routing entry */
57 	int	  inp_flags;		/* generic IP/datagram flags */
58 	struct	  ip inp_ip;		/* header prototype; should have more */
59 	struct	  mbuf *inp_options;	/* IP options */
60 	struct	  ip_moptions *inp_moptions; /* IP multicast options */
61 	int	  inp_errormtu;		/* MTU of last xmit status = EMSGSIZE */
62 };
63 #define	inp_faddr	inp_ip.ip_dst
64 #define	inp_laddr	inp_ip.ip_src
65 
66 LIST_HEAD(inpcbhead, inpcb);
67 
68 struct inpcbtable {
69 	CIRCLEQ_HEAD(, inpcb) inpt_queue;
70 	struct	  inpcbhead *inpt_bindhashtbl;
71 	struct	  inpcbhead *inpt_connecthashtbl;
72 	u_long	  inpt_bindhash;
73 	u_long	  inpt_connecthash;
74 	u_int16_t inpt_lastport;
75 	u_int16_t inpt_lastlow;
76 };
77 #define inpt_lasthi inpt_lastport
78 
79 /* states in inp_state: */
80 #define	INP_ATTACHED		0
81 #define	INP_BOUND		1
82 #define	INP_CONNECTED		2
83 
84 /* flags in inp_flags: */
85 #define	INP_RECVOPTS		0x01	/* receive incoming IP options */
86 #define	INP_RECVRETOPTS		0x02	/* receive IP options for reply */
87 #define	INP_RECVDSTADDR		0x04	/* receive IP dst address */
88 #define	INP_HDRINCL		0x08	/* user supplies entire IP header */
89 #define	INP_HIGHPORT		0x10	/* (unused; FreeBSD compat) */
90 #define	INP_LOWPORT		0x20	/* user wants "low" port binding */
91 #define	INP_ANONPORT		0x40	/* port chosen for user */
92 #define	INP_RECVIF		0x80	/* receive incoming interface */
93 #define	INP_CONTROLOPTS		(INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
94 				INP_RECVIF)
95 
96 #define	INPLOOKUP_WILDCARD	1
97 
98 #define	sotoinpcb(so)		((struct inpcb *)(so)->so_pcb)
99 
100 #ifdef _KERNEL
101 void	in_losing __P((struct inpcb *));
102 int	in_pcballoc __P((struct socket *, void *));
103 int	in_pcbbind __P((void *, struct mbuf *, struct proc *));
104 int	in_pcbconnect __P((void *, struct mbuf *));
105 void	in_pcbdetach __P((void *));
106 void	in_pcbdisconnect __P((void *));
107 void	in_pcbinit __P((struct inpcbtable *, int, int));
108 struct inpcb *
109 	in_pcblookup_bind __P((struct inpcbtable *,
110 	    struct in_addr, u_int));
111 struct inpcb *
112 	in_pcblookup_connect __P((struct inpcbtable *,
113 	    struct in_addr, u_int, struct in_addr, u_int));
114 int	in_pcbnotify __P((struct inpcbtable *, struct in_addr, u_int,
115 	    struct in_addr, u_int, int, void (*)(struct inpcb *, int)));
116 void	in_pcbnotifyall __P((struct inpcbtable *, struct in_addr, int,
117 	    void (*)(struct inpcb *, int)));
118 void	in_pcbstate __P((struct inpcb *, int));
119 void	in_rtchange __P((struct inpcb *, int));
120 void	in_setpeeraddr __P((struct inpcb *, struct mbuf *));
121 void	in_setsockaddr __P((struct inpcb *, struct mbuf *));
122 struct rtentry *
123 	in_pcbrtentry __P((struct inpcb *));
124 #endif
125