/***************************************************************************/ /* 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 TCP header span in multiple packets. */ #include "tx_api.h" #include "nx_api.h" #include "nx_ram_network_driver_test_1500.h" extern void test_control_return(UINT status); #if !defined(NX_DISABLE_IPV4) && defined(__PRODUCT_NETXDUO__) && !defined(NX_DISABLE_PACKET_CHAIN) && !defined(NX_DISABLE_RX_SIZE_CHECKING) #define DEMO_STACK_SIZE 2048 /* Define the ThreadX and NetX object control blocks... */ static TX_THREAD thread_0; static TX_THREAD thread_1; static NX_PACKET_POOL pool_0; static NX_IP ip_0; static NX_IP ip_1; static NX_TCP_SOCKET client_socket; static NX_TCP_SOCKET server_socket; /* Define the counters used in the demo application... */ static ULONG error_counter; static UINT client_port; static ULONG packet_offset; /* Define thread prototypes. */ static void thread_0_entry(ULONG thread_input); static void thread_1_entry(ULONG thread_input); static UINT my_advanced_packet_process_callback(NX_IP *ip_ptr, NX_PACKET *packet_ptr, UINT *operation_ptr, UINT *delay_ptr); extern void _nx_ram_network_driver_256(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 what the initial system looks like. */ #ifdef CTEST VOID test_application_define(void *first_unused_memory) #else void netx_tcp_invalid_packet_chain_test_application_define(void *first_unused_memory) #endif { CHAR *pointer; UINT status; /* Setup the working pointer. */ pointer = (CHAR *) 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 the main thread. */ tx_thread_create(&thread_1, "thread 1", thread_1_entry, 0, pointer, DEMO_STACK_SIZE, 3, 3, TX_NO_TIME_SLICE, TX_AUTO_START); pointer = pointer + DEMO_STACK_SIZE; /* Initialize the NetX system. */ nx_system_initialize(); /* Create a packet pool. */ status = nx_packet_pool_create(&pool_0, "NetX Main Packet Pool", 256, pointer, 8192); pointer = pointer + 8192; if (status) error_counter++; /* Create an IP instance. */ status = nx_ip_create(&ip_0, "NetX IP Instance 0", IP_ADDRESS(1, 2, 3, 4), 0xFFFFFF00UL, &pool_0, _nx_ram_network_driver_256, pointer, 2048, 1); pointer = pointer + 2048; /* Create another IP instance. */ status += nx_ip_create(&ip_1, "NetX IP Instance 1", IP_ADDRESS(1, 2, 3, 5), 0xFFFFFF00UL, &pool_0, _nx_ram_network_driver_256, pointer, 2048, 1); pointer = pointer + 2048; if (status) error_counter++; /* Enable ARP and supply ARP cache memory for IP Instance 0. */ status = nx_arp_enable(&ip_0, (void *) pointer, 1024); pointer = pointer + 1024; /* Enable ARP and supply ARP cache memory for IP Instance 1. */ status += nx_arp_enable(&ip_1, (void *) pointer, 1024); pointer = pointer + 1024; /* Check ARP enable status. */ if (status) error_counter++; /* Enable TCP processing for both IP instances. */ status = nx_tcp_enable(&ip_0); status += nx_tcp_enable(&ip_1); /* Check TCP enable status. */ if (status) error_counter++; } /* Define the test threads. */ static void thread_0_entry(ULONG thread_input) { UINT status; NX_PACKET *my_packet; UINT compare_port; ULONG mss, peer_mss, peer_ip_address, peer_port, bytes_available; ULONG tcp_packets_sent, tcp_bytes_sent, tcp_packets_received, tcp_bytes_received, tcp_invalid_packets, tcp_receive_packets_dropped, tcp_checksum_errors, tcp_connections, tcp_disconnections, tcp_connections_dropped, tcp_retransmit_packets; ULONG packets_sent, bytes_sent, packets_received, bytes_received, retransmit_packets, packets_queued, checksum_errors, socket_state, transmit_queue_depth, transmit_window, receive_window; ULONG window_size = 200; /* Print out some test information banners. */ printf("NetX Test: TCP Invalid Packet Chain Test............................."); /* Check for earlier error. */ if (error_counter) { printf("ERROR!\n"); test_control_return(1); } /* Get a free port for the client's use. */ status = nx_tcp_free_port_find(&ip_0, 1, &client_port); /* Check for error. */ if (status) { printf("ERROR!\n"); test_control_return(1); } /* Set callback function in network driver to bypass dispatch in network driver. */ advanced_packet_process_callback = my_advanced_packet_process_callback; /* Create a socket. */ status = nx_tcp_socket_create(&ip_0, &client_socket, "Client Socket", NX_IP_NORMAL, NX_FRAGMENT_OKAY, NX_IP_TIME_TO_LIVE, window_size, NX_NULL, NX_NULL); /* Check for error. */ if (status) error_counter++; /* Bind the socket. */ status = nx_tcp_client_socket_bind(&client_socket, client_port, NX_WAIT_FOREVER); /* Check for error. */ if (status) error_counter++; /* Set offset to 20. The size of TCP plus IP header is larger than 40. This packet can not be processed by TCP. */ packet_offset = 20; /* Attempt to connect the socket. */ status = nx_tcp_client_socket_connect(&client_socket, IP_ADDRESS(1, 2, 3, 5), 12, NX_IP_PERIODIC_RATE); /* Check for error. */ if (status == NX_SUCCESS) error_counter++; /* Set offset to 40. Since size of SYN more than 20, with IP header, the total size is larger than 40. This packet can not be processed by TCP. */ packet_offset = 40; /* Attempt to connect the socket again. */ status = nx_tcp_client_socket_connect(&client_socket, IP_ADDRESS(1, 2, 3, 5), 12, NX_IP_PERIODIC_RATE); /* Check for error. */ if (status == NX_SUCCESS) error_counter++; /* Set offset to 80. This packet can be processed by TCP. */ packet_offset = 80; /* Attempt to connect the socket again. */ status = nx_tcp_client_socket_connect(&client_socket, IP_ADDRESS(1, 2, 3, 5), 12, NX_IP_PERIODIC_RATE); /* Check for error. */ if (status != NX_SUCCESS) error_counter++; /* Allocate a packet. */ status = nx_packet_allocate(&pool_0, &my_packet, NX_TCP_PACKET, NX_WAIT_FOREVER); /* Check status. */ if (status != NX_SUCCESS) error_counter++; /* 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 packet out! */ status = nx_tcp_socket_send(&client_socket, my_packet, 5 * NX_IP_PERIODIC_RATE); /* Determine if the status is valid. */ if (status) { error_counter++; nx_packet_release(my_packet); } /* Disconnect this socket. */ status = nx_tcp_socket_disconnect(&client_socket, 5 * NX_IP_PERIODIC_RATE); /* Determine if the status is valid. */ if (status) error_counter++; /* Unbind the socket. */ status = nx_tcp_client_socket_unbind(&client_socket); /* Check for error. */ if (status) error_counter++; /* Delete the socket. */ status = nx_tcp_socket_delete(&client_socket); /* Check for error. */ if (status) error_counter++; /* Check for errors. */ if (error_counter) { printf("ERROR!\n"); test_control_return(1); } else { printf("SUCCESS!\n"); test_control_return(0); } } static void thread_1_entry(ULONG thread_input) { UINT status; NX_PACKET *packet_ptr; ULONG actual_status; /* Ensure the IP instance has been initialized. */ status = nx_ip_status_check(&ip_1, NX_IP_INITIALIZE_DONE, &actual_status, NX_IP_PERIODIC_RATE); /* Check status... */ if (status != NX_SUCCESS) { error_counter++; test_control_return(1); } /* Create a socket. */ status = nx_tcp_socket_create(&ip_1, &server_socket, "Server Socket", NX_IP_NORMAL, NX_FRAGMENT_OKAY, NX_IP_TIME_TO_LIVE, 100, NX_NULL, NX_NULL); /* Check for error. */ if (status) error_counter++; /* Setup this thread to listen. */ status = nx_tcp_server_socket_listen(&ip_1, 12, &server_socket, 5, NX_NULL); /* Check for error. */ if (status) error_counter++; /* Accept a client socket connection. */ status = nx_tcp_server_socket_accept(&server_socket, 5 * NX_IP_PERIODIC_RATE); /* Check for error. */ if (status) error_counter++; /* Receive a TCP message from the socket. */ status = nx_tcp_socket_receive(&server_socket, &packet_ptr, 5 * NX_IP_PERIODIC_RATE); /* Check for error. */ if (status) error_counter++; else /* Release the packet. */ nx_packet_release(packet_ptr); /* Disconnect the server socket. */ status = nx_tcp_socket_disconnect(&server_socket, 5 * NX_IP_PERIODIC_RATE); /* Check for error. */ if (status) error_counter++; /* Unaccept the server socket. */ status = nx_tcp_server_socket_unaccept(&server_socket); /* Check for error. */ if (status) error_counter++; /* Unlisten on the server port. */ status = nx_tcp_server_socket_unlisten(&ip_1, 12); /* Check for error. */ if (status) error_counter++; } static UINT my_advanced_packet_process_callback(NX_IP *ip_ptr, NX_PACKET *packet_ptr, UINT *operation_ptr, UINT *delay_ptr) { NX_PACKET *packet_copy_ptr; if (ip_ptr != &ip_0) { /* Handle packets from IP 0 only. */ return(NX_TRUE); } /* Check if this is an IPv4 packet. */ if ((*(packet_ptr -> nx_packet_prepend_ptr) != 0x45) || (packet_ptr -> nx_packet_next)) { /* Handle IPv4 packets only. */ return(NX_TRUE); } /* Allocate a packet with insufficient space for TCP header in first packet. */ if (nx_packet_allocate(&pool_0, &packet_copy_ptr, (pool_0.nx_packet_pool_payload_size - packet_offset) & 0xFFFFFFFC, NX_NO_WAIT)) { error_counter++; return(NX_TRUE); } /* Copy data into packet. */ if (nx_packet_data_append(packet_copy_ptr, packet_ptr -> nx_packet_prepend_ptr, packet_ptr -> nx_packet_length, &pool_0, NX_NO_WAIT)) { error_counter++; nx_packet_release(packet_copy_ptr); return(NX_TRUE); } _nx_ip_packet_deferred_receive(&ip_1, packet_copy_ptr); /* Let network driver to drop this packet. */ *operation_ptr = NX_RAMDRIVER_OP_DROP; return(NX_TRUE); } #else #ifdef CTEST VOID test_application_define(void *first_unused_memory) #else void netx_tcp_invalid_packet_chain_test_application_define(void *first_unused_memory) #endif { /* Print out test information banner. */ printf("NetX Test: TCP Invalid Packet Chain Test.............................N/A\n"); test_control_return(3); } #endif