Home | History | Annotate | Line # | Download | only in netinet
in_pcb.h revision 1.69
      1 /*	$NetBSD: in_pcb.h,v 1.69 2020/09/08 14:12:57 christos 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/types.h>
     67 
     68 #include <net/route.h>
     69 
     70 #include <netinet/in.h>
     71 #include <netinet/in_pcb_hdr.h>
     72 #include <netinet/ip.h>
     73 
     74 struct ip_moptions;
     75 struct mbuf;
     76 
     77 /*
     78  * Common structure pcb for internet protocol implementation.
     79  * Here are stored pointers to local and foreign host table
     80  * entries, local and foreign socket numbers, and pointers
     81  * up (to a socket structure) and down (to a protocol-specific)
     82  * control block.
     83  */
     84 struct inpcb {
     85 	struct inpcb_hdr inp_head;
     86 #define inp_hash	inp_head.inph_hash
     87 #define inp_queue	inp_head.inph_queue
     88 #define inp_af		inp_head.inph_af
     89 #define inp_ppcb	inp_head.inph_ppcb
     90 #define inp_state	inp_head.inph_state
     91 #define inp_portalgo	inp_head.inph_portalgo
     92 #define inp_socket	inp_head.inph_socket
     93 #define inp_table	inp_head.inph_table
     94 #define inp_sp		inp_head.inph_sp
     95 	struct	  route inp_route;	/* placeholder for routing entry */
     96 	u_int16_t inp_fport;		/* foreign port */
     97 	u_int16_t inp_lport;		/* local port */
     98 	int	  inp_flags;		/* generic IP/datagram flags */
     99 	struct	  ip inp_ip;		/* header prototype; should have more */
    100 	struct	  mbuf *inp_options;	/* IP options */
    101 	struct	  ip_moptions *inp_moptions; /* IP multicast options */
    102 	int	  inp_errormtu;		/* MTU of last xmit status = EMSGSIZE */
    103 	uint8_t	  inp_ip_minttl;
    104 	bool      inp_bindportonsend;
    105 	struct    in_addr inp_prefsrcip; /* preferred src IP when wild  */
    106 	pcb_overudp_cb_t inp_overudp_cb;
    107 	void      *inp_overudp_arg;
    108 };
    109 
    110 #define	inp_faddr	inp_ip.ip_dst
    111 #define	inp_laddr	inp_ip.ip_src
    112 
    113 /* flags in inp_flags: */
    114 #define	INP_RECVOPTS		0x0001	/* receive incoming IP options */
    115 #define	INP_RECVRETOPTS		0x0002	/* receive IP options for reply */
    116 #define	INP_RECVDSTADDR		0x0004	/* receive IP dst address */
    117 #define	INP_HDRINCL		0x0008	/* user supplies entire IP header */
    118 #define	INP_HIGHPORT		0x0010	/* (unused; FreeBSD compat) */
    119 #define	INP_LOWPORT		0x0020	/* user wants "low" port binding */
    120 #define	INP_ANONPORT		0x0040	/* port chosen for user */
    121 #define	INP_RECVIF		0x0080	/* receive incoming interface */
    122 /* XXX should move to an UDP control block */
    123 #define INP_ESPINUDP		0x0100	/* ESP over UDP for NAT-T */
    124 #define INP_ESPINUDP_NON_IKE	0x0200	/* ESP over UDP for NAT-T */
    125 #define INP_NOHEADER		0x0400	/* Kernel removes IP header
    126 					 * before feeding a packet
    127 					 * to the raw socket user.
    128 					 * The socket user will
    129 					 * not supply an IP header.
    130 					 * Cancels INP_HDRINCL.
    131 					 */
    132 #define	INP_RECVTTL		0x0800	/* receive incoming IP TTL */
    133 #define	INP_RECVPKTINFO		0x1000	/* receive IP dst if/addr */
    134 #define	INP_BINDANY		0x2000	/* allow bind to any address */
    135 #define	INP_CONTROLOPTS		(INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
    136 				INP_RECVIF|INP_RECVTTL|INP_RECVPKTINFO)
    137 
    138 #define	sotoinpcb(so)		((struct inpcb *)(so)->so_pcb)
    139 #define	inp_lock(inp)		solock((inp)->inp_socket)
    140 #define	inp_unlock(inp)		sounlock((inp)->inp_socket)
    141 #define	inp_locked(inp)		solocked((inp)->inp_socket)
    142 
    143 #ifdef _KERNEL
    144 
    145 #include <sys/kauth.h>
    146 #include <sys/queue.h>
    147 
    148 struct inpcbtable;
    149 struct lwp;
    150 struct rtentry;
    151 struct sockaddr_in;
    152 struct socket;
    153 struct vestigial_inpcb;
    154 
    155 void	in_losing(struct inpcb *);
    156 int	in_pcballoc(struct socket *, void *);
    157 int	in_pcbbindableaddr(const struct inpcb *, struct sockaddr_in *,
    158     kauth_cred_t);
    159 int	in_pcbbind(void *, struct sockaddr_in *, struct lwp *);
    160 int	in_pcbconnect(void *, struct sockaddr_in *, struct lwp *);
    161 void	in_pcbdetach(void *);
    162 void	in_pcbdisconnect(void *);
    163 void	in_pcbinit(struct inpcbtable *, int, int);
    164 struct inpcb *
    165 	in_pcblookup_port(struct inpcbtable *,
    166 			  struct in_addr, u_int, int, struct vestigial_inpcb *);
    167 struct inpcb *
    168 	in_pcblookup_bind(struct inpcbtable *,
    169 	    struct in_addr, u_int);
    170 struct inpcb *
    171 	in_pcblookup_connect(struct inpcbtable *,
    172 			     struct in_addr, u_int, struct in_addr, u_int,
    173 			     struct vestigial_inpcb *);
    174 int	in_pcbnotify(struct inpcbtable *, struct in_addr, u_int,
    175 	    struct in_addr, u_int, int, void (*)(struct inpcb *, int));
    176 void	in_pcbnotifyall(struct inpcbtable *, struct in_addr, int,
    177 	    void (*)(struct inpcb *, int));
    178 void	in_pcbpurgeif0(struct inpcbtable *, struct ifnet *);
    179 void	in_pcbpurgeif(struct inpcbtable *, struct ifnet *);
    180 void	in_purgeifmcast(struct ip_moptions *, struct ifnet *);
    181 void	in_pcbstate(struct inpcb *, int);
    182 void	in_rtchange(struct inpcb *, int);
    183 void	in_setpeeraddr(struct inpcb *, struct sockaddr_in *);
    184 void	in_setsockaddr(struct inpcb *, struct sockaddr_in *);
    185 struct rtentry *
    186 	in_pcbrtentry(struct inpcb *);
    187 void	in_pcbrtentry_unref(struct rtentry *, struct inpcb *);
    188 
    189 static inline void
    190 in_pcb_register_overudp_cb(struct inpcb *inp, pcb_overudp_cb_t cb, void *arg)
    191 {
    192 
    193 	inp->inp_overudp_cb = cb;
    194 	inp->inp_overudp_arg = arg;
    195 }
    196 
    197 #endif	/* _KERNEL */
    198 
    199 #endif	/* !_NETINET_IN_PCB_H_ */
    200