xref: /freebsd/sys/netinet/in_pcb.h (revision ce834215a70ff69e7e222827437116eee2f9ac6f)
1 /*
2  * Copyright (c) 1982, 1986, 1990, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)in_pcb.h	8.1 (Berkeley) 6/10/93
34  * $Id: in_pcb.h,v 1.20 1997/04/03 05:14:41 davidg Exp $
35  */
36 
37 #ifndef _NETINET_IN_PCB_H_
38 #define _NETINET_IN_PCB_H_
39 
40 #include <sys/queue.h>
41 
42 /*
43  * Common structure pcb for internet protocol implementation.
44  * Here are stored pointers to local and foreign host table
45  * entries, local and foreign socket numbers, and pointers
46  * up (to a socket structure) and down (to a protocol-specific)
47  * control block.
48  */
49 LIST_HEAD(inpcbhead, inpcb);
50 
51 struct inpcb {
52 	LIST_ENTRY(inpcb) inp_list;		/* list for all PCBs of this proto */
53 	LIST_ENTRY(inpcb) inp_hash;		/* hash list */
54 	struct	inpcbinfo *inp_pcbinfo;	/* PCB list info */
55 	struct	in_addr inp_faddr;	/* foreign host table entry */
56 	struct	in_addr inp_laddr;	/* local host table entry */
57 	u_short	inp_fport;		/* foreign port */
58 	u_short	inp_lport;		/* local port */
59 	caddr_t	inp_ppcb;		/* pointer to per-protocol pcb */
60 	struct	socket *inp_socket;	/* back pointer to socket */
61 	struct	mbuf *inp_options;	/* IP options */
62 	struct	route inp_route;	/* placeholder for routing entry */
63 	int	inp_flags;		/* generic IP/datagram flags */
64 	u_char	inp_ip_tos;		/* type of service proto */
65 	u_char	inp_ip_ttl;		/* time to live proto */
66 	u_char	inp_ip_p;		/* protocol proto */
67 	u_char	pad[1];			/* alignment */
68 	struct	ip_moptions *inp_moptions; /* IP multicast options */
69 #if 0 /* Someday, perhaps... */
70 	struct	ip inp_ip;		/* header prototype; should have more */
71 #endif
72 };
73 
74 struct inpcbinfo {
75 	struct inpcbhead *listhead;
76 	struct inpcbhead *hashbase;
77 	unsigned long hashmask;
78 	unsigned short lastport;
79 	unsigned short lastlow;
80 	unsigned short lasthi;
81 };
82 
83 #define INP_PCBHASH(faddr, lport, fport, mask) \
84 	(((faddr) ^ ((faddr) >> 16) ^ (lport) ^ (fport)) & (mask))
85 
86 /* flags in inp_flags: */
87 #define	INP_RECVOPTS		0x01	/* receive incoming IP options */
88 #define	INP_RECVRETOPTS		0x02	/* receive IP options for reply */
89 #define	INP_RECVDSTADDR		0x04	/* receive IP dst address */
90 #define	INP_HDRINCL		0x08	/* user supplies entire IP header */
91 #define	INP_HIGHPORT		0x10	/* user wants "high" port binding */
92 #define	INP_LOWPORT		0x20	/* user wants "low" port binding */
93 #define	INP_ANONPORT		0x40	/* port chosen for user */
94 #define	INP_RECVIF		0x80	/* receive incoming interface */
95 #define	INP_CONTROLOPTS		(INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
96 					INP_RECVIF)
97 
98 #define	INPLOOKUP_WILDCARD	1
99 
100 #define	sotoinpcb(so)	((struct inpcb *)(so)->so_pcb)
101 
102 #ifdef KERNEL
103 void	 in_losing __P((struct inpcb *));
104 int	 in_pcballoc __P((struct socket *, struct inpcbinfo *, struct proc *));
105 int	 in_pcbbind __P((struct inpcb *, struct mbuf *, struct proc *));
106 int	 in_pcbconnect __P((struct inpcb *, struct mbuf *, struct proc *));
107 void	 in_pcbdetach __P((struct inpcb *));
108 void	 in_pcbdisconnect __P((struct inpcb *));
109 int	 in_pcbladdr __P((struct inpcb *, struct mbuf *,
110 	    struct sockaddr_in **));
111 struct inpcb *
112 	 in_pcblookup __P((struct inpcbinfo *,
113 	    struct in_addr, u_int, struct in_addr, u_int, int));
114 struct inpcb *
115 	 in_pcblookuphash __P((struct inpcbinfo *,
116 	    struct in_addr, u_int, struct in_addr, u_int, int));
117 void	 in_pcbnotify __P((struct inpcbhead *, struct sockaddr *,
118 	    u_int, struct in_addr, u_int, int, void (*)(struct inpcb *, int)));
119 void	 in_pcbrehash __P((struct inpcb *));
120 int	 in_setpeeraddr __P((struct socket *so, struct mbuf *nam));
121 int	 in_setsockaddr __P((struct socket *so, struct mbuf *nam));
122 #endif
123 
124 #endif
125