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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
|
/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation */
/* Copyright (c) 2026 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 */
/***************************************************************************/
/* This NetX test concentrates on the UCP operation. */
#include "tx_api.h"
#include "nx_api.h"
#include "nx_tcp.h"
#include "nx_udp.h"
extern void test_control_return(UINT status);
#if defined NX_NAT_ENABLE && defined __PRODUCT_NETXDUO__ && (NX_MAX_PHYSICAL_INTERFACES >= 2) && !defined(NX_DISABLE_IPV4)
#include "nx_nat.h"
#define DEMO_STACK_SIZE 2048
/* Define the ThreadX and NetX object control blocks... */
static TX_THREAD thread_0;
/* Set up the NAT components. */
/* Create a NAT instance, packet pool and translation table. */
NX_PACKET_POOL nat_packet_pool;
NX_NAT_DEVICE nat_server;
NX_IP nat_ip;
NX_IP local_ip;
NX_IP external_ip;
NX_UDP_SOCKET local_socket;
NX_UDP_SOCKET external_socket;
/* Configure the NAT network parameters. */
/* Set NetX IP packet pool packet size. This should be less than the Maximum Transmit Unit (MTU) of
the driver (allow enough room for the Ethernet header plus padding bytes for frame alignment). */
#define NX_NAT_PACKET_SIZE 1536
/* Set the size of the NAT IP packet pool. */
#define NX_NAT_PACKET_POOL_SIZE (NX_NAT_PACKET_SIZE * 10)
/* Set NetX IP helper thread stack size. */
#define NX_NAT_IP_THREAD_STACK_SIZE 2048
/* Set the server IP thread priority */
#define NX_NAT_IP_THREAD_PRIORITY 2
/* Set ARP cache size of a NAT ip instance. */
#define NX_NAT_ARP_CACHE_SIZE 1024
/* Set NAT entries memory size. */
#define NX_NAT_ENTRY_CACHE_SIZE 1024
/* Define NAT IP addresses, local host private IP addresses and external host IP address. */
#define NX_NAT_LOCAL_IPADR (IP_ADDRESS(192, 168, 2, 1))
#define NX_NAT_LOCAL_HOST1 (IP_ADDRESS(192, 168, 2, 3))
#define NX_NAT_LOCAL_HOST2 (IP_ADDRESS(192, 168, 2, 10))
#define NX_NAT_LOCAL_GATEWAY (IP_ADDRESS(192, 168, 2, 1))
#define NX_NAT_LOCAL_NETMASK (IP_ADDRESS(255, 255, 255, 0))
#define NX_NAT_EXTERNAL_IPADR (IP_ADDRESS(192, 168, 0, 10))
#define NX_NAT_EXTERNAL_HOST (IP_ADDRESS(192, 168, 0, 100))
#define NX_NAT_EXTERNAL_GATEWAY (IP_ADDRESS(192, 168, 0, 1))
#define NX_NAT_EXTERNAL_NETMASK (IP_ADDRESS(255, 255, 255, 0))
/* Create NAT structures for preloading NAT tables with static
entries for local server hosts. */
NX_NAT_TRANSLATION_ENTRY server_inbound_entry_udp;
/* Set up generic network driver for demo program. */
extern void _nx_ram_network_driver_1500(struct NX_IP_DRIVER_STRUCT *driver_req);
extern UINT (*advanced_packet_process_callback)(NX_IP *ip_ptr, NX_PACKET *packet_ptr, UINT *operation_ptr, UINT *delay_ptr);
/* Define thread prototypes. */
static void thread_0_entry(ULONG thread_input);
static void thread_1_entry(ULONG thread_input);
static UINT packet_process(NX_IP *ip_ptr, NX_PACKET *packet_ptr, UINT *operation_ptr, UINT *delay_ptr);
/* Define what the initial system looks like. */
#ifdef CTEST
VOID test_application_define(void *first_unused_memory)
#else
void netx_nat_invalid_header_test_application_define(void *first_unused_memory)
#endif
{
UINT status;
UCHAR *pointer;
UINT error_counter = 0;
/* Initialize the NetX system. */
nx_system_initialize();
/* Setup the pointer to unallocated memory. */
pointer = (UCHAR *) first_unused_memory;
/* Create the main thread. */
tx_thread_create(&thread_0, "thread 0", thread_0_entry, 0,
pointer, DEMO_STACK_SIZE,
4, 4, TX_NO_TIME_SLICE, TX_AUTO_START);
pointer = pointer + DEMO_STACK_SIZE;
/* Create NAT packet pool. */
status = nx_packet_pool_create(&nat_packet_pool, "NAT Packet Pool",
NX_NAT_PACKET_SIZE, pointer,
NX_NAT_PACKET_POOL_SIZE);
/* Update pointer to unallocated (free) memory. */
pointer = pointer + NX_NAT_PACKET_POOL_SIZE;
/* Check status. */
if (status)
return;
/* Create IP instances for NAT server (global network) */
status = nx_ip_create(&nat_ip, "NAT IP Instance", NX_NAT_EXTERNAL_IPADR, NX_NAT_EXTERNAL_NETMASK,
&nat_packet_pool, _nx_ram_network_driver_1500, pointer,
NX_NAT_IP_THREAD_STACK_SIZE, NX_NAT_IP_THREAD_PRIORITY);
/* Update pointer to unallocated (free) memory. */
pointer = pointer + NX_NAT_IP_THREAD_STACK_SIZE;
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Set the private interface(private network). */
status += nx_ip_interface_attach(&nat_ip, "Private Interface", NX_NAT_LOCAL_IPADR, NX_NAT_LOCAL_NETMASK, _nx_ram_network_driver_1500);
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Create IP instances for Local network IP instance */
status = nx_ip_create(&local_ip, "Local IP Instance", NX_NAT_LOCAL_HOST1, NX_NAT_LOCAL_NETMASK,
&nat_packet_pool, _nx_ram_network_driver_1500, pointer,
NX_NAT_IP_THREAD_STACK_SIZE, NX_NAT_IP_THREAD_PRIORITY);
/* Update pointer to unallocated (free) memory. */
pointer = pointer + NX_NAT_IP_THREAD_STACK_SIZE;
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Create IP instances for external network IP instance */
status = nx_ip_create(&external_ip, "External IP Instance", NX_NAT_EXTERNAL_HOST, NX_NAT_EXTERNAL_NETMASK,
&nat_packet_pool, _nx_ram_network_driver_1500, pointer,
NX_NAT_IP_THREAD_STACK_SIZE, NX_NAT_IP_THREAD_PRIORITY);
/* Update pointer to unallocated (free) memory. */
pointer = pointer + NX_NAT_IP_THREAD_STACK_SIZE;
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Set the global network gateway for NAT IP instance. */
status = nx_ip_gateway_address_set(&nat_ip, NX_NAT_EXTERNAL_GATEWAY);
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Set the global network gateway for Local IP instance. */
status = nx_ip_gateway_address_set(&local_ip, NX_NAT_LOCAL_GATEWAY);
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Set the global network gateway for External IP instance. */
status = nx_ip_gateway_address_set(&external_ip, NX_NAT_EXTERNAL_GATEWAY);
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Enable ARP and supply ARP cache memory for NAT IP instance. */
status = nx_arp_enable(&nat_ip, (void **) pointer,
NX_NAT_ARP_CACHE_SIZE);
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Update pointer to unallocated (free) memory. */
pointer = pointer + NX_NAT_ARP_CACHE_SIZE;
/* Enable ARP and supply ARP cache memory for Local IP instance. */
status = nx_arp_enable(&local_ip, (void **) pointer,
NX_NAT_ARP_CACHE_SIZE);
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Update pointer to unallocated (free) memory. */
pointer = pointer + NX_NAT_ARP_CACHE_SIZE;
/* Enable ARP and supply ARP cache memory for External IP instance. */
status = nx_arp_enable(&external_ip, (void **) pointer,
NX_NAT_ARP_CACHE_SIZE);
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Update pointer to unallocated (free) memory. */
pointer = pointer + NX_NAT_ARP_CACHE_SIZE;
/* Enable UDP traffic. */
status = nx_udp_enable(&nat_ip);
status += nx_udp_enable(&local_ip);
status += nx_udp_enable(&external_ip);
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Create a NetX NAT server and cache with a global interface index. */
status = nx_nat_create(&nat_server, &nat_ip, 0, pointer, NX_NAT_ENTRY_CACHE_SIZE);
/* Check status. */
if (status)
{
error_counter++;
return;
}
/* Update pointer to unallocated (free) memory. */
pointer = pointer + NX_NAT_ENTRY_CACHE_SIZE;
}
/* Define the test threads. */
static void thread_0_entry(ULONG thread_input)
{
UINT status;
NX_PACKET *my_packet;
/* Print out test information banner. */
printf("NetX Test: NAT Invalid Header Test...................................");
/* Create a UDP local socket. */
status = nx_udp_socket_create(&local_ip, &local_socket, "Local Socket", NX_IP_NORMAL, NX_FRAGMENT_OKAY, 0x80, 5);
/* Check status. */
if (status)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Bind the UDP socket to the IP port 0x88. */
status = nx_udp_socket_bind(&local_socket, 0x88, TX_WAIT_FOREVER);
/* Check status. */
if (status)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Create a UDP External socket. */
status = nx_udp_socket_create(&external_ip, &external_socket, "External Socket", NX_IP_NORMAL, NX_FRAGMENT_OKAY, 0x80, 5);
/* Check status. */
if (status)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Bind the UDP socket to the IP port 0x89. */
status = nx_udp_socket_bind(&external_socket, 0x89, TX_WAIT_FOREVER);
/* Check status. */
if (status)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Enable the NAT service. */
nx_nat_enable(&nat_server);
advanced_packet_process_callback = packet_process;
/***********************************************************************/
/* External Socket sends udp packet to Local Socket */
/***********************************************************************/
/* Let other threads run again. */
tx_thread_relinquish();
/* Allocate a packet. */
status = nx_packet_allocate(&nat_packet_pool, &my_packet, NX_UDP_PACKET, TX_WAIT_FOREVER);
/* Check status. */
if (status != NX_SUCCESS)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Write ABCs into the packet payload! */
memcpy(my_packet -> nx_packet_prepend_ptr, "ABCDEFGHIJKLMNOPQRSTUVWXYZ ", 28);
/* Adjust the write pointer. */
my_packet -> nx_packet_length = 28;
my_packet -> nx_packet_append_ptr = my_packet -> nx_packet_prepend_ptr + 28;
/* Send the UDP packet. */
status = nx_udp_socket_send(&external_socket, my_packet, NX_NAT_EXTERNAL_IPADR, 0x88);
/* Check status. */
if (status)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Unbind the UDP local socket. */
status = nx_udp_socket_unbind(&local_socket);
/* Check status. */
if (status)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Delete the UDP Local socket. */
status = nx_udp_socket_delete(&local_socket);
/* Check status. */
if (status)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Unbind the UDP external socket. */
status = nx_udp_socket_unbind(&external_socket);
/* Check status. */
if (status)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Delete the UDP external socket. */
status = nx_udp_socket_delete(&external_socket);
/* Check status. */
if (status)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Check invalid packet release. */
if (nat_packet_pool.nx_packet_pool_invalid_releases != 0)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Output success. */
printf("SUCCESS!\n");
test_control_return(0);
}
static UINT packet_process(NX_IP *ip_ptr, NX_PACKET *packet_ptr, UINT *operation_ptr, UINT *delay_ptr)
{
NX_IPV4_HEADER *ip_header_ptr;
ULONG ip_header_length;
ULONG checksum;
ULONG val;
if ((ip_ptr != &external_ip) || (packet_ptr -> nx_packet_length < 30))
{
/* Not the target packet. */
return NX_TRUE;
}
/* Trim the packet length to be less than UDP header. */
/* Adjust the append pointer and length. */
packet_ptr -> nx_packet_append_ptr = packet_ptr -> nx_packet_prepend_ptr + 27;
packet_ptr -> nx_packet_length = 27;
/* Get the IPv4 header. */
ip_header_ptr = (NX_IPV4_HEADER *)packet_ptr -> nx_packet_prepend_ptr;
/* Convert to host byte order. */
NX_CHANGE_ULONG_ENDIAN(ip_header_ptr -> nx_ip_header_word_0);
NX_CHANGE_ULONG_ENDIAN(ip_header_ptr -> nx_ip_header_word_2);
ip_header_ptr -> nx_ip_header_word_0 = ((ip_header_ptr -> nx_ip_header_word_0) & 0xFFFF0000) | 27;
ip_header_length = ((ip_header_ptr -> nx_ip_header_word_0 & NX_IP_LENGTH_MASK) >> 24) * sizeof(ULONG);
/* Clear the checksum. */
ip_header_ptr -> nx_ip_header_word_2 &= 0xFFFF0000;
NX_CHANGE_ULONG_ENDIAN(ip_header_ptr -> nx_ip_header_word_2);
/* Convert to network byte order. */
NX_CHANGE_ULONG_ENDIAN(ip_header_ptr -> nx_ip_header_word_0);
checksum = _nx_ip_checksum_compute(packet_ptr, NX_IP_VERSION_V4,
/* Length is the size of IP header, including options */
ip_header_length,
/* IPv4 header checksum does not use src/dest addresses */
NULL, NULL);
val = (ULONG)(~checksum);
val = val & NX_LOWER_16_MASK;
/* Convert to network byte order. */
NX_CHANGE_ULONG_ENDIAN(val);
/* Now store the checksum in the IP header. */
ip_header_ptr -> nx_ip_header_word_2 = ip_header_ptr -> nx_ip_header_word_2 | val;
advanced_packet_process_callback = NX_NULL;
return NX_TRUE;
}
#else
extern void test_control_return(UINT status);
#ifdef CTEST
VOID test_application_define(void *first_unused_memory)
#else
void netx_nat_invalid_header_test_application_define(void *first_unused_memory)
#endif
{
printf("NetX Test: NAT Invalid Header Test...................................N/A\n");
test_control_return(3);
}
#endif
|
