/***************************************************************************/ /* 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 */ /***************************************************************************/ /* 10.24 TCP, in CLOSE-WAIT, CLOSING or LAST-ACK state, MUST not change state after receiving a FIN. */ /*This is 10.24_02 in CLOSING state*/ /* Procedure 1.Connection successfully 2.Disconnect the Server socket. 3.Drop the FIN packet sent form the Sever to the Client. 4.Disconnect the Client socket. 5.Drop the ACK packet sent form the Sever to the Client. 6.The Client will retransmit the FIN packet. */ #include "tx_api.h" #include "nx_api.h" #include "nx_tcp.h" #include "nx_ram_network_driver_test_1500.h" #define DEMO_STACK_SIZE 2048 extern void test_control_return(UINT status); #if defined NX_DISABLE_RESET_DISCONNECT && !defined(NX_DISABLE_IPV4) /* Define the ThreadX and NetX object control blocks... */ static TX_THREAD ntest_0; static TX_THREAD ntest_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 ULONG fin_counter; /* Define thread prototypes. */ static void ntest_0_entry(ULONG thread_input); static void ntest_1_entry(ULONG thread_input); static void ntest_1_connect_received(NX_TCP_SOCKET *server_socket, UINT port); static void ntest_1_disconnect_received(NX_TCP_SOCKET *server_socket); extern void test_control_return(UINT status); extern void _nx_ram_network_driver_1500(struct NX_IP_DRIVER_STRUCT *driver_req); extern void _nx_ram_network_driver(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); static UINT my_packet_process_10_24_02(NX_IP *ip_ptr, NX_PACKET *packet_ptr, UINT *operation_ptr, UINT *delay_ptr); static void my_tcp_packet_receive_10_24_02(NX_IP *ip_ptr, NX_PACKET *packet_ptr); /* Define what the initial system looks like. */ #ifdef CTEST VOID test_application_define(void *first_unused_memory) #else void netx_10_24_02_application_define(void *first_unused_memory) #endif { CHAR *pointer; UINT status; /* Setup the working pointer. */ pointer = (CHAR *) first_unused_memory; error_counter = 0; fin_counter = 0; /* Create the main thread. */ tx_thread_create(&ntest_0, "thread 0", ntest_0_entry, 0, pointer, DEMO_STACK_SIZE, 3, 3, TX_NO_TIME_SLICE, TX_AUTO_START); pointer = pointer + DEMO_STACK_SIZE; /* Create the main thread. */ tx_thread_create(&ntest_1, "thread 1", ntest_1_entry, 0, pointer, DEMO_STACK_SIZE, 4, 4, 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", 512, 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, 5), 0xFFFFFF00UL, &pool_0, _nx_ram_network_driver_1500, 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, 4), 0xFFFFFF00UL, &pool_0, _nx_ram_network_driver, 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 ntest_0_entry(ULONG thread_input) { UINT status; ULONG actual_status; /* Print out test information banner. */ printf("NetX Test: TCP Spec 10.24.02 Test...................................."); /* Check for earlier error. */ if(error_counter) { printf("ERROR!\n"); test_control_return(1); } /* 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 for error. */ if(status) error_counter++; /* Create a socket. */ status = nx_tcp_socket_create(&ip_0, &server_socket, "Server Socket", NX_IP_NORMAL, NX_FRAGMENT_OKAY, NX_IP_TIME_TO_LIVE, 300, NX_NULL, ntest_1_disconnect_received); /* Check for error. */ if(status) error_counter++; /* Setup this thread to listen. */ status = nx_tcp_server_socket_listen(&ip_0, 12, &server_socket, 5, ntest_1_connect_received); /* Check for error. */ if(status) error_counter++; /* Accept a client socket connection. */ status = nx_tcp_server_socket_accept(&server_socket, NX_IP_PERIODIC_RATE); /* Check for error. */ if(status) error_counter++; advanced_packet_process_callback = my_packet_process_10_24_02; ip_0.nx_ip_tcp_packet_receive = my_tcp_packet_receive_10_24_02; /* Disconnect the server socket. */ status = nx_tcp_socket_disconnect(&server_socket, NX_NO_WAIT); /* sleep to wait for the retransmission of FIN */ tx_thread_sleep(3 * NX_IP_PERIODIC_RATE); /* Check the server socket state and fin_counter. */ if((server_socket.nx_tcp_socket_state != NX_TCP_CLOSING) || (fin_counter != 3)) error_counter++; status = nx_tcp_server_socket_unaccept(&server_socket); /* Check for error. */ if(status) error_counter++; status = nx_tcp_server_socket_unlisten(&ip_0, 12); /* Check for error. */ if(status) error_counter++; /* Delete the socket. */ status = nx_tcp_socket_delete(&server_socket); /* Check for error. */ if(status) error_counter++; /* Return error. */ if((error_counter) || (fin_counter != 3)) { printf("ERROR!\n"); test_control_return(1); } /* Return success. */ else { printf("SUCCESS!\n"); test_control_return(0); } } static void ntest_1_entry(ULONG thread_input) { UINT status; /* Create a socket. */ status = nx_tcp_socket_create(&ip_1, &client_socket, "Client Socket", NX_IP_NORMAL, NX_FRAGMENT_OKAY, NX_IP_TIME_TO_LIVE, 300, NX_NULL, NX_NULL); /* Check for error. */ if(status) error_counter++; /* Bind the socket. */ status = nx_tcp_client_socket_bind(&client_socket, 12, NX_IP_PERIODIC_RATE); /* Check for error. */ if(status) error_counter++; /* CLOSE_WAIT.. */ status = nx_tcp_client_socket_connect(&client_socket, IP_ADDRESS(1, 2, 3, 5), 12, NX_IP_PERIODIC_RATE); if(status) error_counter++; /* Disconnect the client socket. */ status = nx_tcp_socket_disconnect(&client_socket, 3 * NX_IP_PERIODIC_RATE); /* 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++; } static UINT my_packet_process_10_24_02(NX_IP *ip_ptr, NX_PACKET *packet_ptr, UINT *operation_ptr, UINT *delay_ptr) { NX_TCP_HEADER *tcp_header_ptr; tcp_header_ptr = (NX_TCP_HEADER*)((packet_ptr -> nx_packet_prepend_ptr) + 20); NX_CHANGE_ULONG_ENDIAN(tcp_header_ptr -> nx_tcp_header_word_3); if ((tcp_header_ptr -> nx_tcp_header_word_3 & NX_TCP_FIN_BIT) && (fin_counter == 0)) { fin_counter++; *operation_ptr = NX_RAMDRIVER_OP_DROP; } /* Drop the ACK packet in order to let the client socket retransmit a FIN packet. */ else if((tcp_header_ptr -> nx_tcp_header_word_3 & NX_TCP_ACK_BIT) && (ip_ptr == &ip_0)) { *operation_ptr = NX_RAMDRIVER_OP_DROP; } NX_CHANGE_ULONG_ENDIAN(tcp_header_ptr -> nx_tcp_header_word_3); return NX_TRUE; } void my_tcp_packet_receive_10_24_02(NX_IP *ip_ptr, NX_PACKET *packet_ptr) { NX_TCP_HEADER *tcp_header_ptr; tcp_header_ptr = (NX_TCP_HEADER *)packet_ptr -> nx_packet_prepend_ptr; NX_CHANGE_ULONG_ENDIAN(tcp_header_ptr -> nx_tcp_header_word_3); /* Check the packet is a FIN one. */ if ((tcp_header_ptr -> nx_tcp_header_word_3 & NX_TCP_FIN_BIT) && (fin_counter == 1)) { fin_counter++; } /* Check wether receive a FIN in CLOSE_WAIT state */ else if (server_socket.nx_tcp_socket_state == NX_TCP_CLOSING && fin_counter == 2) { if(tcp_header_ptr -> nx_tcp_header_word_3 & NX_TCP_FIN_BIT) { fin_counter++; /* Deal packets with default routing. */ ip_0.nx_ip_tcp_packet_receive = _nx_tcp_packet_receive; } } NX_CHANGE_ULONG_ENDIAN(tcp_header_ptr -> nx_tcp_header_word_3); /* Let server receives the packet. */ _nx_tcp_packet_receive(ip_ptr, packet_ptr); } static void ntest_1_connect_received(NX_TCP_SOCKET *socket_ptr, UINT port) { /* Check for the proper socket and port. */ if((socket_ptr != &server_socket) || (port != 12)) error_counter++; } static void ntest_1_disconnect_received(NX_TCP_SOCKET *socket) { /* Check for proper disconnected socket. */ if(socket != &server_socket) error_counter++; } #else #ifdef CTEST VOID test_application_define(void *first_unused_memory) #else void netx_10_24_02_application_define(void *first_unused_memory) #endif { /* Print out test information banner. */ printf("NetX Test: TCP Spec 10.24.02 Test....................................N/A\n"); test_control_return(3); } #endif