UbixOS V2 2.0

ip.h
Go to the documentation of this file.
1
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 "net/opt.h"
41
42 #include "net/def.h"
43 #include "net/pbuf.h"
44 #include "net/ip_addr.h"
45 #include "net/err.h"
46 #include "net/netif.h"
47 #include "net/ip4.h"
48 #include "net/ip6.h"
49 #include "net/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
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
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
101 /* These flags are inherited (e.g. from a listen-pcb to a connection-pcb): */
102 #define SOF_INHERITED (SOF_REUSEADDR|SOF_KEEPALIVE)
103
105 struct ip_globals
106 {
108 struct netif *current_netif;
110 struct netif *current_input_netif;
111 #if LWIP_IPV4
112
113 struct ip_hdr *current_ip4_header;
114 #endif /* LWIP_IPV4 */
115 #if LWIP_IPV6
116
117 struct ip6_hdr *current_ip6_header;
118 #endif /* LWIP_IPV6 */
119
120 u16_t current_ip_header_tot_len;
122 ip_addr_t current_iphdr_src;
124 ip_addr_t current_iphdr_dest;
125 };
126 extern struct ip_globals ip_data;
127
128
133 #define ip_current_netif() (ip_data.current_netif)
134
137 #define ip_current_input_netif() (ip_data.current_input_netif)
138
139 #define ip_current_header_tot_len() (ip_data.current_ip_header_tot_len)
140
141 #define ip_current_src_addr() (&ip_data.current_iphdr_src)
142
143 #define ip_current_dest_addr() (&ip_data.current_iphdr_dest)
144
145 #if LWIP_IPV4 && LWIP_IPV6
146
149 #define ip4_current_header() ((const struct ip_hdr*)(ip_data.current_ip4_header))
150
153 #define ip6_current_header() ((const struct ip6_hdr*)(ip_data.current_ip6_header))
154
155 #define ip_current_is_v6() (ip6_current_header() != NULL)
156
157 #define ip6_current_src_addr() (ip_2_ip6(&ip_data.current_iphdr_src))
158
159 #define ip6_current_dest_addr() (ip_2_ip6(&ip_data.current_iphdr_dest))
160
161 #define ip_current_header_proto() (ip_current_is_v6() ? \
162 IP6H_NEXTH(ip6_current_header()) :\
163 IPH_PROTO(ip4_current_header()))
164
165 #define ip_next_header_ptr() ((const void*)((ip_current_is_v6() ? \
166 (const u8_t*)ip6_current_header() : (const u8_t*)ip4_current_header()) + ip_current_header_tot_len()))
167
169 #define ip4_current_src_addr() (ip_2_ip4(&ip_data.current_iphdr_src))
170
171 #define ip4_current_dest_addr() (ip_2_ip4(&ip_data.current_iphdr_dest))
172
173 #elif LWIP_IPV4 /* LWIP_IPV4 && LWIP_IPV6 */
174
178 #define ip4_current_header() ((const struct ip_hdr*)(ip_data.current_ip4_header))
179
180 #define ip_current_is_v6() 0
181
182 #define ip_current_header_proto() IPH_PROTO(ip4_current_header())
183
184 #define ip_next_header_ptr() ((const void*)((const u8_t*)ip4_current_header() + ip_current_header_tot_len()))
185
186 #define ip4_current_src_addr() (&ip_data.current_iphdr_src)
187
188 #define ip4_current_dest_addr() (&ip_data.current_iphdr_dest)
189
190 #elif LWIP_IPV6 /* LWIP_IPV4 && LWIP_IPV6 */
191
195 #define ip6_current_header() ((const struct ip6_hdr*)(ip_data.current_ip6_header))
196
197 #define ip_current_is_v6() 1
198
199 #define ip_current_header_proto() IP6H_NEXTH(ip6_current_header())
200
201 #define ip_next_header_ptr() ((const void*)((const u8_t*)ip6_current_header()))
202
203 #define ip6_current_src_addr() (&ip_data.current_iphdr_src)
204
205 #define ip6_current_dest_addr() (&ip_data.current_iphdr_dest)
206
207 #endif /* LWIP_IPV6 */
208
210 #define ip_current_src_addr() (&ip_data.current_iphdr_src)
211
212 #define ip_current_dest_addr() (&ip_data.current_iphdr_dest)
213
215 #define ip_get_option(pcb, opt) ((pcb)->so_options & (opt))
216
217 #define ip_set_option(pcb, opt) ((pcb)->so_options |= (opt))
218
219 #define ip_reset_option(pcb, opt) ((pcb)->so_options &= ~(opt))
220
221 #if LWIP_IPV4 && LWIP_IPV6
222
226 #define ip_output(p, src, dest, ttl, tos, proto) \
227 (IP_IS_V6(dest) ? \
228 ip6_output(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto) : \
229 ip4_output(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto))
230
234 #define ip_output_if(p, src, dest, ttl, tos, proto, netif) \
235 (IP_IS_V6(dest) ? \
236 ip6_output_if(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto, netif) : \
237 ip4_output_if(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto, netif))
238
242 #define ip_output_if_src(p, src, dest, ttl, tos, proto, netif) \
243 (IP_IS_V6(dest) ? \
244 ip6_output_if_src(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto, netif) : \
245 ip4_output_if_src(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto, netif))
246
247 #define ip_output_hinted(p, src, dest, ttl, tos, proto, addr_hint) \
248 (IP_IS_V6(dest) ? \
249 ip6_output_hinted(p, ip_2_ip6(src), ip_2_ip6(dest), ttl, tos, proto, addr_hint) : \
250 ip4_output_hinted(p, ip_2_ip4(src), ip_2_ip4(dest), ttl, tos, proto, addr_hint))
251
255 #define ip_route(src, dest) \
256 (IP_IS_V6(dest) ? \
257 ip6_route(ip_2_ip6(src), ip_2_ip6(dest)) : \
258 ip4_route_src(ip_2_ip4(dest), ip_2_ip4(src)))
259
263 #define ip_netif_get_local_ip(netif, dest) (IP_IS_V6(dest) ? \
264 ip6_netif_get_local_ip(netif, ip_2_ip6(dest)) : \
265 ip4_netif_get_local_ip(netif))
266 #define ip_debug_print(is_ipv6, p) ((is_ipv6) ? ip6_debug_print(p) : ip4_debug_print(p))
267
268 err_t ip_input(struct pbuf *p, struct netif *inp);
269
270 #elif LWIP_IPV4 /* LWIP_IPV4 && LWIP_IPV6 */
271
272 #define ip_output(p, src, dest, ttl, tos, proto) \
273 ip4_output(p, src, dest, ttl, tos, proto)
274 #define ip_output_if(p, src, dest, ttl, tos, proto, netif) \
275 ip4_output_if(p, src, dest, ttl, tos, proto, netif)
276 #define ip_output_if_src(p, src, dest, ttl, tos, proto, netif) \
277 ip4_output_if_src(p, src, dest, ttl, tos, proto, netif)
278 #define ip_output_hinted(p, src, dest, ttl, tos, proto, addr_hint) \
279 ip4_output_hinted(p, src, dest, ttl, tos, proto, addr_hint)
280 #define ip_route(src, dest) \
281 ip4_route_src(dest, src)
282 #define ip_netif_get_local_ip(netif, dest) \
283 ip4_netif_get_local_ip(netif)
284 #define ip_debug_print(is_ipv6, p) ip4_debug_print(p)
285
286 #define ip_input ip4_input
287
288 #elif LWIP_IPV6 /* LWIP_IPV4 && LWIP_IPV6 */
289
290 #define ip_output(p, src, dest, ttl, tos, proto) \
291 ip6_output(p, src, dest, ttl, tos, proto)
292 #define ip_output_if(p, src, dest, ttl, tos, proto, netif) \
293 ip6_output_if(p, src, dest, ttl, tos, proto, netif)
294 #define ip_output_if_src(p, src, dest, ttl, tos, proto, netif) \
295 ip6_output_if_src(p, src, dest, ttl, tos, proto, netif)
296 #define ip_output_hinted(p, src, dest, ttl, tos, proto, addr_hint) \
297 ip6_output_hinted(p, src, dest, ttl, tos, proto, addr_hint)
298 #define ip_route(src, dest) \
299 ip6_route(src, dest)
300 #define ip_netif_get_local_ip(netif, dest) \
301 ip6_netif_get_local_ip(netif, dest)
302 #define ip_debug_print(is_ipv6, p) ip6_debug_print(p)
303
304 #define ip_input ip6_input
305
306 #endif /* LWIP_IPV6 */
307
308 #define ip_route_get_local_ip(src, dest, netif, ipaddr) do { \
309 (netif) = ip_route(src, dest); \
310 (ipaddr) = ip_netif_get_local_ip(netif, dest); \
311 }while(0)
312
313 #ifdef __cplusplus
314 }
315 #endif
316
317 #endif /* LWIP_HDR_IP_H */
318
319
IP_PCB
#define IP_PCB
Definition: ip.h:76
opt.h
def.h
pbuf.h
u16_t
uint16_t u16_t
Definition: arch.h:124
ip_globals::current_ip_header_tot_len
u16_t current_ip_header_tot_len
Definition: ip.h:120
ip_data
struct ip_globals ip_data
ip_hdr
Definition: ip4.h:71
netif.h
err.h
ip_addr_t
ip6_addr_t ip_addr_t
Definition: ip_addr.h:290
ip_globals::current_input_netif
struct netif * current_input_netif
Definition: ip.h:110
netif
Definition: netif.h:233
ip_globals::current_iphdr_src
ip_addr_t current_iphdr_src
Definition: ip.h:122
ip_pcb
Definition: ip.h:89
err_t
s8_t err_t
Definition: err.h:57
ip.h
ip_globals::current_iphdr_dest
ip_addr_t current_iphdr_dest
Definition: ip.h:124
ip4.h
ip_globals::current_netif
struct netif * current_netif
Definition: ip.h:108
ip6_hdr
Definition: ip6.h:80
pbuf
Definition: pbuf.h:142
ip6.h
ip_addr.h
ip_globals
Definition: ip.h:105