1 /* 2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without modification, 6 * are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 3. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 25 * OF SUCH DAMAGE. 26 * 27 * This file is part of the lwIP TCP/IP stack. 28 * 29 * Author: Adam Dunkels <adam@sics.se> 30 * 31 */ 32 #ifndef __LWIP_IP_H__ 33 #define __LWIP_IP_H__ 34 35 #include "lwip/opt.h" 36 37 #include "lwip/def.h" 38 #include "lwip/pbuf.h" 39 #include "lwip/ip_addr.h" 40 #include "lwip/err.h" 41 #include "lwip/netif.h" 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 /** Currently, the function ip_output_if_opt() is only used with IGMP */ 48 #define IP_OPTIONS_SEND LWIP_IGMP 49 50 #define IP_HLEN 20 51 52 #define IP_PROTO_ICMP 1 53 #define IP_PROTO_IGMP 2 54 #define IP_PROTO_UDP 17 55 #define IP_PROTO_UDPLITE 136 56 #define IP_PROTO_TCP 6 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 #ifdef IP_HDRINCL 62 #undef IP_HDRINCL 63 #endif /* IP_HDRINCL */ 64 #define IP_HDRINCL NULL 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. 96 */ 97 /*#define SOF_DEBUG (u8_t)0x01U Unimplemented: turn on debugging info recording */ 98 #define SOF_ACCEPTCONN (u8_t)0x02U /* socket has had listen() */ 99 #define SOF_REUSEADDR (u8_t)0x04U /* allow local address reuse */ 100 #define SOF_KEEPALIVE (u8_t)0x08U /* keep connections alive */ 101 /*#define SOF_DONTROUTE (u8_t)0x10U Unimplemented: just use interface addresses */ 102 #define SOF_BROADCAST (u8_t)0x20U /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */ 103 /*#define SOF_USELOOPBACK (u8_t)0x40U Unimplemented: bypass hardware when possible */ 104 #define SOF_LINGER (u8_t)0x80U /* linger on close if data present */ 105 /*#define SOF_OOBINLINE (u16_t)0x0100U Unimplemented: leave received OOB data in line */ 106 /*#define SOF_REUSEPORT (u16_t)0x0200U Unimplemented: allow local address & port reuse */ 107 108 /* These flags are inherited (e.g. from a listen-pcb to a connection-pcb): */ 109 #define SOF_INHERITED (SOF_REUSEADDR|SOF_KEEPALIVE|SOF_LINGER/*|SOF_DEBUG|SOF_DONTROUTE|SOF_OOBINLINE*/) 110 111 112 #ifdef PACK_STRUCT_USE_INCLUDES 113 # include "arch/bpstruct.h" 114 #endif 115 PACK_STRUCT_BEGIN 116 struct ip_hdr { 117 /* version / header length / type of service */ 118 PACK_STRUCT_FIELD(u16_t _v_hl_tos); 119 /* total length */ 120 PACK_STRUCT_FIELD(u16_t _len); 121 /* identification */ 122 PACK_STRUCT_FIELD(u16_t _id); 123 /* fragment offset field */ 124 PACK_STRUCT_FIELD(u16_t _offset); 125 #define IP_RF 0x8000U /* reserved fragment flag */ 126 #define IP_DF 0x4000U /* dont fragment flag */ 127 #define IP_MF 0x2000U /* more fragments flag */ 128 #define IP_OFFMASK 0x1fffU /* mask for fragmenting bits */ 129 /* time to live */ 130 PACK_STRUCT_FIELD(u8_t _ttl); 131 /* protocol*/ 132 PACK_STRUCT_FIELD(u8_t _proto); 133 /* checksum */ 134 PACK_STRUCT_FIELD(u16_t _chksum); 135 /* source and destination IP addresses */ 136 PACK_STRUCT_FIELD(ip_addr_p_t src); 137 PACK_STRUCT_FIELD(ip_addr_p_t dest); 138 } PACK_STRUCT_STRUCT; 139 PACK_STRUCT_END 140 #ifdef PACK_STRUCT_USE_INCLUDES 141 # include "arch/epstruct.h" 142 #endif 143 144 #define IPH_V(hdr) (ntohs((hdr)->_v_hl_tos) >> 12) 145 #define IPH_HL(hdr) ((ntohs((hdr)->_v_hl_tos) >> 8) & 0x0f) 146 #define IPH_TOS(hdr) (ntohs((hdr)->_v_hl_tos) & 0xff) 147 #define IPH_LEN(hdr) ((hdr)->_len) 148 #define IPH_ID(hdr) ((hdr)->_id) 149 #define IPH_OFFSET(hdr) ((hdr)->_offset) 150 #define IPH_TTL(hdr) ((hdr)->_ttl) 151 #define IPH_PROTO(hdr) ((hdr)->_proto) 152 #define IPH_CHKSUM(hdr) ((hdr)->_chksum) 153 154 #define IPH_VHLTOS_SET(hdr, v, hl, tos) (hdr)->_v_hl_tos = (htons(((v) << 12) | ((hl) << 8) | (tos))) 155 #define IPH_LEN_SET(hdr, len) (hdr)->_len = (len) 156 #define IPH_ID_SET(hdr, id) (hdr)->_id = (id) 157 #define IPH_OFFSET_SET(hdr, off) (hdr)->_offset = (off) 158 #define IPH_TTL_SET(hdr, ttl) (hdr)->_ttl = (u8_t)(ttl) 159 #define IPH_PROTO_SET(hdr, proto) (hdr)->_proto = (u8_t)(proto) 160 #define IPH_CHKSUM_SET(hdr, chksum) (hdr)->_chksum = (chksum) 161 162 /** The interface that provided the packet for the current callback invocation. */ 163 extern struct netif *current_netif; 164 /** Header of the input packet currently being processed. */ 165 extern const struct ip_hdr *current_header; 166 /** Source IP address of current_header */ 167 extern ip_addr_t current_iphdr_src; 168 /** Destination IP address of current_header */ 169 extern ip_addr_t current_iphdr_dest; 170 171 #define ip_init() /* Compatibility define, not init needed. */ 172 struct netif *ip_route(ip_addr_t *dest); 173 err_t ip_input(struct pbuf *p, struct netif *inp); 174 err_t ip_output(struct pbuf *p, ip_addr_t *src, ip_addr_t *dest, 175 u8_t ttl, u8_t tos, u8_t proto); 176 err_t ip_output_if(struct pbuf *p, ip_addr_t *src, ip_addr_t *dest, 177 u8_t ttl, u8_t tos, u8_t proto, 178 struct netif *netif); 179 #if LWIP_NETIF_HWADDRHINT 180 err_t ip_output_hinted(struct pbuf *p, ip_addr_t *src, ip_addr_t *dest, 181 u8_t ttl, u8_t tos, u8_t proto, u8_t *addr_hint); 182 #endif /* LWIP_NETIF_HWADDRHINT */ 183 #if IP_OPTIONS_SEND 184 err_t ip_output_if_opt(struct pbuf *p, ip_addr_t *src, ip_addr_t *dest, 185 u8_t ttl, u8_t tos, u8_t proto, struct netif *netif, void *ip_options, 186 u16_t optlen); 187 #endif /* IP_OPTIONS_SEND */ 188 /** Get the interface that received the current packet. 189 * This function must only be called from a receive callback (udp_recv, 190 * raw_recv, tcp_accept). It will return NULL otherwise. */ 191 #define ip_current_netif() (current_netif) 192 /** Get the IP header of the current packet. 193 * This function must only be called from a receive callback (udp_recv, 194 * raw_recv, tcp_accept). It will return NULL otherwise. */ 195 #define ip_current_header() (current_header) 196 /** Source IP address of current_header */ 197 #define ip_current_src_addr() (¤t_iphdr_src) 198 /** Destination IP address of current_header */ 199 #define ip_current_dest_addr() (¤t_iphdr_dest) 200 201 #if IP_DEBUG 202 void ip_debug_print(struct pbuf *p); 203 #else 204 #define ip_debug_print(p) 205 #endif /* IP_DEBUG */ 206 207 #ifdef __cplusplus 208 } 209 #endif 210 211 #endif /* __LWIP_IP_H__ */ 212 213 214