git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/FreeRTOS_UDP_IP.c

   1 /*\r
   2  * FreeRTOS+TCP V2.0.1\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 /* Standard includes. */\r
  29 #include <stdint.h>\r
  30 #include <stdio.h>\r
  31 \r
  32 /* FreeRTOS includes. */\r
  33 #include "FreeRTOS.h"\r
  34 #include "task.h"\r
  35 #include "queue.h"\r
  36 #include "semphr.h"\r
  37 \r
  38 /* FreeRTOS+TCP includes. */\r
  39 #include "FreeRTOS_IP.h"\r
  40 #include "FreeRTOS_Sockets.h"\r
  41 #include "FreeRTOS_IP_Private.h"\r
  42 #include "FreeRTOS_UDP_IP.h"\r
  43 #include "FreeRTOS_ARP.h"\r
  44 #include "FreeRTOS_DHCP.h"\r
  45 #include "NetworkInterface.h"\r
  46 #include "NetworkBufferManagement.h"\r
  47 \r
  48 #if( ipconfigUSE_DNS == 1 )\r
  49         #include "FreeRTOS_DNS.h"\r
  50 #endif\r
  51 \r
  52 /* The expected IP version and header length coded into the IP header itself. */\r
  53 #define ipIP_VERSION_AND_HEADER_LENGTH_BYTE ( ( uint8_t ) 0x45 )\r
  54 \r
  55 /* Part of the Ethernet and IP headers are always constant when sending an IPv4\r
  56 UDP packet.  This array defines the constant parts, allowing this part of the\r
  57 packet to be filled in using a simple memcpy() instead of individual writes. */\r
  58 UDPPacketHeader_t xDefaultPartUDPPacketHeader =\r
  59 {\r
  60         /* .ucBytes : */\r
  61         {\r
  62                 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,     /* Ethernet source MAC address. */\r
  63                 0x08, 0x00,                                                     /* Ethernet frame type. */\r
  64                 ipIP_VERSION_AND_HEADER_LENGTH_BYTE,    /* ucVersionHeaderLength. */\r
  65                 0x00,                                                                   /* ucDifferentiatedServicesCode. */\r
  66                 0x00, 0x00,                                                     /* usLength. */\r
  67                 0x00, 0x00,                                                     /* usIdentification. */\r
  68                 0x00, 0x00,                                                     /* usFragmentOffset. */\r
  69                 ipconfigUDP_TIME_TO_LIVE,                               /* ucTimeToLive */\r
  70                 ipPROTOCOL_UDP,                                                 /* ucProtocol. */\r
  71                 0x00, 0x00,                                                     /* usHeaderChecksum. */\r
  72                 0x00, 0x00, 0x00, 0x00                                  /* Source IP address. */\r
  73         }\r
  74 };\r
  75 /*-----------------------------------------------------------*/\r
  76 \r
  77 void vProcessGeneratedUDPPacket( NetworkBufferDescriptor_t * const pxNetworkBuffer )\r
  78 {\r
  79 UDPPacket_t *pxUDPPacket;\r
  80 IPHeader_t *pxIPHeader;\r
  81 eARPLookupResult_t eReturned;\r
  82 uint32_t ulIPAddress = pxNetworkBuffer->ulIPAddress;\r
  83 \r
  84         /* Map the UDP packet onto the start of the frame. */\r
  85         pxUDPPacket = ( UDPPacket_t * ) pxNetworkBuffer->pucEthernetBuffer;\r
  86 \r
  87         /* Determine the ARP cache status for the requested IP address. */\r
  88         eReturned = eARPGetCacheEntry( &( ulIPAddress ), &( pxUDPPacket->xEthernetHeader.xDestinationAddress ) );\r
  89 \r
  90         if( eReturned != eCantSendPacket )\r
  91         {\r
  92                 if( eReturned == eARPCacheHit )\r
  93                 {\r
  94                         #if( ipconfigDRIVER_INCLUDED_TX_IP_CHECKSUM == 0 )\r
  95                                 uint8_t ucSocketOptions;\r
  96                         #endif\r
  97                         iptraceSENDING_UDP_PACKET( pxNetworkBuffer->ulIPAddress );\r
  98 \r
  99                         /* Create short cuts to the data within the packet. */\r
 100                         pxIPHeader = &( pxUDPPacket->xIPHeader );\r
 101 \r
 102                 #if ( ipconfigSUPPORT_OUTGOING_PINGS == 1 )\r
 103                         /* Is it possible that the packet is not actually a UDP packet\r
 104                         after all, but an ICMP packet. */\r
 105                         if( pxNetworkBuffer->usPort != ipPACKET_CONTAINS_ICMP_DATA )\r
 106                 #endif /* ipconfigSUPPORT_OUTGOING_PINGS */\r
 107                         {\r
 108                         UDPHeader_t *pxUDPHeader;\r
 109 \r
 110                                 pxUDPHeader = &( pxUDPPacket->xUDPHeader );\r
 111 \r
 112                                 pxUDPHeader->usDestinationPort = pxNetworkBuffer->usPort;\r
 113                                 pxUDPHeader->usSourcePort = pxNetworkBuffer->usBoundPort;\r
 114                                 pxUDPHeader->usLength = ( uint16_t ) ( pxNetworkBuffer->xDataLength + sizeof( UDPHeader_t ) );\r
 115                                 pxUDPHeader->usLength = FreeRTOS_htons( pxUDPHeader->usLength );\r
 116                                 pxUDPHeader->usChecksum = 0u;\r
 117                         }\r
 118 \r
 119                         /* memcpy() the constant parts of the header information into\r
 120                         the     correct location within the packet.  This fills in:\r
 121                                 xEthernetHeader.xSourceAddress\r
 122                                 xEthernetHeader.usFrameType\r
 123                                 xIPHeader.ucVersionHeaderLength\r
 124                                 xIPHeader.ucDifferentiatedServicesCode\r
 125                                 xIPHeader.usLength\r
 126                                 xIPHeader.usIdentification\r
 127                                 xIPHeader.usFragmentOffset\r
 128                                 xIPHeader.ucTimeToLive\r
 129                                 xIPHeader.ucProtocol\r
 130                         and\r
 131                                 xIPHeader.usHeaderChecksum\r
 132                         */\r
 133 \r
 134                         /* Save options now, as they will be overwritten by memcpy */\r
 135                         #if( ipconfigDRIVER_INCLUDED_TX_IP_CHECKSUM == 0 )\r
 136                         {\r
 137                                 ucSocketOptions = pxNetworkBuffer->pucEthernetBuffer[ ipSOCKET_OPTIONS_OFFSET ];\r
 138                         }\r
 139                         #endif\r
 140 \r
 141                         memcpy( ( void *) &( pxUDPPacket->xEthernetHeader.xSourceAddress ), ( void * ) xDefaultPartUDPPacketHeader.ucBytes, sizeof( xDefaultPartUDPPacketHeader ) );\r
 142 \r
 143                 #if ipconfigSUPPORT_OUTGOING_PINGS == 1\r
 144                         if( pxNetworkBuffer->usPort == ipPACKET_CONTAINS_ICMP_DATA )\r
 145                         {\r
 146                                 pxIPHeader->ucProtocol = ipPROTOCOL_ICMP;\r
 147                                 pxIPHeader->usLength = ( uint16_t ) ( pxNetworkBuffer->xDataLength + sizeof( IPHeader_t ) );\r
 148                         }\r
 149                         else\r
 150                 #endif /* ipconfigSUPPORT_OUTGOING_PINGS */\r
 151                         {\r
 152                                 pxIPHeader->usLength = ( uint16_t ) ( pxNetworkBuffer->xDataLength + sizeof( IPHeader_t ) + sizeof( UDPHeader_t ) );\r
 153                         }\r
 154 \r
 155                         /* The total transmit size adds on the Ethernet header. */\r
 156                         pxNetworkBuffer->xDataLength = pxIPHeader->usLength + sizeof( EthernetHeader_t );\r
 157                         pxIPHeader->usLength = FreeRTOS_htons( pxIPHeader->usLength );\r
 158                         pxIPHeader->ulDestinationIPAddress = pxNetworkBuffer->ulIPAddress;\r
 159 \r
 160                         #if( ipconfigUSE_LLMNR == 1 )\r
 161                         {\r
 162                                 /* LLMNR messages are typically used on a LAN and they're\r
 163                                  * not supposed to cross routers */\r
 164                                 if( pxNetworkBuffer->ulIPAddress == ipLLMNR_IP_ADDR )\r
 165                                 {\r
 166                                         pxIPHeader->ucTimeToLive = 0x01;\r
 167                                 }\r
 168                         }\r
 169                         #endif\r
 170 \r
 171                         #if( ipconfigDRIVER_INCLUDED_TX_IP_CHECKSUM == 0 )\r
 172                         {\r
 173                                 pxIPHeader->usHeaderChecksum = 0u;\r
 174                                 pxIPHeader->usHeaderChecksum = usGenerateChecksum( 0UL, ( uint8_t * ) &( pxIPHeader->ucVersionHeaderLength ), ipSIZE_OF_IPv4_HEADER );\r
 175                                 pxIPHeader->usHeaderChecksum = ~FreeRTOS_htons( pxIPHeader->usHeaderChecksum );\r
 176 \r
 177                                 if( ( ucSocketOptions & ( uint8_t ) FREERTOS_SO_UDPCKSUM_OUT ) != 0u )\r
 178                                 {\r
 179                                         usGenerateProtocolChecksum( (uint8_t*)pxUDPPacket, pdTRUE );\r
 180                                 }\r
 181                                 else\r
 182                                 {\r
 183                                         pxUDPPacket->xUDPHeader.usChecksum = 0u;\r
 184                                 }\r
 185                         }\r
 186                         #endif\r
 187                 }\r
 188                 else if( eReturned == eARPCacheMiss )\r
 189                 {\r
 190                         /* Add an entry to the ARP table with a null hardware address.\r
 191                         This allows the ARP timer to know that an ARP reply is\r
 192                         outstanding, and perform retransmissions if necessary. */\r
 193                         vARPRefreshCacheEntry( NULL, ulIPAddress );\r
 194 \r
 195                         /* Generate an ARP for the required IP address. */\r
 196                         iptracePACKET_DROPPED_TO_GENERATE_ARP( pxNetworkBuffer->ulIPAddress );\r
 197                         pxNetworkBuffer->ulIPAddress = ulIPAddress;\r
 198                         vARPGenerateRequestPacket( pxNetworkBuffer );\r
 199                 }\r
 200                 else\r
 201                 {\r
 202                         /* The lookup indicated that an ARP request has already been\r
 203                         sent out for the queried IP address. */\r
 204                         eReturned = eCantSendPacket;\r
 205                 }\r
 206         }\r
 207 \r
 208         if( eReturned != eCantSendPacket )\r
 209         {\r
 210                 /* The network driver is responsible for freeing the network buffer\r
 211                 after the packet has been sent. */\r
 212 \r
 213                 #if defined( ipconfigETHERNET_MINIMUM_PACKET_BYTES )\r
 214                 {\r
 215                         if( pxNetworkBuffer->xDataLength < ( size_t ) ipconfigETHERNET_MINIMUM_PACKET_BYTES )\r
 216                         {\r
 217                         BaseType_t xIndex;\r
 218 \r
 219                                 for( xIndex = ( BaseType_t ) pxNetworkBuffer->xDataLength; xIndex < ( BaseType_t ) ipconfigETHERNET_MINIMUM_PACKET_BYTES; xIndex++ )\r
 220                                 {\r
 221                                         pxNetworkBuffer->pucEthernetBuffer[ xIndex ] = 0u;\r
 222                                 }\r
 223                                 pxNetworkBuffer->xDataLength = ( size_t ) ipconfigETHERNET_MINIMUM_PACKET_BYTES;\r
 224                         }\r
 225                 }\r
 226                 #endif\r
 227 \r
 228                 xNetworkInterfaceOutput( pxNetworkBuffer, pdTRUE );\r
 229         }\r
 230         else\r
 231         {\r
 232                 /* The packet can't be sent (DHCP not completed?).  Just drop the\r
 233                 packet. */\r
 234                 vReleaseNetworkBufferAndDescriptor( pxNetworkBuffer );\r
 235         }\r
 236 }\r
 237 /*-----------------------------------------------------------*/\r
 238 \r
 239 BaseType_t xProcessReceivedUDPPacket( NetworkBufferDescriptor_t *pxNetworkBuffer, uint16_t usPort )\r
 240 {\r
 241 BaseType_t xReturn = pdPASS;\r
 242 FreeRTOS_Socket_t *pxSocket;\r
 243 \r
 244 UDPPacket_t *pxUDPPacket = (UDPPacket_t *) pxNetworkBuffer->pucEthernetBuffer;\r
 245 \r
 246         pxSocket = pxUDPSocketLookup( usPort );\r
 247 \r
 248         if( pxSocket )\r
 249         {\r
 250 \r
 251                 /* When refreshing the ARP cache with received UDP packets we must be\r
 252                 careful;  hundreds of broadcast messages may pass and if we're not\r
 253                 handling them, no use to fill the ARP cache with those IP addresses. */\r
 254                 vARPRefreshCacheEntry( &( pxUDPPacket->xEthernetHeader.xSourceAddress ), pxUDPPacket->xIPHeader.ulSourceIPAddress );\r
 255 \r
 256                 #if( ipconfigUSE_CALLBACKS == 1 )\r
 257                 {\r
 258                         /* Did the owner of this socket register a reception handler ? */\r
 259                         if( ipconfigIS_VALID_PROG_ADDRESS( pxSocket->u.xUDP.pxHandleReceive ) )\r
 260                         {\r
 261                                 struct freertos_sockaddr xSourceAddress, destinationAddress;\r
 262                                 void *pcData = ( void * ) &( pxNetworkBuffer->pucEthernetBuffer[ ipUDP_PAYLOAD_OFFSET_IPv4 ] );\r
 263                                 FOnUDPReceive_t xHandler = ( FOnUDPReceive_t ) pxSocket->u.xUDP.pxHandleReceive;\r
 264                                 xSourceAddress.sin_port = pxNetworkBuffer->usPort;\r
 265                                 xSourceAddress.sin_addr = pxNetworkBuffer->ulIPAddress;\r
 266                                 destinationAddress.sin_port = usPort;\r
 267                                 destinationAddress.sin_addr = pxUDPPacket->xIPHeader.ulDestinationIPAddress;\r
 268 \r
 269                                 if( xHandler( ( Socket_t * ) pxSocket, ( void* ) pcData, ( size_t ) pxNetworkBuffer->xDataLength,\r
 270                                         &xSourceAddress, &destinationAddress ) != pdFALSE )\r
 271                                 {\r
 272                                         xReturn = pdFAIL; /* xHandler has consumed the data, do not add it to .xWaitingPacketsList'. */\r
 273                                 }\r
 274                         }\r
 275                 }\r
 276                 #endif /* ipconfigUSE_CALLBACKS */\r
 277 \r
 278                 #if( ipconfigUDP_MAX_RX_PACKETS > 0 )\r
 279                 {\r
 280                         if( xReturn == pdPASS )\r
 281                         {\r
 282                                 if ( listCURRENT_LIST_LENGTH( &( pxSocket->u.xUDP.xWaitingPacketsList ) ) >= pxSocket->u.xUDP.uxMaxPackets )\r
 283                                 {\r
 284                                         FreeRTOS_debug_printf( ( "xProcessReceivedUDPPacket: buffer full %ld >= %ld port %u\n",\r
 285                                                 listCURRENT_LIST_LENGTH( &( pxSocket->u.xUDP.xWaitingPacketsList ) ),\r
 286                                                 pxSocket->u.xUDP.uxMaxPackets, pxSocket->usLocalPort ) );\r
 287                                         xReturn = pdFAIL; /* we did not consume or release the buffer */\r
 288                                 }\r
 289                         }\r
 290                 }\r
 291                 #endif\r
 292 \r
 293                 if( xReturn == pdPASS )\r
 294                 {\r
 295                         vTaskSuspendAll();\r
 296                         {\r
 297                                 if( xReturn == pdPASS )\r
 298                                 {\r
 299                                         taskENTER_CRITICAL();\r
 300                                         {\r
 301                                                 /* Add the network packet to the list of packets to be\r
 302                                                 processed by the socket. */\r
 303                                                 vListInsertEnd( &( pxSocket->u.xUDP.xWaitingPacketsList ), &( pxNetworkBuffer->xBufferListItem ) );\r
 304                                         }\r
 305                                         taskEXIT_CRITICAL();\r
 306                                 }\r
 307                         }\r
 308                         xTaskResumeAll();\r
 309 \r
 310                         /* Set the socket's receive event */\r
 311                         if( pxSocket->xEventGroup != NULL )\r
 312                         {\r
 313                                 xEventGroupSetBits( pxSocket->xEventGroup, eSOCKET_RECEIVE );\r
 314                         }\r
 315 \r
 316                         #if( ipconfigSUPPORT_SELECT_FUNCTION == 1 )\r
 317                         {\r
 318                                 if( ( pxSocket->pxSocketSet != NULL ) && ( ( pxSocket->xSelectBits & eSELECT_READ ) != 0 ) )\r
 319                                 {\r
 320                                         xEventGroupSetBits( pxSocket->pxSocketSet->xSelectGroup, eSELECT_READ );\r
 321                                 }\r
 322                         }\r
 323                         #endif\r
 324 \r
 325                         #if( ipconfigSOCKET_HAS_USER_SEMAPHORE == 1 )\r
 326                         {\r
 327                                 if( pxSocket->pxUserSemaphore != NULL )\r
 328                                 {\r
 329                                         xSemaphoreGive( pxSocket->pxUserSemaphore );\r
 330                                 }\r
 331                         }\r
 332                         #endif\r
 333 \r
 334                         #if( ipconfigUSE_DHCP == 1 )\r
 335                         {\r
 336                                 if( xIsDHCPSocket( pxSocket ) )\r
 337                                 {\r
 338                                         xSendEventToIPTask( eDHCPEvent );\r
 339                                 }\r
 340                         }\r
 341                         #endif\r
 342                 }\r
 343         }\r
 344         else\r
 345         {\r
 346                 /* There is no socket listening to the target port, but still it might\r
 347                 be for this node. */\r
 348 \r
 349                 #if( ipconfigUSE_DNS == 1 )\r
 350                         /* A DNS reply, check for the source port.  Although the DNS client\r
 351                         does open a UDP socket to send a messages, this socket will be\r
 352                         closed after a short timeout.  Messages that come late (after the\r
 353                         socket is closed) will be treated here. */\r
 354                         if( FreeRTOS_ntohs( pxUDPPacket->xUDPHeader.usSourcePort ) == ipDNS_PORT )\r
 355                         {\r
 356                                 vARPRefreshCacheEntry( &( pxUDPPacket->xEthernetHeader.xSourceAddress ), pxUDPPacket->xIPHeader.ulSourceIPAddress );\r
 357                                 xReturn = ( BaseType_t )ulDNSHandlePacket( pxNetworkBuffer );\r
 358                         }\r
 359                         else\r
 360                 #endif\r
 361 \r
 362                 #if( ipconfigUSE_LLMNR == 1 )\r
 363                         /* A LLMNR request, check for the destination port. */\r
 364                         if( ( usPort == FreeRTOS_ntohs( ipLLMNR_PORT ) ) ||\r
 365                                 ( pxUDPPacket->xUDPHeader.usSourcePort == FreeRTOS_ntohs( ipLLMNR_PORT ) ) )\r
 366                         {\r
 367                                 vARPRefreshCacheEntry( &( pxUDPPacket->xEthernetHeader.xSourceAddress ), pxUDPPacket->xIPHeader.ulSourceIPAddress );\r
 368                                 xReturn = ( BaseType_t )ulDNSHandlePacket( pxNetworkBuffer );\r
 369                         }\r
 370                         else\r
 371                 #endif /* ipconfigUSE_LLMNR */\r
 372 \r
 373                 #if( ipconfigUSE_NBNS == 1 )\r
 374                         /* a NetBIOS request, check for the destination port */\r
 375                         if( ( usPort == FreeRTOS_ntohs( ipNBNS_PORT ) ) ||\r
 376                                 ( pxUDPPacket->xUDPHeader.usSourcePort == FreeRTOS_ntohs( ipNBNS_PORT ) ) )\r
 377                         {\r
 378                                 vARPRefreshCacheEntry( &( pxUDPPacket->xEthernetHeader.xSourceAddress ), pxUDPPacket->xIPHeader.ulSourceIPAddress );\r
 379                                 xReturn = ( BaseType_t )ulNBNSHandlePacket( pxNetworkBuffer );\r
 380                         }\r
 381                         else\r
 382                 #endif /* ipconfigUSE_NBNS */\r
 383                 {\r
 384                         xReturn = pdFAIL;\r
 385                 }\r
 386         }\r
 387 \r
 388         return xReturn;\r
 389 }\r
 390 /*-----------------------------------------------------------*/\r