/* * FreeRTOS+TCP * Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * SPDX-License-Identifier: MIT * * Permission is hereby granted, free of charge, to any person obtaining a copy of * this software and associated documentation files (the "Software"), to deal in * the Software without restriction, including without limitation the rights to * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of * the Software, and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * * http://aws.amazon.com/freertos * http://www.FreeRTOS.org */ /** * @file FreeRTOS_UDP_IPv4.c * @brief This file has the source code for the UDP-IP functionality of the FreeRTOS+TCP * network stack. */ /* Standard includes. */ #include #include /* FreeRTOS includes. */ #include "FreeRTOS.h" #include "task.h" #include "queue.h" #include "semphr.h" #include "event_groups.h" #include "list.h" /* FreeRTOS+TCP includes. */ #include "FreeRTOS_IP.h" #include "FreeRTOS_Sockets.h" #include "FreeRTOS_IP_Private.h" #include "FreeRTOS_UDP_IP.h" #include "FreeRTOS_ARP.h" #include "FreeRTOS_DNS.h" #include "FreeRTOS_DHCP.h" #include "FreeRTOS_IP_Utils.h" #include "NetworkInterface.h" #include "NetworkBufferManagement.h" #if ( ipconfigUSE_DNS == 1 ) #include "FreeRTOS_DNS.h" #endif /* Just make sure the contents doesn't get compiled if IPv4 is not enabled. */ /* *INDENT-OFF* */ #if( ipconfigUSE_IPv4 != 0 ) /* *INDENT-ON* */ /** @brief The expected IP version and header length coded into the IP header itself. */ #define ipIP_VERSION_AND_HEADER_LENGTH_BYTE ( ( uint8_t ) 0x45 ) /*-----------------------------------------------------------*/ /** * @brief Process the generated UDP packet and do other checks before sending the * packet such as ARP cache check and address resolution. * * @param[in] pxNetworkBuffer The network buffer carrying the packet. */ void vProcessGeneratedUDPPacket_IPv4( NetworkBufferDescriptor_t * const pxNetworkBuffer ) { UDPPacket_t * pxUDPPacket; IPHeader_t * pxIPHeader; eARPLookupResult_t eReturned; uint32_t ulIPAddress = pxNetworkBuffer->xIPAddress.ulIP_IPv4; NetworkEndPoint_t * pxEndPoint = pxNetworkBuffer->pxEndPoint; size_t uxPayloadSize; /* memcpy() helper variables for MISRA Rule 21.15 compliance*/ const void * pvCopySource; void * pvCopyDest; /* Map the UDP packet onto the start of the frame. */ /* MISRA Ref 11.3.1 [Misaligned access] */ /* More details at: https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/MISRA.md#rule-113 */ /* coverity[misra_c_2012_rule_11_3_violation] */ pxUDPPacket = ( ( UDPPacket_t * ) pxNetworkBuffer->pucEthernetBuffer ); #if ipconfigSUPPORT_OUTGOING_PINGS == 1 if( pxNetworkBuffer->usPort == ( uint16_t ) ipPACKET_CONTAINS_ICMP_DATA ) { uxPayloadSize = pxNetworkBuffer->xDataLength - sizeof( ICMPPacket_t ); } else #endif { uxPayloadSize = pxNetworkBuffer->xDataLength - sizeof( UDPPacket_t ); } /* Determine the ARP cache status for the requested IP address. */ eReturned = eARPGetCacheEntry( &( ulIPAddress ), &( pxUDPPacket->xEthernetHeader.xDestinationAddress ), &( pxEndPoint ) ); if( pxNetworkBuffer->pxEndPoint == NULL ) { pxNetworkBuffer->pxEndPoint = pxEndPoint; } if( eReturned != eCantSendPacket ) { if( eReturned == eARPCacheHit ) { #if ( ipconfigDRIVER_INCLUDED_TX_IP_CHECKSUM == 0 ) uint8_t ucSocketOptions; #endif iptraceSENDING_UDP_PACKET( pxNetworkBuffer->xIPAddress.ulIP_IPv4 ); /* Create short cuts to the data within the packet. */ pxIPHeader = &( pxUDPPacket->xIPHeader ); #if ( ipconfigSUPPORT_OUTGOING_PINGS == 1 ) /* Is it possible that the packet is not actually a UDP packet * after all, but an ICMP packet. */ if( pxNetworkBuffer->usPort != ( uint16_t ) ipPACKET_CONTAINS_ICMP_DATA ) #endif /* ipconfigSUPPORT_OUTGOING_PINGS */ { UDPHeader_t * pxUDPHeader; pxUDPHeader = &( pxUDPPacket->xUDPHeader ); pxUDPHeader->usDestinationPort = pxNetworkBuffer->usPort; pxUDPHeader->usSourcePort = pxNetworkBuffer->usBoundPort; pxUDPHeader->usLength = ( uint16_t ) ( uxPayloadSize + sizeof( UDPHeader_t ) ); pxUDPHeader->usLength = FreeRTOS_htons( pxUDPHeader->usLength ); pxUDPHeader->usChecksum = 0U; } /* memcpy() the constant parts of the header information into * the correct location within the packet. This fills in: * xEthernetHeader.xSourceAddress * xEthernetHeader.usFrameType * xIPHeader.ucVersionHeaderLength * xIPHeader.ucDifferentiatedServicesCode * xIPHeader.usLength * xIPHeader.usIdentification * xIPHeader.usFragmentOffset * xIPHeader.ucTimeToLive * xIPHeader.ucProtocol * and * xIPHeader.usHeaderChecksum */ /* Save options now, as they will be overwritten by memcpy */ #if ( ipconfigDRIVER_INCLUDED_TX_IP_CHECKSUM == 0 ) { ucSocketOptions = pxNetworkBuffer->pucEthernetBuffer[ ipSOCKET_OPTIONS_OFFSET ]; } #endif /* * Offset the memcpy by the size of a MAC address to start at the packet's * Ethernet header 'source' MAC address; the preceding 'destination' should not be altered. */ /* * Use helper variables for memcpy() to remain * compliant with MISRA Rule 21.15. These should be * optimized away. */ pvCopySource = xDefaultPartUDPPacketHeader.ucBytes; /* The Ethernet source address is at offset 6. */ pvCopyDest = &pxNetworkBuffer->pucEthernetBuffer[ sizeof( MACAddress_t ) ]; ( void ) memcpy( pvCopyDest, pvCopySource, sizeof( xDefaultPartUDPPacketHeader ) ); #if ipconfigSUPPORT_OUTGOING_PINGS == 1 if( pxNetworkBuffer->usPort == ( uint16_t ) ipPACKET_CONTAINS_ICMP_DATA ) { pxIPHeader->ucProtocol = ipPROTOCOL_ICMP; pxIPHeader->usLength = ( uint16_t ) ( uxPayloadSize + sizeof( IPHeader_t ) + sizeof( ICMPHeader_t ) ); } else #endif /* ipconfigSUPPORT_OUTGOING_PINGS */ { pxIPHeader->usLength = ( uint16_t ) ( uxPayloadSize + sizeof( IPHeader_t ) + sizeof( UDPHeader_t ) ); } pxIPHeader->usLength = FreeRTOS_htons( pxIPHeader->usLength ); pxIPHeader->ulDestinationIPAddress = pxNetworkBuffer->xIPAddress.ulIP_IPv4; if( pxNetworkBuffer->pxEndPoint != NULL ) { pxIPHeader->ulSourceIPAddress = pxNetworkBuffer->pxEndPoint->ipv4_settings.ulIPAddress; } /* The stack doesn't support fragments, so the fragment offset field must always be zero. * The header was never memset to zero, so set both the fragment offset and fragmentation flags in one go. */ #if ( ipconfigFORCE_IP_DONT_FRAGMENT != 0 ) pxIPHeader->usFragmentOffset = ipFRAGMENT_FLAGS_DONT_FRAGMENT; #else pxIPHeader->usFragmentOffset = 0U; #endif #if ( ipconfigUSE_LLMNR == 1 ) { /* LLMNR messages are typically used on a LAN and they're * not supposed to cross routers */ if( pxNetworkBuffer->xIPAddress.ulIP_IPv4 == ipLLMNR_IP_ADDR ) { pxIPHeader->ucTimeToLive = 0x01; } } #endif #if ( ipconfigUSE_MDNS == 1 ) { /* mDNS messages have a hop-count of 255, see RFC 6762, section 11. */ if( pxNetworkBuffer->xIPAddress.ulIP_IPv4 == ipMDNS_IP_ADDRESS ) { pxIPHeader->ucTimeToLive = 0xffU; } } #endif #if ( ipconfigDRIVER_INCLUDED_TX_IP_CHECKSUM == 0 ) { pxIPHeader->usHeaderChecksum = 0U; pxIPHeader->usHeaderChecksum = usGenerateChecksum( 0U, ( uint8_t * ) &( pxIPHeader->ucVersionHeaderLength ), uxIPHeaderSizePacket( pxNetworkBuffer ) ); pxIPHeader->usHeaderChecksum = ( uint16_t ) ~FreeRTOS_htons( pxIPHeader->usHeaderChecksum ); if( ( ucSocketOptions & ( uint8_t ) FREERTOS_SO_UDPCKSUM_OUT ) != 0U ) { ( void ) usGenerateProtocolChecksum( ( uint8_t * ) pxUDPPacket, pxNetworkBuffer->xDataLength, pdTRUE ); } else { pxUDPPacket->xUDPHeader.usChecksum = 0U; } } #endif /* if ( ipconfigDRIVER_INCLUDED_TX_IP_CHECKSUM == 0 ) */ } else if( eReturned == eARPCacheMiss ) { /* Add an entry to the ARP table with a null hardware address. * This allows the ARP timer to know that an ARP reply is * outstanding, and perform retransmissions if necessary. */ vARPRefreshCacheEntry( NULL, ulIPAddress, NULL ); /* Generate an ARP for the required IP address. */ iptracePACKET_DROPPED_TO_GENERATE_ARP( pxNetworkBuffer->xIPAddress.ulIP_IPv4 ); /* 'ulIPAddress' might have become the address of the Gateway. * Find the route again. */ pxNetworkBuffer->pxEndPoint = FreeRTOS_FindEndPointOnNetMask( pxNetworkBuffer->xIPAddress.ulIP_IPv4, 11 ); if( pxNetworkBuffer->pxEndPoint == NULL ) { eReturned = eCantSendPacket; } else { pxNetworkBuffer->xIPAddress.ulIP_IPv4 = ulIPAddress; vARPGenerateRequestPacket( pxNetworkBuffer ); } } else { /* The lookup indicated that an ARP request has already been * sent out for the queried IP address. */ eReturned = eCantSendPacket; } } if( eReturned != eCantSendPacket ) { /* The network driver is responsible for freeing the network buffer * after the packet has been sent. */ if( pxNetworkBuffer->pxEndPoint != NULL ) { NetworkInterface_t * pxInterface = pxNetworkBuffer->pxEndPoint->pxNetworkInterface; /* MISRA Ref 11.3.1 [Misaligned access] */ /* More details at: https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/MISRA.md#rule-113 */ /* coverity[misra_c_2012_rule_11_3_violation] */ EthernetHeader_t * pxEthernetHeader = ( ( EthernetHeader_t * ) pxNetworkBuffer->pucEthernetBuffer ); ( void ) memcpy( pxEthernetHeader->xSourceAddress.ucBytes, pxNetworkBuffer->pxEndPoint->xMACAddress.ucBytes, ( size_t ) ipMAC_ADDRESS_LENGTH_BYTES ); #if ( ipconfigETHERNET_MINIMUM_PACKET_BYTES > 0 ) { if( pxNetworkBuffer->xDataLength < ( size_t ) ipconfigETHERNET_MINIMUM_PACKET_BYTES ) { BaseType_t xIndex; for( xIndex = ( BaseType_t ) pxNetworkBuffer->xDataLength; xIndex < ( BaseType_t ) ipconfigETHERNET_MINIMUM_PACKET_BYTES; xIndex++ ) { pxNetworkBuffer->pucEthernetBuffer[ xIndex ] = 0U; } pxNetworkBuffer->xDataLength = ( size_t ) ipconfigETHERNET_MINIMUM_PACKET_BYTES; } } #endif /* if( ipconfigETHERNET_MINIMUM_PACKET_BYTES > 0 ) */ iptraceNETWORK_INTERFACE_OUTPUT( pxNetworkBuffer->xDataLength, pxNetworkBuffer->pucEthernetBuffer ); if( ( pxInterface != NULL ) && ( pxInterface->pfOutput != NULL ) ) { ( void ) pxInterface->pfOutput( pxInterface, pxNetworkBuffer, pdTRUE ); } } else { /* The packet can't be sent (no route found). Drop the packet. */ vReleaseNetworkBufferAndDescriptor( pxNetworkBuffer ); } } else { /* The packet can't be sent (DHCP not completed?). Just drop the * packet. */ vReleaseNetworkBufferAndDescriptor( pxNetworkBuffer ); } } /*-----------------------------------------------------------*/ /** * @brief Process the received UDP packet. * * @param[in] pxNetworkBuffer The network buffer carrying the UDP packet. * @param[in] usPort The port number on which this packet was received. * @param[out] pxIsWaitingForARPResolution If the packet is awaiting ARP resolution, * this pointer will be set to pdTRUE. pdFALSE otherwise. * * @return pdPASS in case the UDP packet could be processed. Else pdFAIL is returned. */ BaseType_t xProcessReceivedUDPPacket_IPv4( NetworkBufferDescriptor_t * pxNetworkBuffer, uint16_t usPort, BaseType_t * pxIsWaitingForARPResolution ) { BaseType_t xReturn = pdPASS; FreeRTOS_Socket_t * pxSocket; const UDPPacket_t * pxUDPPacket; configASSERT( pxNetworkBuffer != NULL ); configASSERT( pxNetworkBuffer->pucEthernetBuffer != NULL ); /* Map the ethernet buffer to the UDPPacket_t struct for easy access to the fields. */ /* MISRA Ref 11.3.1 [Misaligned access] */ /* More details at: https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/MISRA.md#rule-113 */ /* coverity[misra_c_2012_rule_11_3_violation] */ pxUDPPacket = ( ( UDPPacket_t * ) pxNetworkBuffer->pucEthernetBuffer ); const NetworkEndPoint_t * pxEndpoint = pxNetworkBuffer->pxEndPoint; /* Caller must check for minimum packet size. */ pxSocket = pxUDPSocketLookup( usPort ); *pxIsWaitingForARPResolution = pdFALSE; do { if( pxSocket != NULL ) { if( ( pxEndpoint != NULL ) && ( pxEndpoint->ipv4_settings.ulIPAddress != 0U ) ) { if( xCheckRequiresARPResolution( pxNetworkBuffer ) == pdTRUE ) { /* Mark this packet as waiting for ARP resolution. */ *pxIsWaitingForARPResolution = pdTRUE; /* Return a fail to show that the frame will not be processed right now. */ xReturn = pdFAIL; break; } else { /* Update the age of this cache entry since a packet was received. */ vARPRefreshCacheEntryAge( &( pxUDPPacket->xEthernetHeader.xSourceAddress ), pxUDPPacket->xIPHeader.ulSourceIPAddress ); } } else { /* During DHCP, IP address is not assigned and therefore ARP verification * is not possible. */ } #if ( ipconfigUSE_CALLBACKS == 1 ) { /* Did the owner of this socket register a reception handler ? */ if( ipconfigIS_VALID_PROG_ADDRESS( pxSocket->u.xUDP.pxHandleReceive ) ) { struct freertos_sockaddr xSourceAddress, destinationAddress; void * pcData = &( pxNetworkBuffer->pucEthernetBuffer[ ipUDP_PAYLOAD_OFFSET_IPv4 ] ); FOnUDPReceive_t xHandler = ( FOnUDPReceive_t ) pxSocket->u.xUDP.pxHandleReceive; xSourceAddress.sin_port = pxNetworkBuffer->usPort; xSourceAddress.sin_address.ulIP_IPv4 = pxNetworkBuffer->xIPAddress.ulIP_IPv4; xSourceAddress.sin_family = ( uint8_t ) FREERTOS_AF_INET4; xSourceAddress.sin_len = ( uint8_t ) sizeof( xSourceAddress ); destinationAddress.sin_port = usPort; destinationAddress.sin_address.ulIP_IPv4 = pxUDPPacket->xIPHeader.ulDestinationIPAddress; destinationAddress.sin_family = ( uint8_t ) FREERTOS_AF_INET4; destinationAddress.sin_len = ( uint8_t ) sizeof( destinationAddress ); /* The value of 'xDataLength' was proven to be at least the size of a UDP packet in prvProcessIPPacket(). */ if( xHandler( ( Socket_t ) pxSocket, ( void * ) pcData, ( size_t ) ( pxNetworkBuffer->xDataLength - ipUDP_PAYLOAD_OFFSET_IPv4 ), &( xSourceAddress ), &( destinationAddress ) ) != 0 ) { xReturn = pdFAIL; /* xHandler has consumed the data, do not add it to .xWaitingPacketsList'. */ } } } #endif /* ipconfigUSE_CALLBACKS */ #if ( ipconfigUDP_MAX_RX_PACKETS > 0U ) { if( xReturn == pdPASS ) { if( listCURRENT_LIST_LENGTH( &( pxSocket->u.xUDP.xWaitingPacketsList ) ) >= pxSocket->u.xUDP.uxMaxPackets ) { FreeRTOS_debug_printf( ( "xProcessReceivedUDPPacket: buffer full %ld >= %ld port %u\n", listCURRENT_LIST_LENGTH( &( pxSocket->u.xUDP.xWaitingPacketsList ) ), pxSocket->u.xUDP.uxMaxPackets, pxSocket->usLocalPort ) ); xReturn = pdFAIL; /* we did not consume or release the buffer */ } } } #endif /* if ( ipconfigUDP_MAX_RX_PACKETS > 0U ) */ #if ( ipconfigUSE_CALLBACKS == 1 ) || ( ipconfigUDP_MAX_RX_PACKETS > 0U ) if( xReturn == pdPASS ) /*lint !e774: Boolean within 'if' always evaluates to True, depending on configuration. [MISRA 2012 Rule 14.3, required. */ #else /* xReturn is still pdPASS. */ #endif { vTaskSuspendAll(); { taskENTER_CRITICAL(); { /* Add the network packet to the list of packets to be * processed by the socket. */ vListInsertEnd( &( pxSocket->u.xUDP.xWaitingPacketsList ), &( pxNetworkBuffer->xBufferListItem ) ); } taskEXIT_CRITICAL(); } ( void ) xTaskResumeAll(); /* Set the socket's receive event */ if( pxSocket->xEventGroup != NULL ) { ( void ) xEventGroupSetBits( pxSocket->xEventGroup, ( EventBits_t ) eSOCKET_RECEIVE ); } #if ( ipconfigSUPPORT_SELECT_FUNCTION == 1 ) { if( ( pxSocket->pxSocketSet != NULL ) && ( ( pxSocket->xSelectBits & ( ( EventBits_t ) eSELECT_READ ) ) != 0U ) ) { ( void ) xEventGroupSetBits( pxSocket->pxSocketSet->xSelectGroup, ( EventBits_t ) eSELECT_READ ); } } #endif #if ( ipconfigSOCKET_HAS_USER_SEMAPHORE == 1 ) { if( pxSocket->pxUserSemaphore != NULL ) { ( void ) xSemaphoreGive( pxSocket->pxUserSemaphore ); } } #endif #if ( ipconfigUSE_DHCP == 1 ) { if( xIsDHCPSocket( pxSocket ) != 0 ) { ( void ) xSendDHCPEvent( pxNetworkBuffer->pxEndPoint ); } } #endif } } else { /* There is no socket listening to the target port, but still it might * be for this node. */ #if ( ipconfigUSE_DNS == 1 ) && ( ipconfigDNS_USE_CALLBACKS == 1 ) /* A DNS reply, check for the source port. Although the DNS client * does open a UDP socket to send a messages, this socket will be * closed after a short timeout. Messages that come late (after the * socket is closed) will be treated here. */ if( FreeRTOS_ntohs( pxUDPPacket->xUDPHeader.usSourcePort ) == ( uint16_t ) ipDNS_PORT ) { vARPRefreshCacheEntry( &( pxUDPPacket->xEthernetHeader.xSourceAddress ), pxUDPPacket->xIPHeader.ulSourceIPAddress, pxNetworkBuffer->pxEndPoint ); xReturn = ( BaseType_t ) ulDNSHandlePacket( pxNetworkBuffer ); } else #endif #if ( ipconfigUSE_DNS == 1 ) && ( ipconfigUSE_LLMNR == 1 ) /* A LLMNR request, check for the destination port. */ if( ( usPort == FreeRTOS_ntohs( ipLLMNR_PORT ) ) || ( pxUDPPacket->xUDPHeader.usSourcePort == FreeRTOS_ntohs( ipLLMNR_PORT ) ) ) { vARPRefreshCacheEntry( &( pxUDPPacket->xEthernetHeader.xSourceAddress ), pxUDPPacket->xIPHeader.ulSourceIPAddress, pxNetworkBuffer->pxEndPoint ); xReturn = ( BaseType_t ) ulDNSHandlePacket( pxNetworkBuffer ); } else #endif /* ipconfigUSE_LLMNR */ #if ( ipconfigUSE_DNS == 1 ) && ( ipconfigUSE_MDNS == 1 ) /* A MDNS request, check for the destination port. */ if( ( usPort == FreeRTOS_ntohs( ipMDNS_PORT ) ) || ( pxUDPPacket->xUDPHeader.usSourcePort == FreeRTOS_ntohs( ipMDNS_PORT ) ) ) { #if ( ipconfigUSE_IPv6 != 0 ) if( pxUDPPacket->xEthernetHeader.usFrameType == ipIPv6_FRAME_TYPE ) { } else #endif { vARPRefreshCacheEntry( &( pxUDPPacket->xEthernetHeader.xSourceAddress ), pxUDPPacket->xIPHeader.ulSourceIPAddress, pxNetworkBuffer->pxEndPoint ); } xReturn = ( BaseType_t ) ulDNSHandlePacket( pxNetworkBuffer ); } else #endif /* ipconfigUSE_MDNS */ #if ( ipconfigUSE_NBNS == 1 ) /* a NetBIOS request, check for the destination port */ if( ( usPort == FreeRTOS_ntohs( ipNBNS_PORT ) ) || ( pxUDPPacket->xUDPHeader.usSourcePort == FreeRTOS_ntohs( ipNBNS_PORT ) ) ) { vARPRefreshCacheEntry( &( pxUDPPacket->xEthernetHeader.xSourceAddress ), pxUDPPacket->xIPHeader.ulSourceIPAddress, pxNetworkBuffer->pxEndPoint ); xReturn = ( BaseType_t ) ulNBNSHandlePacket( pxNetworkBuffer ); } else #endif /* ipconfigUSE_NBNS */ { xReturn = pdFAIL; } } } while( ipFALSE_BOOL ); return xReturn; } /*-----------------------------------------------------------*/ /* *INDENT-OFF* */ #endif /* ipconfigUSE_IPv4 != 0 ) */ /* *INDENT-ON* */