/***************************************************************************/ /* 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 TX queue exceed. */ #include "nx_api.h" #include "nx_tcp.h" extern void test_control_return(UINT status); #if !defined(NX_DISABLE_IPV4) #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 = 0; static UCHAR pool_area[1024 * 1024]; /* Define thread prototypes. */ static void thread_0_entry(ULONG thread_input); static void thread_1_entry(ULONG thread_input); extern void _nx_ram_network_driver_256(struct NX_IP_DRIVER_STRUCT *driver_req); static VOID tcp_packet_receive(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_tcp_tx_queue_exceed_test_application_define(void *first_unused_memory) #endif { CHAR *pointer; UINT status; /* Setup the working pointer. */ pointer = (CHAR *) first_unused_memory; error_counter = 0; /* 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", 512, pool_area, sizeof(pool_area)); 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 i; /* Print out some test information banners. */ printf("NetX Test: TCP TX Queue Exceed Test.................................."); /* Check for earlier error. */ if (error_counter) { printf("ERROR!\n"); test_control_return(1); } /* 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, 200, NX_NULL, NX_NULL); if (status) error_counter++; /* Bind the socket. */ status = nx_tcp_client_socket_bind(&client_socket, 0x88, NX_WAIT_FOREVER); if (status) error_counter++; /* Attempt to connect the socket. */ status = nx_tcp_client_socket_connect(&client_socket, IP_ADDRESS(1, 2, 3, 5), 12, 5 * NX_IP_PERIODIC_RATE); if (status) error_counter++; /* Drop ACK from server to client. */ ip_0.nx_ip_tcp_packet_receive = tcp_packet_receive; for (i = 0; i < NX_TCP_MAXIMUM_TX_QUEUE + 2; i++) { /* Allocate a packet. */ status = nx_packet_allocate(&pool_0, &my_packet, NX_TCP_PACKET, NX_NO_WAIT); if (status) error_counter++; status = nx_packet_data_append(my_packet, "A", 1, &pool_0, 2 * NX_NO_WAIT); if(status) error_counter++; /* Send the packet out! */ if (i == (NX_TCP_MAXIMUM_TX_QUEUE + 1)) { status = nx_tcp_socket_send(&client_socket, my_packet, NX_NO_WAIT); } else { status = nx_tcp_socket_send(&client_socket, my_packet, NX_IP_PERIODIC_RATE); } if (i < NX_TCP_MAXIMUM_TX_QUEUE) { /* For first NX_TCP_MAXIMUM_TX_QUEUE packets, send should be always success. */ if (status) { error_counter++; nx_packet_release(my_packet); } } else { /* Queue depth exceeded. */ if (status != NX_TX_QUEUE_DEPTH) { error_counter++; } else { nx_packet_release(my_packet); } } } /* Recover TCP packet process from server to client. */ ip_0.nx_ip_tcp_packet_receive = _nx_tcp_packet_receive; /* Wakeup server thread. */ tx_thread_resume(&thread_1); /* Disconnect this socket. */ status = nx_tcp_socket_disconnect(&client_socket, 5 * NX_IP_PERIODIC_RATE); if (status) error_counter++; /* Unbind the socket. */ status = nx_tcp_client_socket_unbind(&client_socket); if (status) error_counter++; /* Delete the socket. */ status = nx_tcp_socket_delete(&client_socket); if (status) error_counter++; /* Check status. */ 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; 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); if (status) error_counter++; /* 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); if (status) error_counter++; /* Setup this thread to listen. */ status = nx_tcp_server_socket_listen(&ip_1, 12, &server_socket, 5, NX_NULL); if (status) error_counter++; /* Accept a client socket connection. */ status = nx_tcp_server_socket_accept(&server_socket, 5 * NX_IP_PERIODIC_RATE); if (status) error_counter++; /* Wait until client thread finishes testing. */ tx_thread_suspend(&thread_1); /* Disconnect the server socket. */ status = nx_tcp_socket_disconnect(&server_socket, 5 * NX_IP_PERIODIC_RATE); if (status) error_counter++; /* Unaccept the server socket. */ status = nx_tcp_server_socket_unaccept(&server_socket); if (status) error_counter++; /* Unlisten on the server port 12. */ status = nx_tcp_server_socket_unlisten(&ip_1, 12); if (status) error_counter++; /* Delete the socket. */ status = nx_tcp_socket_delete(&server_socket); if (status) error_counter++; } static VOID tcp_packet_receive(NX_IP *ip_ptr, NX_PACKET *packet_ptr) { /* Drop packet from server to client. */ nx_packet_release(packet_ptr); } #else #ifdef CTEST VOID test_application_define(void *first_unused_memory) #else void netx_tcp_tx_queue_exceed_test_application_define(void *first_unused_memory) #endif { /* Print out test information banner. */ printf("NetX Test: TCP TX Queue Exceed Test..................................N/A\n"); test_control_return(3); } #endif