AppPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / AppPkg / Applications / Sockets / SetSockOpt / SetSockOpt.c

/** @file\r
  Set the socket options\r
\r
  Copyright (c) 2011-2012, Intel Corporation. All rights reserved.\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <errno.h>\r
#include <stdio.h>\r
#include <string.h>\r
#include <Uefi.h>\r
#include <unistd.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiLib.h>\r
\r
#include <sys/socket.h>\r
#include <sys/time.h>\r
\r
typedef enum _DATA_TYPE {\r
  DATA_TYPE_UNKNOWN = 0,\r
  DATA_TYPE_INT32_DECIMAL,\r
  DATA_TYPE_SOCKET_TYPE,\r
  DATA_TYPE_TIMEVAL\r
} DATA_TYPE;\r
\r
typedef struct {\r
  char * pOptionName;\r
  int OptionValue;\r
  int OptionLevel;\r
  BOOLEAN bSetAllowed;\r
  DATA_TYPE DataType;\r
} OPTIONS;\r
\r
CONST OPTIONS mOptions[] = {\r
  { "SO_ACCEPTCONN", SO_ACCEPTCONN, SOL_SOCKET, FALSE, DATA_TYPE_UNKNOWN },\r
  { "SO_BROADCAST", SO_BROADCAST, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_DEBUG", SO_DEBUG, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_DONTROUTE", SO_DONTROUTE, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_ERROR", SO_ERROR, SOL_SOCKET, FALSE, DATA_TYPE_UNKNOWN },\r
  { "SO_KEEPALIVE", SO_KEEPALIVE, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_OOBINLINE", SO_OOBINLINE, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_OVERFLOWED", SO_OVERFLOWED, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_RCVBUF", SO_RCVBUF, SOL_SOCKET, TRUE, DATA_TYPE_INT32_DECIMAL },\r
  { "SO_RCVLOWAT", SO_RCVLOWAT, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_RCVTIMEO", SO_RCVTIMEO, SOL_SOCKET, TRUE, DATA_TYPE_TIMEVAL },\r
  { "SO_REUSEADDR", SO_REUSEADDR, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_REUSEPORT", SO_REUSEPORT, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_SNDBUF", SO_SNDBUF, SOL_SOCKET, TRUE, DATA_TYPE_INT32_DECIMAL },\r
  { "SO_SNDLOWAT", SO_SNDLOWAT, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_SNDTIMEO", SO_SNDTIMEO, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_TIMESTAMP", SO_TIMESTAMP, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN },\r
  { "SO_TYPE", SO_TYPE, SOL_SOCKET, FALSE, DATA_TYPE_SOCKET_TYPE },\r
  { "SO_USELOOPBACK", SO_USELOOPBACK, SOL_SOCKET, TRUE, DATA_TYPE_UNKNOWN }\r
};\r
\r
\r
UINT8 mBuffer[ 65536 ];\r
UINT8 mValue[ 65536 ];\r
char * mSocketType[] = {\r
  "SOCK_STREAM",\r
  "SOCK_DGRAM",\r
  "SOCK_RAW",\r
  "SOCK_RDM",\r
  "SOCK_SEQPACKET"\r
};\r
\r
void\r
DisplayOption (\r
  CONST OPTIONS * pOption,\r
  socklen_t LengthInBytes,\r
  BOOLEAN bDisplayUpdate,\r
  BOOLEAN bDisplayCrLf\r
  )\r
{\r
  UINT8 * pEnd;\r
  char * pString;\r
  union {\r
    UINT8 * u8;\r
    INT32 * i32;\r
    struct timeval * TimeVal;\r
  } Value;\r
\r
  //\r
  //  Display the value length\r
  //\r
  if ( !bDisplayUpdate ) {\r
    Print ( L"LengthInBytes: %d\r\n", LengthInBytes );\r
    Print ( L"%a: ", pOption->pOptionName );\r
  }\r
  else {\r
    Print ( L" --> " );\r
  }\r
\r
  //\r
  //  Display the value\r
  //\r
  Value.u8 = &mBuffer[0];\r
  switch ( pOption->DataType ) {\r
  case DATA_TYPE_UNKNOWN:\r
    Print ( L"%a:", pOption->pOptionName );\r
    pEnd = &Value.u8[ LengthInBytes ];\r
    while ( pEnd > Value.u8 ) {\r
      Print ( L" %02x", *Value.u8 );\r
      Value.u8 += 1;\r
    }\r
    break;\r
    \r
  case DATA_TYPE_INT32_DECIMAL:\r
    if ( 4 == LengthInBytes ) {\r
      Print ( L"%d", *Value.i32 );\r
    }\r
    else {\r
      errno = ( 4 > LengthInBytes ) ? EBUFSIZE : ERANGE;\r
      Print ( L"\r\nERROR - Invalid length, errno: %d\r\n", errno );\r
    }\r
    break;\r
\r
  case DATA_TYPE_SOCKET_TYPE:\r
    if ( 4 == LengthInBytes ) {\r
      if (( SOCK_STREAM <= *Value.i32 ) && ( SOCK_SEQPACKET >= *Value.i32 )) {\r
        pString = mSocketType[ *Value.i32 - SOCK_STREAM ];\r
        Print ( L"%a", pString );\r
      }\r
      else {\r
        Print ( L"%08x (unknown type)", *Value.i32 );\r
      }\r
    }\r
    else {\r
      errno = ( 4 > LengthInBytes ) ? EBUFSIZE : ERANGE;\r
      Print ( L"\r\nERROR - Invalid length, errno: %d\r\n", errno );\r
    }\r
    break;\r
\r
  case DATA_TYPE_TIMEVAL:\r
    if ( sizeof ( *Value.TimeVal ) == LengthInBytes ) {\r
      if (( 0 == Value.TimeVal->tv_sec )\r
        && ( 0 == Value.TimeVal->tv_usec )) {\r
        Print ( L"Infinite" );\r
      }\r
      else {\r
        Print ( L"%d.%06d sec",\r
                Value.TimeVal->tv_sec,\r
                Value.TimeVal->tv_usec );\r
      }\r
    }\r
    else {\r
      errno = ( 4 > LengthInBytes ) ? EBUFSIZE : ERANGE;\r
      Print ( L"\r\nERROR - Invalid length, errno: %d\r\n", errno );\r
    }\r
    break;\r
  }\r
\r
  //\r
  //  Terminate the line\r
  //\r
  if ( bDisplayCrLf ) {\r
    Print ( L"\r\n" );\r
  }\r
}\r
\r
socklen_t\r
GetOptionValue (\r
  CONST OPTIONS * pOption,\r
  char * pValue\r
  )\r
{\r
  socklen_t BytesToWrite;\r
  union {\r
    UINT8 * u8;\r
    INT32 * i32;\r
    struct timeval * TimeVal;\r
  } Value;\r
  int Values;\r
\r
  //\r
  //  Assume failure\r
  //\r
  errno = EINVAL;\r
  BytesToWrite = 0;\r
\r
  //\r
  //  Determine the type of parameter\r
  //\r
  if ( pOption->bSetAllowed ) {\r
    Value.u8 = &mValue[0];\r
    switch ( pOption->DataType ) {\r
    default:\r
      break;\r
\r
    case DATA_TYPE_INT32_DECIMAL:\r
      Values = sscanf ( pValue, "%d", Value.i32 );\r
      if ( 1 == Values ) {\r
        BytesToWrite = sizeof ( *Value.i32);\r
        errno = 0;\r
      }\r
      break;\r
\r
    case DATA_TYPE_TIMEVAL:\r
      Values = sscanf ( pValue, "%d.%d",\r
                        &Value.TimeVal->tv_sec,\r
                        &Value.TimeVal->tv_usec );\r
      if (( 2 == Values )\r
        && ( 0 <= Value.TimeVal->tv_sec )\r
        && ( 0 <= Value.TimeVal->tv_usec )\r
        && ( 1000000 > Value.TimeVal->tv_usec )){\r
        BytesToWrite = sizeof ( *Value.TimeVal );\r
        errno = 0;\r
      }\r
    }\r
  }\r
\r
  //\r
  //  Display the error\r
  //\r
  if ( 0 == BytesToWrite ) {\r
    Print ( L"ERROR - Invalid value!\r\n" );\r
  }\r
\r
  //\r
  //  Return the number of bytes to be written\r
  //\r
  return BytesToWrite;\r
}\r
\r
\r
/**\r
  Set the socket options\r
\r
  @param [in] Argc  The number of arguments\r
  @param [in] Argv  The argument value array\r
\r
  @retval  0        The application exited normally.\r
  @retval  Other    An error occurred.\r
**/\r
int\r
main (\r
  IN int Argc,\r
  IN char **Argv\r
  )\r
{\r
  socklen_t BytesToWrite;\r
  socklen_t LengthInBytes;\r
  CONST OPTIONS * pEnd;\r
  CONST OPTIONS * pOption;\r
  int s;\r
  int Status;\r
\r
  DEBUG (( DEBUG_INFO,\r
            "%a starting\r\n",\r
            Argv[0]));\r
\r
  //\r
  //  Parse the socket option\r
  //\r
  pOption = &mOptions[0];\r
  pEnd = &pOption[sizeof ( mOptions ) / sizeof ( mOptions[0])];\r
  if ( 2 <= Argc ) {\r
    while ( pEnd > pOption ) {\r
      if ( 0 == strcmp ( Argv[1], pOption->pOptionName )) {\r
        break;\r
      }\r
      pOption += 1;\r
    }\r
    if ( pEnd <= pOption ) {\r
      Print ( L"ERROR: Invalid option: %a\r\n", Argv[1]);\r
      Argc = 1;\r
    }\r
  }\r
\r
  //\r
  //  Display the help if necessary\r
  //\r
  if (( 2 > Argc ) || ( 3 < Argc )) {\r
    Print ( L"%a <option>\r\n", Argv[0]);\r
    Print ( L"\r\n" );\r
    Print ( L"Option one of:\r\n" );\r
    pOption = &mOptions[0];\r
    while ( pEnd > pOption ) {\r
      Print ( L"   %a: %a\r\n",\r
              pOption->pOptionName,\r
              pOption->bSetAllowed ? "get/set" : "get" );\r
      pOption += 1;\r
    }\r
    errno = EINVAL;\r
  }\r
  else {\r
    //\r
    //  Determine if the value is to be set\r
    //\r
    BytesToWrite = 0;\r
    if (( 3 > Argc )\r
      || ( 0 < ( BytesToWrite = GetOptionValue ( pOption, Argv[2])))) {\r
      //\r
      //  Get the socket\r
      //\r
      s = socket ( AF_INET, 0, 0 );\r
      if ( -1 == s ) {\r
        Print ( L"ERROR - Unable to open the socket, errno: %d\r\n", errno );\r
      }\r
      else {\r
        //\r
        //  Display the option value\r
        //\r
        LengthInBytes = sizeof ( mBuffer );\r
        Status = getsockopt ( s,\r
                              pOption->OptionLevel,\r
                              pOption->OptionValue,\r
                              &mBuffer,\r
                              &LengthInBytes );\r
        if ( -1 == Status ) {\r
          Print ( L"ERROR - getsockopt failed, errno: %d\r\n", errno );\r
        }\r
        else {\r
          DisplayOption ( pOption,\r
                          LengthInBytes,\r
                          FALSE,\r
                          (BOOLEAN)( 0 == BytesToWrite ));\r
\r
          //\r
          //  Determine if the value is to be set\r
          //\r
          if (( 0 < BytesToWrite )\r
              && ( BytesToWrite == LengthInBytes )) {\r
            //\r
            //  Set the option value\r
            //\r
            Status = setsockopt ( s,\r
                                  pOption->OptionLevel,\r
                                  pOption->OptionValue,\r
                                  &mValue,\r
                                  BytesToWrite );\r
            if ( -1 == Status ) {\r
              Print ( L"ERROR - setsockopt failed, errno: %d\r\n", errno );\r
            }\r
            else {\r
              //\r
              //  Display the updated option value\r
              //\r
              Status = getsockopt ( s,\r
                                    pOption->OptionLevel,\r
                                    pOption->OptionValue,\r
                                    &mBuffer,\r
                                    &LengthInBytes );\r
              if ( -1 == Status ) {\r
                Print ( L"ERROR - getsockopt failed, errno: %d\r\n", errno );\r
              }\r
              else {\r
                DisplayOption ( pOption,\r
                                LengthInBytes,\r
                                TRUE,\r
                                TRUE );\r
              }\r
            }\r
          }\r
        }\r
\r
        //\r
        //  Done with the socket\r
        //\r
        close ( s );\r
      }\r
    }\r
  }\r
\r
  //\r
  //  All done\r
  //\r
  DEBUG (( DEBUG_INFO,\r
            "%a exiting, errno: %d\r\n",\r
            Argv[0],\r
            errno ));\r
  return errno;\r
}\r