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