1 /** 2 * @file 3 * IP API 4 */ 5 6 /* 7 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 8 * All rights reserved. 9 * 10 * Redistribution and use in source and binary forms, with or without modification, 11 * are permitted provided that the following conditions are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 3. The name of the author may not be used to endorse or promote products 19 * derived from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 24 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 26 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 29 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 30 * OF SUCH DAMAGE. 31 * 32 * This file is part of the lwIP TCP/IP stack. 33 * 34 * Author: Adam Dunkels <adam@sics.se> 35 * 36 */ 37 #ifndef LWIP_HDR_IP_H 38 #define LWIP_HDR_IP_H 39 40 #include "lwip/opt.h" 41 42 #include "lwip/def.h" 43 #include "lwip/pbuf.h" 44 #include "lwip/ip_addr.h" 45 #include "lwip/err.h" 46 #include "lwip/netif.h" 47 #include "lwip/ip4.h" 48 #include "lwip/ip6.h" 49 #include "lwip/prot/ip.h" 50 51 #ifdef __cplusplus 52 extern "C" { 53 #endif 54 55 /* This is passed as the destination address to ip_output_if (not 56 to ip_output), meaning that an IP header already is constructed 57 in the pbuf. This is used when TCP retransmits. */ 58 #define LWIP_IP_HDRINCL NULL 59 60 /** pbufs passed to IP must have a ref-count of 1 as their payload pointer 61 gets altered as the packet is passed down the stack */ 62 #ifndef LWIP_IP_CHECK_PBUF_REF_COUNT_FOR_TX 63 #define LWIP_IP_CHECK_PBUF_REF_COUNT_FOR_TX(p) LWIP_ASSERT("p->ref == 1", (p)->ref == 1) 64 #endif 65 66 #if LWIP_NETIF_HWADDRHINT 67 #define IP_PCB_ADDRHINT ;u8_t addr_hint 68 #else 69 #define IP_PCB_ADDRHINT 70 #endif /* LWIP_NETIF_HWADDRHINT */ 71 72 /** This is the common part of all PCB types. It needs to be at the 73 beginning of a PCB type definition. It is located here so that 74 changes to this common part are made in one location instead of 75 having to change all PCB structs. */ 76 #define IP_PCB \ 77 /* ip addresses in network byte order */ \ 78 ip_addr_t local_ip; \ 79 ip_addr_t remote_ip; \ 80 /* Socket options */ \ 81 u8_t so_options; \ 82 /* Type Of Service */ \ 83 u8_t tos; \ 84 /* Time To Live */ \ 85 u8_t ttl \ 86 /* link layer address resolution hint */ \ 87 IP_PCB_ADDRHINT 88 89 struct ip_pcb { 90 /* Common members of all PCB types */ 91 IP_PCB; 92 }; 93 94 /* 95 * Option flags per-socket. These are the same like SO_XXX in sockets.h 96 */ 97 #define SOF_REUSEADDR 0x04U /* allow local address reuse */ 98 #define SOF_KEEPALIVE 0x08U /* keep connections alive */ 99 #define SOF_BROADCAST 0x20U /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */ 100 #define SOF_TCPSACK 0x40U /* Allow TCP SACK (Selective acknowledgment) */ 101 102 /* These flags are inherited (e.g. from a listen-pcb to a connection-pcb): */ 103 #define SOF_INHERITED (SOF_REUSEADDR|SOF_KEEPALIVE) 104 105 /** Global variables of this module, kept in a struct for efficient access using base+index. */ 106 struct ip_globals 107 { 108 /** The interface that accepted the packet for the current callback invocation. */ 109 struct netif *current_netif; 110 /** The interface that received the packet for the current callback invocation. */ 111 struct netif *current_input_netif; 112 #if LWIP_IPV4 113 /** Header of the input packet currently being processed. */ 114 struct ip_hdr *current_ip4_header; 115 #endif /* LWIP_IPV4 */ 116 #if LWIP_IPV6 117 /** Header of the input IPv6 packet currently being processed. */ 118 struct ip6_hdr *current_ip6_header; 119 #endif /* LWIP_IPV6 */ 120 /** Total header length of current_ip4/6_header (i.e. after this, the UDP/TCP header starts) */ 121 u16_t current_ip_header_tot_len; 122 /** Source IP address of current_header */ 123 ip_addr_t current_iphdr_src; 124 /** Destination IP address of current_header */ 125 ip_addr_t current_iphdr_dest; 126 }; 127 extern struct ip_globals ip_data; 128 129 130 /** Get the interface that accepted the current packet. 131 * This may or may not be the receiving netif, depending on your netif/network setup. 132 * This function must only be called from a receive callback (udp_recv, 133 * raw_recv, tcp_accept). It will return NULL otherwise. */ 134 #define ip_current_netif() (ip_data.current_netif) 135 /** Get the interface that received the current packet. 136 * This function must only be called from a receive callback (udp_recv, 137 * raw_recv, tcp_accept). It will return NULL otherwise. */ 138 #define ip_current_input_netif() (ip_data.current_input_netif) 139 /** Total header length of ip(6)_current_header() (i.e. after this, the UDP/TCP header starts) */ 140 #define ip_current_header_tot_len() (ip_data.current_ip_header_tot_len) 141 /** Source IP address of current_header */ 142 #define ip_current_src_addr() (&ip_data.current_iphdr_src) 143 /** Destination IP address of current_header */ 144 #define ip_current_dest_addr() (&ip_data.current_iphdr_dest) 145 146 #if LWIP_IPV4 && LWIP_IPV6 147 /** Get the IPv4 header of the current packet. 148 * This function must only be called from a receive callback (udp_recv, 149 * raw_recv, tcp_accept). It will return NULL otherwise. */ 150 #define ip4_current_header() ((const struct ip_hdr*)(ip_data.current_ip4_header)) 151 /** Get the IPv6 header of the current packet. 152 * This function must only be called from a receive callback (udp_recv, 153 * raw_recv, tcp_accept). It will return NULL otherwise. */ 154 #define ip6_current_header() ((const struct ip6_hdr*)(ip_data.current_ip6_header)) 155 /** Returns TRUE if the current IP input packet is IPv6, FALSE if it is IPv4 */ 156 #define ip_current_is_v6() (ip6_current_header() != NULL) 157 /** Source IPv6 address of current_header */ 158 #define ip6_current_src_addr() (ip_2_ip6(&ip_data.current_iphdr_src)) 159 /** Destination IPv6 address of current_header */ 160 #define ip6_current_dest_addr() (ip_2_ip6(&ip_data.current_iphdr_dest)) 161 /** Get the transport layer protocol */ 162 #define ip_current_header_proto() (ip_current_is_v6() ? \ 163 IP6H_NEXTH(ip6_current_header()) :\ 164 IPH_PROTO(ip4_current_header())) 165 /** Get the transport layer header */ 166 #define ip_next_header_ptr() ((const void*)((ip_current_is_v6() ? \ 167 (const u8_t*)ip6_current_header() : (const u8_t*)ip4_current_header()) + ip_current_header_tot_len())) 168 169 /** Source IP4 address of current_header */ 170 #define ip4_current_src_addr() (ip_2_ip4(&ip_data.current_iphdr_src)) 171 /** Destination IP4 address of current_header */ 172 #define ip4_current_dest_addr() (ip_2_ip4(&ip_data.current_iphdr_dest)) 173 174 #elif LWIP_IPV4 /* LWIP_IPV4 && LWIP_IPV6 */ 175 176 /** Get the IPv4 header of the current packet. 177 * This function must only be called from a receive callback (udp_recv, 178 * raw_recv, tcp_accept). It will return NULL otherwise. */ 179 #define ip4_current_header() ((const struct ip_hdr*)(ip_data.current_ip4_header)) 180 /** Always returns FALSE when only supporting IPv4 only */ 181 #define ip_current_is_v6() 0 182 /** Get the transport layer protocol */ 183 #define ip_current_header_proto() IPH_PROTO(ip4_current_header()) 184 /** Get the transport layer header */ 185 #define ip_next_header_ptr() ((const void*)((const u8_t*)ip4_current_header() + ip_current_header_tot_len())) 186 /** Source IP4 address of current_header */ 187 #define ip4_current_src_addr() (&ip_data.current_iphdr_src) 188 /** Destination IP4 address of current_header */ 189 #define ip4_current_dest_addr() (&ip_data.current_iphdr_dest) 190 191 #elif LWIP_IPV6 /* LWIP_IPV4 && LWIP_IPV6 */ 192 193 /** Get the IPv6 header of the current packet. 194 * This function must only be called from a receive callback (udp_recv, 195 * raw_recv, tcp_accept). It will return NULL otherwise. */ 196 #define ip6_current_header() ((const struct ip6_hdr*)(ip_data.current_ip6_header)) 197 /** Always returns TRUE when only supporting IPv6 only */ 198 #define ip_current_is_v6() 1 199 /** Get the transport layer protocol */ 200 #define ip_current_header_proto() IP6H_NEXTH(ip6_current_header()) 201 /** Get the transport layer header */ 202 #define ip_next_header_ptr() ((const void*)((const u8_t*)ip6_current_header())) 203 /** Source IP6 address of current_header */ 204 #define ip6_current_src_addr() (&ip_data.current_iphdr_src) 205 /** Destination IP6 address of current_header */ 206 #define ip6_current_dest_addr() (&ip_data.current_iphdr_dest) 207 208 #endif /* LWIP_IPV6 */ 209 210 /** Union source address of current_header */ 211 #define ip_current_src_addr() (&ip_data.current_iphdr_src) 212 /** Union destination address of current_header */ 213 #define ip_current_dest_addr() (&ip_data.current_iphdr_dest) 214 215 /** Gets an IP pcb option (SOF_* flags) */ 216 #define ip_get_option(pcb, opt) ((pcb)->so_options & (opt)) 217 /** Sets an IP pcb option (SOF_* flags) */ 218 #define ip_set_option(pcb, opt) ((pcb)->so_options |= (opt)) 219 /** Resets an IP pcb option (SOF_* flags) */ 220 #define ip_reset_option(pcb, opt) ((pcb)->so_options &= ~(opt)) 221 222 #if LWIP_IPV4 && LWIP_IPV6 223 /** 224 * @ingroup ip 225 * Output IP packet, netif is selected by source address 226 */ 227 #define ip_output(p, src, dest, ttl, tos, proto) \ 228 (IP_IS_V6(dest) ? \ 229 ip6_output(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto) : \ 230 ip4_output(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto)) 231 /** 232 * @ingroup ip 233 * Output IP packet to specified interface 234 */ 235 #define ip_output_if(p, src, dest, ttl, tos, proto, netif) \ 236 (IP_IS_V6(dest) ? \ 237 ip6_output_if(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto, netif) : \ 238 ip4_output_if(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto, netif)) 239 /** 240 * @ingroup ip 241 * Output IP packet to interface specifying source address 242 */ 243 #define ip_output_if_src(p, src, dest, ttl, tos, proto, netif) \ 244 (IP_IS_V6(dest) ? \ 245 ip6_output_if_src(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto, netif) : \ 246 ip4_output_if_src(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto, netif)) 247 /** Output IP packet with addr_hint */ 248 #define ip_output_hinted(p, src, dest, ttl, tos, proto, addr_hint) \ 249 (IP_IS_V6(dest) ? \ 250 ip6_output_hinted(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto, addr_hint) : \ 251 ip4_output_hinted(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto, addr_hint)) 252 /** 253 * @ingroup ip 254 * Get netif for address combination. See \ref ip6_route and \ref ip4_route 255 */ 256 #define ip_route(src, dest) \ 257 (IP_IS_V6(dest) ? \ 258 ip6_route(ip_2_ip6(src), ip_2_ip6(dest)) : \ 259 ip4_route_src(ip_2_ip4(dest), ip_2_ip4(src))) 260 /** 261 * @ingroup ip 262 * Get netif for IP. 263 */ 264 #define ip_netif_get_local_ip(netif, dest) (IP_IS_V6(dest) ? \ 265 ip6_netif_get_local_ip(netif, ip_2_ip6(dest)) : \ 266 ip4_netif_get_local_ip(netif)) 267 #define ip_debug_print(is_ipv6, p) ((is_ipv6) ? ip6_debug_print(p) : ip4_debug_print(p)) 268 269 err_t ip_input(struct pbuf *p, struct netif *inp); 270 271 #elif LWIP_IPV4 /* LWIP_IPV4 && LWIP_IPV6 */ 272 273 #define ip_output(p, src, dest, ttl, tos, proto) \ 274 ip4_output(p, src, dest, ttl, tos, proto) 275 #define ip_output_if(p, src, dest, ttl, tos, proto, netif) \ 276 ip4_output_if(p, src, dest, ttl, tos, proto, netif) 277 #define ip_output_if_src(p, src, dest, ttl, tos, proto, netif) \ 278 ip4_output_if_src(p, src, dest, ttl, tos, proto, netif) 279 #define ip_output_hinted(p, src, dest, ttl, tos, proto, addr_hint) \ 280 ip4_output_hinted(p, src, dest, ttl, tos, proto, addr_hint) 281 #define ip_route(src, dest) \ 282 ip4_route_src(dest, src) 283 #define ip_netif_get_local_ip(netif, dest) \ 284 ip4_netif_get_local_ip(netif) 285 #define ip_debug_print(is_ipv6, p) ip4_debug_print(p) 286 287 #define ip_input ip4_input 288 289 #elif LWIP_IPV6 /* LWIP_IPV4 && LWIP_IPV6 */ 290 291 #define ip_output(p, src, dest, ttl, tos, proto) \ 292 ip6_output(p, src, dest, ttl, tos, proto) 293 #define ip_output_if(p, src, dest, ttl, tos, proto, netif) \ 294 ip6_output_if(p, src, dest, ttl, tos, proto, netif) 295 #define ip_output_if_src(p, src, dest, ttl, tos, proto, netif) \ 296 ip6_output_if_src(p, src, dest, ttl, tos, proto, netif) 297 #define ip_output_hinted(p, src, dest, ttl, tos, proto, addr_hint) \ 298 ip6_output_hinted(p, src, dest, ttl, tos, proto, addr_hint) 299 #define ip_route(src, dest) \ 300 ip6_route(src, dest) 301 #define ip_netif_get_local_ip(netif, dest) \ 302 ip6_netif_get_local_ip(netif, dest) 303 #define ip_debug_print(is_ipv6, p) ip6_debug_print(p) 304 305 #define ip_input ip6_input 306 307 #endif /* LWIP_IPV6 */ 308 309 #define ip_route_get_local_ip(src, dest, netif, ipaddr) do { \ 310 (netif) = ip_route(src, dest); \ 311 (ipaddr) = ip_netif_get_local_ip(netif, dest); \ 312 }while(0) 313 314 #ifdef __cplusplus 315 } 316 #endif 317 318 #endif /* LWIP_HDR_IP_H */ 319 320 321