StdLib/BsdSocketLib/recvfrom.c

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Implement the recvfrom API.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Copyright (c) 2011, Intel Corporation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  All rights reserved. This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  which accompanies this distribution.  The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  http://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <SocketInternals.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Receive data from a network connection and return the remote system's address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  The recvfrom routine waits for receive data from a remote network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  connection.  This routine is typically called for SOCK_DGRAM sockets
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  when the socket is being shared by multiple remote systems and it is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  important to get the remote system address for a response.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/recv.html">POSIX</a>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  documentation is available online.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param [in] s         Socket file descriptor returned from ::socket.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param [in] buffer    Address of a buffer to receive the data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param [in] length    Length of the buffer in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param [in] flags     Message control flags
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param [out] address  Network address to receive the remote system address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param [in] address_len Length of the remote network address structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @return     This routine returns the number of valid bytes in the buffer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              zero if no data was received, and -1 when an error occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              In the case of an error, ::errno contains more details.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync **/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncssize_t
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncrecvfrom (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  int s,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  void * buffer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  size_t length,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  int flags,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  struct sockaddr * address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  socklen_t * address_len
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  socklen_t ByteCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ssize_t LengthInBytes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINT8 * pData;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SOCKET_PROTOCOL * pSocketProtocol;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_STATUS Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  struct timeval TimeVal;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_EVENT pTimer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINT64 Timeout;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ssize_t TotalBytes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //  Assume failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LengthInBytes = -1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //  Locate the context for this socket
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  pSocketProtocol = BslFdToSocketProtocol ( s, NULL, &errno );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if ( NULL != pSocketProtocol ) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    //  Receive the data from the socket
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    Status = pSocketProtocol->pfnReceive ( pSocketProtocol,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                           flags,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                           length,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                           buffer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                           (size_t *)&LengthInBytes,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                           address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                           address_len,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                           &errno );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    if ( EFI_ERROR ( Status )) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      LengthInBytes = -1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      if ( EAGAIN == errno ) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync        //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync        //  Get the timeout
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync        //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync        ByteCount = sizeof ( TimeVal );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync        LengthInBytes = getsockopt ( s,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                     SOL_SOCKET,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                     SO_RCVTIMEO,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                     &TimeVal,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                     &ByteCount );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync        if ( 0 == LengthInBytes ) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          //  Compute the timeout
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          Timeout = TimeVal.tv_sec;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          Timeout *= 1000 * 1000;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          Timeout += TimeVal.tv_usec;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          Timeout *= 10;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          //  The timer is only necessary if a timeout is running
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          LengthInBytes = -1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          Status = EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          pTimer = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          if ( 0 != Timeout ) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            Status = gBS->CreateEvent ( EVT_TIMER,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                        TPL_NOTIFY,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                        NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                        NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                        &pTimer );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          if ( !EFI_ERROR ( Status )) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            //  Start the timer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            if ( NULL != pTimer ) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              Status = gBS->SetTimer ( pTimer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                       TimerRelative,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                       Timeout );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            if ( !EFI_ERROR ( Status )) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              //  Loop until data is received or the timeout
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              //  expires
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              TotalBytes = 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              pData = (UINT8 *)buffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              do {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                //  Determine if the timeout expired
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                if ( NULL != pTimer ) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  Status = gBS->CheckEvent ( pTimer );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  if ( EFI_SUCCESS == Status ) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    errno = ETIMEDOUT;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    if ( 0 == TotalBytes ) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                      TotalBytes = -1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    break;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                //  Attempt to receive some data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                Status = pSocketProtocol->pfnReceive ( pSocketProtocol,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                                       flags,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                                       length,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                                       pData,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                                       (size_t *)&LengthInBytes,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                                       address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                                       address_len,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                                       &errno );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                if ( !EFI_ERROR ( Status )) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  //  Account for the data received
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  TotalBytes += LengthInBytes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  pData += LengthInBytes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  length -= LengthInBytes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              } while ( EFI_NOT_READY == Status );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              LengthInBytes = TotalBytes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              //  Stop the timer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              if ( NULL != pTimer ) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                gBS->SetTimer ( pTimer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                TimerCancel,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                0 );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            //  Release the timer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            if ( NULL != pTimer ) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync              gBS->CloseEvent ( pTimer );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync            }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync          }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync        }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //  Return the receive data length, -1 for errors
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return LengthInBytes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}