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 #ifdef LOSCFG_NET_CONTAINER 51 #include "lwip/net_group.h" 52 #endif 53 54 #ifdef __cplusplus 55 extern "C" { 56 #endif 57 58 /* This is passed as the destination address to ip_output_if (not 59 to ip_output), meaning that an IP header already is constructed 60 in the pbuf. This is used when TCP retransmits. */ 61 #define LWIP_IP_HDRINCL NULL 62 63 /** pbufs passed to IP must have a ref-count of 1 as their payload pointer 64 gets altered as the packet is passed down the stack */ 65 #ifndef LWIP_IP_CHECK_PBUF_REF_COUNT_FOR_TX 66 #define LWIP_IP_CHECK_PBUF_REF_COUNT_FOR_TX(p) LWIP_ASSERT("p->ref == 1", (p)->ref == 1) 67 #endif 68 69 #if LWIP_NETIF_USE_HINTS 70 #define IP_PCB_NETIFHINT ;struct netif_hint netif_hints 71 #else /* LWIP_NETIF_USE_HINTS */ 72 #define IP_PCB_NETIFHINT 73 #endif /* LWIP_NETIF_USE_HINTS */ 74 75 #ifdef LOSCFG_NET_CONTAINER 76 #ifndef IP_PCB_NETGROUP 77 #define IP_PCB_NETGROUP 78 #endif 79 #endif 80 81 /** This is the common part of all PCB types. It needs to be at the 82 beginning of a PCB type definition. It is located here so that 83 changes to this common part are made in one location instead of 84 having to change all PCB structs. */ 85 #ifdef LOSCFG_NET_CONTAINER 86 #define IP_PCB \ 87 /* ip addresses in network byte order */ \ 88 ip_addr_t local_ip; \ 89 ip_addr_t remote_ip; \ 90 /* Bound netif index */ \ 91 u8_t netif_idx; \ 92 /* Socket options */ \ 93 u8_t so_options; \ 94 /* Type Of Service */ \ 95 u8_t tos; \ 96 /* Time To Live */ \ 97 u8_t ttl \ 98 /* link layer address resolution hint */ \ 99 IP_PCB_NETIFHINT \ 100 IP_PCB_NETGROUP 101 #else 102 #define IP_PCB \ 103 /* ip addresses in network byte order */ \ 104 ip_addr_t local_ip; \ 105 ip_addr_t remote_ip; \ 106 /* Bound netif index */ \ 107 u8_t netif_idx; \ 108 /* Socket options */ \ 109 u8_t so_options; \ 110 /* Type Of Service */ \ 111 u8_t tos; \ 112 /* Time To Live */ \ 113 u8_t ttl \ 114 /* link layer address resolution hint */ \ 115 IP_PCB_NETIFHINT 116 #endif 117 118 struct ip_pcb { 119 /* Common members of all PCB types */ 120 IP_PCB; 121 }; 122 123 /* 124 * Option flags per-socket. These are the same like SO_XXX in sockets.h 125 */ 126 #define SOF_REUSEADDR 0x04U /* allow local address reuse */ 127 #define SOF_KEEPALIVE 0x08U /* keep connections alive */ 128 #define SOF_BROADCAST 0x20U /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */ 129 130 /* These flags are inherited (e.g. from a listen-pcb to a connection-pcb): */ 131 #define SOF_INHERITED (SOF_REUSEADDR|SOF_KEEPALIVE) 132 133 /** Global variables of this module, kept in a struct for efficient access using base+index. */ 134 struct ip_globals 135 { 136 /** The interface that accepted the packet for the current callback invocation. */ 137 struct netif *current_netif; 138 /** The interface that received the packet for the current callback invocation. */ 139 struct netif *current_input_netif; 140 #if LWIP_IPV4 141 /** Header of the input packet currently being processed. */ 142 const struct ip_hdr *current_ip4_header; 143 #endif /* LWIP_IPV4 */ 144 #if LWIP_IPV6 145 /** Header of the input IPv6 packet currently being processed. */ 146 struct ip6_hdr *current_ip6_header; 147 #endif /* LWIP_IPV6 */ 148 /** Total header length of current_ip4/6_header (i.e. after this, the UDP/TCP header starts) */ 149 u16_t current_ip_header_tot_len; 150 /** Source IP address of current_header */ 151 ip_addr_t current_iphdr_src; 152 /** Destination IP address of current_header */ 153 ip_addr_t current_iphdr_dest; 154 }; 155 extern struct ip_globals ip_data; 156 157 158 /** Get the interface that accepted the current packet. 159 * This may or may not be the receiving netif, depending on your netif/network setup. 160 * This function must only be called from a receive callback (udp_recv, 161 * raw_recv, tcp_accept). It will return NULL otherwise. */ 162 #define ip_current_netif() (ip_data.current_netif) 163 /** Get the interface that received the current packet. 164 * This function must only be called from a receive callback (udp_recv, 165 * raw_recv, tcp_accept). It will return NULL otherwise. */ 166 #define ip_current_input_netif() (ip_data.current_input_netif) 167 /** Total header length of ip(6)_current_header() (i.e. after this, the UDP/TCP header starts) */ 168 #define ip_current_header_tot_len() (ip_data.current_ip_header_tot_len) 169 /** Source IP address of current_header */ 170 #define ip_current_src_addr() (&ip_data.current_iphdr_src) 171 /** Destination IP address of current_header */ 172 #define ip_current_dest_addr() (&ip_data.current_iphdr_dest) 173 174 #if LWIP_IPV4 && LWIP_IPV6 175 /** Get the IPv4 header of the current packet. 176 * This function must only be called from a receive callback (udp_recv, 177 * raw_recv, tcp_accept). It will return NULL otherwise. */ 178 #define ip4_current_header() ip_data.current_ip4_header 179 /** Get the IPv6 header of the current packet. 180 * This function must only be called from a receive callback (udp_recv, 181 * raw_recv, tcp_accept). It will return NULL otherwise. */ 182 #define ip6_current_header() ((const struct ip6_hdr*)(ip_data.current_ip6_header)) 183 /** Returns TRUE if the current IP input packet is IPv6, FALSE if it is IPv4 */ 184 #define ip_current_is_v6() (ip6_current_header() != NULL) 185 /** Source IPv6 address of current_header */ 186 #define ip6_current_src_addr() (ip_2_ip6(&ip_data.current_iphdr_src)) 187 /** Destination IPv6 address of current_header */ 188 #define ip6_current_dest_addr() (ip_2_ip6(&ip_data.current_iphdr_dest)) 189 /** Get the transport layer protocol */ 190 #define ip_current_header_proto() (ip_current_is_v6() ? \ 191 IP6H_NEXTH(ip6_current_header()) :\ 192 IPH_PROTO(ip4_current_header())) 193 /** Get the transport layer header */ 194 #define ip_next_header_ptr() ((const void*)((ip_current_is_v6() ? \ 195 (const u8_t*)ip6_current_header() : (const u8_t*)ip4_current_header()) + ip_current_header_tot_len())) 196 197 /** Source IP4 address of current_header */ 198 #define ip4_current_src_addr() (ip_2_ip4(&ip_data.current_iphdr_src)) 199 /** Destination IP4 address of current_header */ 200 #define ip4_current_dest_addr() (ip_2_ip4(&ip_data.current_iphdr_dest)) 201 202 #elif LWIP_IPV4 /* LWIP_IPV4 && LWIP_IPV6 */ 203 204 /** Get the IPv4 header of the current packet. 205 * This function must only be called from a receive callback (udp_recv, 206 * raw_recv, tcp_accept). It will return NULL otherwise. */ 207 #define ip4_current_header() ip_data.current_ip4_header 208 /** Always returns FALSE when only supporting IPv4 only */ 209 #define ip_current_is_v6() 0 210 /** Get the transport layer protocol */ 211 #define ip_current_header_proto() IPH_PROTO(ip4_current_header()) 212 /** Get the transport layer header */ 213 #define ip_next_header_ptr() ((const void*)((const u8_t*)ip4_current_header() + ip_current_header_tot_len())) 214 /** Source IP4 address of current_header */ 215 #define ip4_current_src_addr() (&ip_data.current_iphdr_src) 216 /** Destination IP4 address of current_header */ 217 #define ip4_current_dest_addr() (&ip_data.current_iphdr_dest) 218 219 #elif LWIP_IPV6 /* LWIP_IPV4 && LWIP_IPV6 */ 220 221 /** Get the IPv6 header of the current packet. 222 * This function must only be called from a receive callback (udp_recv, 223 * raw_recv, tcp_accept). It will return NULL otherwise. */ 224 #define ip6_current_header() ((const struct ip6_hdr*)(ip_data.current_ip6_header)) 225 /** Always returns TRUE when only supporting IPv6 only */ 226 #define ip_current_is_v6() 1 227 /** Get the transport layer protocol */ 228 #define ip_current_header_proto() IP6H_NEXTH(ip6_current_header()) 229 /** Get the transport layer header */ 230 #define ip_next_header_ptr() ((const void*)(((const u8_t*)ip6_current_header()) + ip_current_header_tot_len())) 231 /** Source IP6 address of current_header */ 232 #define ip6_current_src_addr() (&ip_data.current_iphdr_src) 233 /** Destination IP6 address of current_header */ 234 #define ip6_current_dest_addr() (&ip_data.current_iphdr_dest) 235 236 #endif /* LWIP_IPV6 */ 237 238 /** Union source address of current_header */ 239 #define ip_current_src_addr() (&ip_data.current_iphdr_src) 240 /** Union destination address of current_header */ 241 #define ip_current_dest_addr() (&ip_data.current_iphdr_dest) 242 243 /** Gets an IP pcb option (SOF_* flags) */ 244 #define ip_get_option(pcb, opt) ((pcb)->so_options & (opt)) 245 /** Sets an IP pcb option (SOF_* flags) */ 246 #define ip_set_option(pcb, opt) ((pcb)->so_options = (u8_t)((pcb)->so_options | (opt))) 247 /** Resets an IP pcb option (SOF_* flags) */ 248 #define ip_reset_option(pcb, opt) ((pcb)->so_options = (u8_t)((pcb)->so_options & ~(opt))) 249 250 #if LWIP_IPV4 && LWIP_IPV6 251 /** 252 * @ingroup ip 253 * Output IP packet, netif is selected by source address 254 */ 255 #define ip_output(p, src, dest, ttl, tos, proto) \ 256 (IP_IS_V6(dest) ? \ 257 ip6_output(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto) : \ 258 ip4_output(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto)) 259 /** 260 * @ingroup ip 261 * Output IP packet to specified interface 262 */ 263 #define ip_output_if(p, src, dest, ttl, tos, proto, netif) \ 264 (IP_IS_V6(dest) ? \ 265 ip6_output_if(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto, netif) : \ 266 ip4_output_if(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto, netif)) 267 /** 268 * @ingroup ip 269 * Output IP packet to interface specifying source address 270 */ 271 #define ip_output_if_src(p, src, dest, ttl, tos, proto, netif) \ 272 (IP_IS_V6(dest) ? \ 273 ip6_output_if_src(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto, netif) : \ 274 ip4_output_if_src(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto, netif)) 275 /** Output IP packet that already includes an IP header. */ 276 #define ip_output_if_hdrincl(p, src, dest, netif) \ 277 (IP_IS_V6(dest) ? \ 278 ip6_output_if(p, ip_2_ip6(src), LWIP_IP_HDRINCL, 0, 0, 0, netif) : \ 279 ip4_output_if(p, ip_2_ip4(src), LWIP_IP_HDRINCL, 0, 0, 0, netif)) 280 /** Output IP packet with netif_hint */ 281 #define ip_output_hinted(p, src, dest, ttl, tos, proto, netif_hint) \ 282 (IP_IS_V6(dest) ? \ 283 ip6_output_hinted(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto, netif_hint) : \ 284 ip4_output_hinted(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto, netif_hint)) 285 /** 286 * @ingroup ip 287 * Get netif for address combination. See \ref ip6_route and \ref ip4_route 288 */ 289 #ifdef LOSCFG_NET_CONTAINER 290 #define ip_route(src, dest, group) \ 291 (IP_IS_V6(dest) ? \ 292 ip6_route(ip_2_ip6(src), ip_2_ip6(dest), group) : \ 293 ip4_route_src(ip_2_ip4(src), ip_2_ip4(dest), group)) 294 #else 295 #define ip_route(src, dest) \ 296 (IP_IS_V6(dest) ? \ 297 ip6_route(ip_2_ip6(src), ip_2_ip6(dest)) : \ 298 ip4_route_src(ip_2_ip4(src), ip_2_ip4(dest))) 299 #endif 300 /** 301 * @ingroup ip 302 * Get netif for IP. 303 */ 304 #define ip_netif_get_local_ip(netif, dest) (IP_IS_V6(dest) ? \ 305 ip6_netif_get_local_ip(netif, ip_2_ip6(dest)) : \ 306 ip4_netif_get_local_ip(netif)) 307 #define ip_debug_print(is_ipv6, p) ((is_ipv6) ? ip6_debug_print(p) : ip4_debug_print(p)) 308 309 err_t ip_input(struct pbuf *p, struct netif *inp); 310 311 #elif LWIP_IPV4 /* LWIP_IPV4 && LWIP_IPV6 */ 312 313 #define ip_output(p, src, dest, ttl, tos, proto) \ 314 ip4_output(p, src, dest, ttl, tos, proto) 315 #define ip_output_if(p, src, dest, ttl, tos, proto, netif) \ 316 ip4_output_if(p, src, dest, ttl, tos, proto, netif) 317 #define ip_output_if_src(p, src, dest, ttl, tos, proto, netif) \ 318 ip4_output_if_src(p, src, dest, ttl, tos, proto, netif) 319 #define ip_output_hinted(p, src, dest, ttl, tos, proto, netif_hint) \ 320 ip4_output_hinted(p, src, dest, ttl, tos, proto, netif_hint) 321 #define ip_output_if_hdrincl(p, src, dest, netif) \ 322 ip4_output_if(p, src, LWIP_IP_HDRINCL, 0, 0, 0, netif) 323 #define ip_route(src, dest) \ 324 ip4_route_src(src, dest) 325 #define ip_netif_get_local_ip(netif, dest) \ 326 ip4_netif_get_local_ip(netif) 327 #define ip_debug_print(is_ipv6, p) ip4_debug_print(p) 328 329 #define ip_input ip4_input 330 331 #elif LWIP_IPV6 /* LWIP_IPV4 && LWIP_IPV6 */ 332 333 #define ip_output(p, src, dest, ttl, tos, proto) \ 334 ip6_output(p, src, dest, ttl, tos, proto) 335 #define ip_output_if(p, src, dest, ttl, tos, proto, netif) \ 336 ip6_output_if(p, src, dest, ttl, tos, proto, netif) 337 #define ip_output_if_src(p, src, dest, ttl, tos, proto, netif) \ 338 ip6_output_if_src(p, src, dest, ttl, tos, proto, netif) 339 #define ip_output_hinted(p, src, dest, ttl, tos, proto, netif_hint) \ 340 ip6_output_hinted(p, src, dest, ttl, tos, proto, netif_hint) 341 #define ip_output_if_hdrincl(p, src, dest, netif) \ 342 ip6_output_if(p, src, LWIP_IP_HDRINCL, 0, 0, 0, netif) 343 #define ip_route(src, dest) \ 344 ip6_route(src, dest) 345 #define ip_netif_get_local_ip(netif, dest) \ 346 ip6_netif_get_local_ip(netif, dest) 347 #define ip_debug_print(is_ipv6, p) ip6_debug_print(p) 348 349 #define ip_input ip6_input 350 351 #endif /* LWIP_IPV6 */ 352 353 #define ip_route_get_local_ip(src, dest, netif, ipaddr) do { \ 354 (netif) = ip_route(src, dest); \ 355 (ipaddr) = ip_netif_get_local_ip(netif, dest); \ 356 }while(0) 357 358 #ifdef LOSCFG_NET_CONTAINER 359 void set_ippcb_net_group(struct ip_pcb *pcb, struct net_group *group); 360 struct net_group *get_net_group_from_ippcb(struct ip_pcb *pcb); 361 #endif 362 #ifdef __cplusplus 363 } 364 #endif 365 366 #endif /* LWIP_HDR_IP_H */ 367 368 369