1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2025-present Eclipse ThreadX Contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** Internet Protocol (IP) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SOURCE_CODE
/* Include necessary system files. */
#include "nx_api.h"
#include "nx_ip.h"
#include "nx_packet.h"
#ifndef NX_DISABLE_IPV4
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_ip_forward_packet_process PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function attempts to forward the IP packet to the destination */
/* IP by using the NetX send packet routine. Note that the IP header */
/* is still intact prior to the packet. */
/* */
/* INPUT */
/* */
/* ip_ptr Pointer to IP control block */
/* packet_ptr Pointer to packet to forward */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* _nx_packet_release Packet release */
/* _nx_packet_data_adjust Adjust the packet data to fill*/
/* the specified header */
/* _nx_ip_driver_packet_send Send the IP packet */
/* _nx_ip_fragment_forward_packet Fragment the forward packet */
/* _nx_ip_packet_deferred_receive IP deferred receive packet */
/* processing */
/* _nx_ip_route_find Find suitable outgoing */
/* interface */
/* */
/* CALLED BY */
/* */
/* _nx_ip_packet_receive Receive IP packet */
/* */
/**************************************************************************/
VOID _nx_ip_forward_packet_process(NX_IP *ip_ptr, NX_PACKET *packet_ptr)
{
NX_IPV4_HEADER *ip_header_ptr;
NX_INTERFACE *outgoing_interface = NX_NULL;
ULONG next_hop_address = 0;
ULONG destination_ip;
ULONG time_to_live;
ULONG fragment_bit;
ULONG status;
#ifdef NX_ENABLE_INTERFACE_CAPABILITY
UINT compute_checksum = 1;
#endif
ULONG checksum;
ULONG old_m;
ULONG new_m;
/* The NetX IP forwarding consists of simply sending the same packet out through
the internal send routine. Applications may choose to modify this code or
replace the nx_ip_forward_packet_process pointer in the IP structure to point
at an application-specific routine for forwarding. */
/* It's assumed that the IP header is still present in front of the packet. Position
backwards to access it. */
/*lint -e{927} -e{826} suppress cast of pointer to pointer, since it is necessary */
ip_header_ptr = (NX_IPV4_HEADER *)packet_ptr -> nx_packet_prepend_ptr;
/* Check for if the destination address is Class D address. */
if ((ip_header_ptr -> nx_ip_header_destination_ip & NX_IP_CLASS_D_MASK) == NX_IP_CLASS_D_TYPE)
{
/* Discard the packet. */
_nx_packet_release(packet_ptr);
return;
}
/* Determine if source address or destination addrss is link-local address(169.254/16 Hexadecimal:0xA9FE0000). */
if (((ip_header_ptr -> nx_ip_header_source_ip & 0xFFFF0000) == 0xA9FE0000) ||
((ip_header_ptr -> nx_ip_header_destination_ip & 0xFFFF0000) == 0xA9FE0000))
{
/* Discard the packet. */
_nx_packet_release(packet_ptr);
return;
}
/* Check whether find the correct forwarding interface. */
if (_nx_ip_route_find(ip_ptr, ip_header_ptr -> nx_ip_header_destination_ip, &outgoing_interface, &next_hop_address) == NX_SUCCESS)
{
/* If the forwarding interface is same as the receiving interface,
According to the RFC 792 Redirect Message on page 12,
send a redirect message to source address. */
/* Update the forwarding interface. */
/*lint -e{644} suppress variable might not be initialized, since "outgoing_interface" was initialized as long as return value is NX_SUCCESS. */
packet_ptr -> nx_packet_ip_interface = outgoing_interface;
/* Get the relevant information from original packet. */
destination_ip = ip_header_ptr -> nx_ip_header_destination_ip;
time_to_live = ((ip_header_ptr -> nx_ip_header_word_2 & NX_IP_TIME_TO_LIVE_MASK) >> NX_IP_TIME_TO_LIVE_SHIFT) - 1;
fragment_bit = (ip_header_ptr -> nx_ip_header_word_1 & NX_DONT_FRAGMENT);
/* If the TTL is 0, discard the packet. */
if (!time_to_live)
{
#ifndef NX_DISABLE_IP_INFO
/* Increment the IP receive packets dropped count. */
ip_ptr -> nx_ip_receive_packets_dropped++;
#endif
/* No correct forwarding interface, toss the packet! */
_nx_packet_release(packet_ptr);
return;
}
/* Update the TTL value. */
ip_header_ptr -> nx_ip_header_word_2 = (ip_header_ptr -> nx_ip_header_word_2 - 0x01000000);
/* Update the checksum, according to the RFC1624 page2, Eqn.3.
HC - old checksum in header
HC' - new checksum in header
m - old value of a 16-bit field
m' - new value of a 16-bit field
HC' = ~(C + (-m) + m')
= ~(~HC + ~m + m') */
#ifdef NX_ENABLE_INTERFACE_CAPABILITY
if (packet_ptr -> nx_packet_ip_interface -> nx_interface_capability_flag & NX_INTERFACE_CAPABILITY_IPV4_TX_CHECKSUM)
{
compute_checksum = 0;
}
#endif
#ifdef NX_ENABLE_INTERFACE_CAPABILITY
/* Check whether the destination IP address matched with one interface of IP instance. */
/*lint -e{613} suppress possible use of null pointer, since "outgoing_interface" was set in _nx_ip_route_find. */
if (outgoing_interface -> nx_interface_ip_address == destination_ip)
{
/* Clear the capability flag. */
packet_ptr -> nx_packet_interface_capability_flag &= (ULONG)(~NX_INTERFACE_CAPABILITY_IPV4_RX_CHECKSUM);
/* Set the computer checksum flag. */
compute_checksum = 1;
}
#endif
#ifdef NX_ENABLE_INTERFACE_CAPABILITY
/* Computer the checksum. */
/*lint -e{774} suppress boolean always evaluates to True, since it is necessary with NX_ENABLE_INTERFACE_CAPABILITY macro. */
if (compute_checksum)
{
#endif
/* Get the old checksum (HC) in header. */
checksum = ip_header_ptr -> nx_ip_header_word_2 & NX_LOWER_16_MASK;
/* Get the new TTL(m') in the header. */
new_m = (ip_header_ptr -> nx_ip_header_word_2 & 0xFFFF0000) >> 16;
/* Get the old TTL(m). */
old_m = new_m + 0x0100;
/* Update the checksum, get the new checksum(HC'),
The new_m is ULONG value, so need get the lower value after invert. */
checksum = ((~checksum) & 0xFFFF) + ((~old_m) & 0xFFFF) + new_m;
/* Fold a 4-byte value into a two byte value */
checksum = (checksum >> 16) + (checksum & 0xFFFF);
/* Do it again in case previous operation generates an overflow */
checksum = (checksum >> 16) + (checksum & 0xFFFF);
/* Now store the new checksum in the IP header. */
ip_header_ptr -> nx_ip_header_word_2 = ((ip_header_ptr -> nx_ip_header_word_2 & 0xFFFF0000) | ((~checksum) & NX_LOWER_16_MASK));
#ifdef NX_ENABLE_INTERFACE_CAPABILITY
}
else
{
/* Set the checksum to 0. */
ip_header_ptr -> nx_ip_header_word_2 = (ip_header_ptr -> nx_ip_header_word_2 & 0xFFFF0000);
packet_ptr -> nx_packet_interface_capability_flag |= NX_INTERFACE_CAPABILITY_IPV4_TX_CHECKSUM;
}
#endif /* NX_ENABLE_INTERFACE_CAPABILITY */
/* Endian swapping logic. If NX_LITTLE_ENDIAN is specified, these macros will
swap the endian of the IP header. */
NX_CHANGE_ULONG_ENDIAN(ip_header_ptr -> nx_ip_header_word_0);
NX_CHANGE_ULONG_ENDIAN(ip_header_ptr -> nx_ip_header_word_1);
NX_CHANGE_ULONG_ENDIAN(ip_header_ptr -> nx_ip_header_word_2);
NX_CHANGE_ULONG_ENDIAN(ip_header_ptr -> nx_ip_header_source_ip);
NX_CHANGE_ULONG_ENDIAN(ip_header_ptr -> nx_ip_header_destination_ip);
/* Check whether the destination IP address matched with one interface of IP instance. */
/*lint -e{613} suppress possible use of null pointer, since "outgoing_interface" was set in _nx_ip_route_find. */
if (outgoing_interface -> nx_interface_ip_address == destination_ip)
{
/* Forward this packet to correct interface. */
_nx_ip_packet_deferred_receive(ip_ptr, packet_ptr);
return;
}
else
{
/* Check if the packet can fill physical header. */
status = _nx_packet_data_adjust(packet_ptr, NX_PHYSICAL_HEADER);
/* Check status. */
if (status)
{
/* Release the packet. */
_nx_packet_release(packet_ptr);
return;
}
/* Determine if fragmentation is needed. */
if (packet_ptr -> nx_packet_length <= packet_ptr -> nx_packet_address.nx_packet_interface_ptr -> nx_interface_ip_mtu_size)
{
/* Call the function to directly forward the packet. */
/*lint -e{644} suppress variable might not be initialized, since "next_hop_address" was initialized in _nx_ip_route_find. */
_nx_ip_driver_packet_send(ip_ptr, packet_ptr, destination_ip, fragment_bit, next_hop_address);
return;
}
#ifndef NX_DISABLE_FRAGMENTATION
else
{
/* Check the DF bit flag. */
if ((ip_ptr -> nx_ip_fragment_processing) && (!(fragment_bit & NX_DONT_FRAGMENT)))
{
/* Fragment and send the packet. */
_nx_ip_fragment_forward_packet(ip_ptr, packet_ptr, destination_ip, NX_FRAGMENT_OKAY, next_hop_address);
return;
}
}
#endif
}
}
/* No correct forwarding interface, toss the packet! */
_nx_packet_release(packet_ptr);
return;
}
#endif /* NX_DISABLE_IPV4 */
|
