NetworkPkg: Apply uncrustify changes

[mirror_edk2.git] / NetworkPkg / IScsiDxe / IScsiDhcp6.c

/** @file\r
  iSCSI DHCP6 related configuration routines.\r
\r
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "IScsiImpl.h"\r
\r
/**\r
  Extract the Root Path option and get the required target information from\r
  Boot File Uniform Resource Locator (URL) Option.\r
\r
  @param[in]       RootPath      The RootPath string.\r
  @param[in]       Length        Length of the RootPath option payload.\r
  @param[in, out]  ConfigData    The iSCSI session configuration data read from\r
                                 nonvolatile device.\r
\r
  @retval EFI_SUCCESS            All required information is extracted from the\r
                                 RootPath option.\r
  @retval EFI_NOT_FOUND          The RootPath is not an iSCSI RootPath.\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.\r
  @retval EFI_INVALID_PARAMETER  The RootPath is malformatted.\r
\r
**/\r
EFI_STATUS\r
IScsiDhcp6ExtractRootPath (\r
  IN     CHAR8                        *RootPath,\r
  IN     UINT16                       Length,\r
  IN OUT ISCSI_ATTEMPT_CONFIG_NVDATA  *ConfigData\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  UINT16                       IScsiRootPathIdLen;\r
  CHAR8                        *TmpStr;\r
  ISCSI_ROOT_PATH_FIELD        Fields[RP_FIELD_IDX_MAX];\r
  ISCSI_ROOT_PATH_FIELD        *Field;\r
  UINT32                       FieldIndex;\r
  UINT8                        Index;\r
  ISCSI_SESSION_CONFIG_NVDATA  *ConfigNvData;\r
  EFI_IP_ADDRESS               Ip;\r
  UINT8                        IpMode;\r
\r
  ConfigNvData          = &ConfigData->SessionConfigData;\r
  ConfigNvData->DnsMode = FALSE;\r
  //\r
  // "iscsi:"<servername>":"<protocol>":"<port>":"<LUN>":"<targetname>\r
  //\r
  IScsiRootPathIdLen = (UINT16)AsciiStrLen (ISCSI_ROOT_PATH_ID);\r
\r
  if ((Length <= IScsiRootPathIdLen) ||\r
      (CompareMem (RootPath, ISCSI_ROOT_PATH_ID, IScsiRootPathIdLen) != 0))\r
  {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Skip the iSCSI RootPath ID "iscsi:".\r
  //\r
  RootPath = RootPath + IScsiRootPathIdLen;\r
  Length   = (UINT16)(Length - IScsiRootPathIdLen);\r
\r
  TmpStr = (CHAR8 *)AllocatePool (Length + 1);\r
  if (TmpStr == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  CopyMem (TmpStr, RootPath, Length);\r
  TmpStr[Length] = '\0';\r
\r
  Index      = 0;\r
  FieldIndex = 0;\r
  ZeroMem (&Fields[0], sizeof (Fields));\r
\r
  //\r
  // Extract SERVERNAME field in the Root Path option.\r
  //\r
  if (TmpStr[Index] != ISCSI_ROOT_PATH_ADDR_START_DELIMITER) {\r
    //\r
    // The servername is expressed as domain name.\r
    //\r
    ConfigNvData->DnsMode = TRUE;\r
  } else {\r
    Index++;\r
  }\r
\r
  Fields[RP_FIELD_IDX_SERVERNAME].Str = &TmpStr[Index];\r
\r
  if (!ConfigNvData->DnsMode) {\r
    while ((TmpStr[Index] != ISCSI_ROOT_PATH_ADDR_END_DELIMITER) && (Index < Length)) {\r
      Index++;\r
    }\r
\r
    //\r
    // Skip ']' and ':'.\r
    //\r
    TmpStr[Index] = '\0';\r
    Index        += 2;\r
  } else {\r
    while ((TmpStr[Index] != ISCSI_ROOT_PATH_FIELD_DELIMITER) && (Index < Length)) {\r
      Index++;\r
    }\r
\r
    //\r
    // Skip ':'.\r
    //\r
    TmpStr[Index] = '\0';\r
    Index        += 1;\r
  }\r
\r
  Fields[RP_FIELD_IDX_SERVERNAME].Len = (UINT8)AsciiStrLen (Fields[RP_FIELD_IDX_SERVERNAME].Str);\r
\r
  //\r
  // Extract others fields in the Root Path option string.\r
  //\r
  for (FieldIndex = 1; (FieldIndex < RP_FIELD_IDX_MAX) && (Index < Length); FieldIndex++) {\r
    if (TmpStr[Index] != ISCSI_ROOT_PATH_FIELD_DELIMITER) {\r
      Fields[FieldIndex].Str = &TmpStr[Index];\r
    }\r
\r
    while ((TmpStr[Index] != ISCSI_ROOT_PATH_FIELD_DELIMITER) && (Index < Length)) {\r
      Index++;\r
    }\r
\r
    if (TmpStr[Index] == ISCSI_ROOT_PATH_FIELD_DELIMITER) {\r
      if (FieldIndex != RP_FIELD_IDX_TARGETNAME) {\r
        TmpStr[Index] = '\0';\r
        Index++;\r
      }\r
\r
      if (Fields[FieldIndex].Str != NULL) {\r
        Fields[FieldIndex].Len = (UINT8)AsciiStrLen (Fields[FieldIndex].Str);\r
      }\r
    }\r
  }\r
\r
  if (FieldIndex != RP_FIELD_IDX_MAX) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  if ((Fields[RP_FIELD_IDX_SERVERNAME].Str == NULL) ||\r
      (Fields[RP_FIELD_IDX_TARGETNAME].Str == NULL) ||\r
      (Fields[RP_FIELD_IDX_PROTOCOL].Len > 1)\r
      )\r
  {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // Get the IP address of the target.\r
  //\r
  Field = &Fields[RP_FIELD_IDX_SERVERNAME];\r
  if (ConfigNvData->IpMode < IP_MODE_AUTOCONFIG) {\r
    IpMode = ConfigNvData->IpMode;\r
  } else {\r
    IpMode = ConfigData->AutoConfigureMode;\r
  }\r
\r
  //\r
  // Server name is expressed as domain name, just save it.\r
  //\r
  if (ConfigNvData->DnsMode) {\r
    if ((Field->Len + 2) > sizeof (ConfigNvData->TargetUrl)) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    CopyMem (&ConfigNvData->TargetUrl, Field->Str, Field->Len);\r
    ConfigNvData->TargetUrl[Field->Len + 1] = '\0';\r
  } else {\r
    ZeroMem (&ConfigNvData->TargetUrl, sizeof (ConfigNvData->TargetUrl));\r
    Status = IScsiAsciiStrToIp (Field->Str, IpMode, &Ip);\r
    CopyMem (&ConfigNvData->TargetIp, &Ip, sizeof (EFI_IP_ADDRESS));\r
\r
    if (EFI_ERROR (Status)) {\r
      goto ON_EXIT;\r
    }\r
  }\r
\r
  //\r
  // Check the protocol type.\r
  //\r
  Field = &Fields[RP_FIELD_IDX_PROTOCOL];\r
  if ((Field->Str != NULL) && ((*(Field->Str) - '0') != EFI_IP_PROTO_TCP)) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // Get the port of the iSCSI target.\r
  //\r
  Field = &Fields[RP_FIELD_IDX_PORT];\r
  if (Field->Str != NULL) {\r
    ConfigNvData->TargetPort = (UINT16)AsciiStrDecimalToUintn (Field->Str);\r
  } else {\r
    ConfigNvData->TargetPort = ISCSI_WELL_KNOWN_PORT;\r
  }\r
\r
  //\r
  // Get the LUN.\r
  //\r
  Field = &Fields[RP_FIELD_IDX_LUN];\r
  if (Field->Str != NULL) {\r
    Status = IScsiAsciiStrToLun (Field->Str, ConfigNvData->BootLun);\r
    if (EFI_ERROR (Status)) {\r
      goto ON_EXIT;\r
    }\r
  } else {\r
    ZeroMem (ConfigNvData->BootLun, sizeof (ConfigNvData->BootLun));\r
  }\r
\r
  //\r
  // Get the target iSCSI Name.\r
  //\r
  Field = &Fields[RP_FIELD_IDX_TARGETNAME];\r
\r
  if (AsciiStrLen (Field->Str) > ISCSI_NAME_MAX_SIZE - 1) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // Validate the iSCSI name.\r
  //\r
  Status = IScsiNormalizeName (Field->Str, AsciiStrLen (Field->Str));\r
  if (EFI_ERROR (Status)) {\r
    goto ON_EXIT;\r
  }\r
\r
  AsciiStrCpyS (ConfigNvData->TargetName, ISCSI_NAME_MAX_SIZE, Field->Str);\r
\r
ON_EXIT:\r
\r
  FreePool (TmpStr);\r
\r
  return Status;\r
}\r
\r
/**\r
  EFI_DHCP6_INFO_CALLBACK is provided by the consumer of the EFI DHCPv6 Protocol\r
  instance to intercept events that occurs in the DHCPv6 Information Request\r
  exchange process.\r
\r
  @param[in]  This              Pointer to the EFI_DHCP6_PROTOCOL instance that\r
                                is used to configure this  callback function.\r
  @param[in]  Context           Pointer to the context that is initialized in\r
                                the EFI_DHCP6_PROTOCOL.InfoRequest().\r
  @param[in]  Packet            Pointer to Reply packet that has been received.\r
                                The EFI DHCPv6 Protocol instance is responsible\r
                                for freeing the buffer.\r
\r
  @retval EFI_SUCCESS           Tell the EFI DHCPv6 Protocol instance to finish\r
                                Information Request exchange process.\r
  @retval EFI_NOT_READY         Tell the EFI DHCPv6 Protocol instance to continue\r
                                Information Request exchange process.\r
  @retval EFI_ABORTED           Tell the EFI DHCPv6 Protocol instance to abort\r
                                the Information Request exchange process.\r
  @retval EFI_UNSUPPORTED       Tell the EFI DHCPv6 Protocol instance to finish\r
                                the Information Request exchange process because some\r
                                request information are not received.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IScsiDhcp6ParseReply (\r
  IN EFI_DHCP6_PROTOCOL  *This,\r
  IN VOID                *Context,\r
  IN EFI_DHCP6_PACKET    *Packet\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  UINT32                       Index;\r
  UINT32                       OptionCount;\r
  EFI_DHCP6_PACKET_OPTION      *BootFileOpt;\r
  EFI_DHCP6_PACKET_OPTION      **OptionList;\r
  ISCSI_ATTEMPT_CONFIG_NVDATA  *ConfigData;\r
  UINT16                       ParaLen;\r
\r
  OptionCount = 0;\r
  BootFileOpt = NULL;\r
\r
  Status = This->Parse (This, Packet, &OptionCount, NULL);\r
  if (Status != EFI_BUFFER_TOO_SMALL) {\r
    return EFI_NOT_READY;\r
  }\r
\r
  OptionList = AllocateZeroPool (OptionCount * sizeof (EFI_DHCP6_PACKET_OPTION *));\r
  if (OptionList == NULL) {\r
    return EFI_NOT_READY;\r
  }\r
\r
  Status = This->Parse (This, Packet, &OptionCount, OptionList);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_NOT_READY;\r
    goto Exit;\r
  }\r
\r
  ConfigData = (ISCSI_ATTEMPT_CONFIG_NVDATA *)Context;\r
\r
  for (Index = 0; Index < OptionCount; Index++) {\r
    OptionList[Index]->OpCode = NTOHS (OptionList[Index]->OpCode);\r
    OptionList[Index]->OpLen  = NTOHS (OptionList[Index]->OpLen);\r
\r
    //\r
    // Get DNS server addresses from this reply packet.\r
    //\r
    if (OptionList[Index]->OpCode == DHCP6_OPT_DNS_SERVERS) {\r
      if (((OptionList[Index]->OpLen & 0xf) != 0) || (OptionList[Index]->OpLen == 0)) {\r
        Status = EFI_UNSUPPORTED;\r
        goto Exit;\r
      }\r
\r
      //\r
      // Primary DNS server address.\r
      //\r
      CopyMem (&ConfigData->PrimaryDns, &OptionList[Index]->Data[0], sizeof (EFI_IPv6_ADDRESS));\r
\r
      if (OptionList[Index]->OpLen > 16) {\r
        //\r
        // Secondary DNS server address\r
        //\r
        CopyMem (&ConfigData->SecondaryDns, &OptionList[Index]->Data[16], sizeof (EFI_IPv6_ADDRESS));\r
      }\r
    } else if (OptionList[Index]->OpCode == DHCP6_OPT_BOOT_FILE_URL) {\r
      //\r
      // The server sends this option to inform the client about an URL to a boot file.\r
      //\r
      BootFileOpt = OptionList[Index];\r
    } else if (OptionList[Index]->OpCode == DHCP6_OPT_BOOT_FILE_PARAM) {\r
      //\r
      // The server sends this option to inform the client about DHCP6 server address.\r
      //\r
      if (OptionList[Index]->OpLen < 18) {\r
        Status = EFI_UNSUPPORTED;\r
        goto Exit;\r
      }\r
\r
      //\r
      // Check param-len 1, should be 16 bytes.\r
      //\r
      CopyMem (&ParaLen, &OptionList[Index]->Data[0], sizeof (UINT16));\r
      if (NTOHS (ParaLen) != 16) {\r
        Status = EFI_UNSUPPORTED;\r
        goto Exit;\r
      }\r
\r
      CopyMem (&ConfigData->DhcpServer, &OptionList[Index]->Data[2], sizeof (EFI_IPv6_ADDRESS));\r
    }\r
  }\r
\r
  if (BootFileOpt == NULL) {\r
    Status = EFI_UNSUPPORTED;\r
    goto Exit;\r
  }\r
\r
  //\r
  // Get iSCSI root path from Boot File Uniform Resource Locator (URL) Option\r
  //\r
  Status = IScsiDhcp6ExtractRootPath (\r
             (CHAR8 *)BootFileOpt->Data,\r
             BootFileOpt->OpLen,\r
             ConfigData\r
             );\r
\r
Exit:\r
\r
  FreePool (OptionList);\r
  return Status;\r
}\r
\r
/**\r
  Parse the DHCP ACK to get the address configuration and DNS information.\r
\r
  @param[in]       Image         The handle of the driver image.\r
  @param[in]       Controller    The handle of the controller;\r
  @param[in, out]  ConfigData    The attempt configuration data.\r
\r
  @retval EFI_SUCCESS            The DNS information is got from the DHCP ACK.\r
  @retval EFI_NO_MAPPING         DHCP failed to acquire address and other\r
                                 information.\r
  @retval EFI_INVALID_PARAMETER  The DHCP ACK's DNS option is malformatted.\r
  @retval EFI_DEVICE_ERROR       Some unexpected error occurred.\r
  @retval EFI_OUT_OF_RESOURCES   There is no sufficient resource to finish the\r
                                 operation.\r
  @retval EFI_NO_MEDIA           There was a media error.\r
\r
**/\r
EFI_STATUS\r
IScsiDoDhcp6 (\r
  IN     EFI_HANDLE                   Image,\r
  IN     EFI_HANDLE                   Controller,\r
  IN OUT ISCSI_ATTEMPT_CONFIG_NVDATA  *ConfigData\r
  )\r
{\r
  EFI_HANDLE                Dhcp6Handle;\r
  EFI_DHCP6_PROTOCOL        *Dhcp6;\r
  EFI_STATUS                Status;\r
  EFI_STATUS                TimerStatus;\r
  EFI_DHCP6_PACKET_OPTION   *Oro;\r
  EFI_DHCP6_RETRANSMISSION  InfoReqReXmit;\r
  EFI_EVENT                 Timer;\r
  EFI_STATUS                MediaStatus;\r
\r
  //\r
  // Check media status before doing DHCP.\r
  //\r
  MediaStatus = EFI_SUCCESS;\r
  NetLibDetectMediaWaitTimeout (Controller, ISCSI_CHECK_MEDIA_GET_DHCP_WAITING_TIME, &MediaStatus);\r
  if (MediaStatus != EFI_SUCCESS) {\r
    AsciiPrint ("\n  Error: Could not detect network connection.\n");\r
    return EFI_NO_MEDIA;\r
  }\r
\r
  //\r
  // iSCSI will only request target info from DHCPv6 server.\r
  //\r
  if (!ConfigData->SessionConfigData.TargetInfoFromDhcp) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Dhcp6Handle = NULL;\r
  Dhcp6       = NULL;\r
  Oro         = NULL;\r
  Timer       = NULL;\r
\r
  //\r
  // Create a DHCP6 child instance and get the protocol.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             Controller,\r
             Image,\r
             &gEfiDhcp6ServiceBindingProtocolGuid,\r
             &Dhcp6Handle\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Dhcp6Handle,\r
                  &gEfiDhcp6ProtocolGuid,\r
                  (VOID **)&Dhcp6,\r
                  Image,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_EXIT;\r
  }\r
\r
  Oro = AllocateZeroPool (sizeof (EFI_DHCP6_PACKET_OPTION) + 5);\r
  if (Oro == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // Ask the server to reply with DNS and Boot File URL options by info request.\r
  // All members in EFI_DHCP6_PACKET_OPTION are in network order.\r
  //\r
  Oro->OpCode  = HTONS (DHCP6_OPT_ORO);\r
  Oro->OpLen   = HTONS (2 * 3);\r
  Oro->Data[1] = DHCP6_OPT_DNS_SERVERS;\r
  Oro->Data[3] = DHCP6_OPT_BOOT_FILE_URL;\r
  Oro->Data[5] = DHCP6_OPT_BOOT_FILE_PARAM;\r
\r
  InfoReqReXmit.Irt = 4;\r
  InfoReqReXmit.Mrc = 1;\r
  InfoReqReXmit.Mrt = 10;\r
  InfoReqReXmit.Mrd = 30;\r
\r
  Status = Dhcp6->InfoRequest (\r
                    Dhcp6,\r
                    TRUE,\r
                    Oro,\r
                    0,\r
                    NULL,\r
                    &InfoReqReXmit,\r
                    NULL,\r
                    IScsiDhcp6ParseReply,\r
                    ConfigData\r
                    );\r
  if (Status == EFI_NO_MAPPING) {\r
    Status = gBS->CreateEvent (EVT_TIMER, TPL_CALLBACK, NULL, NULL, &Timer);\r
    if (EFI_ERROR (Status)) {\r
      goto ON_EXIT;\r
    }\r
\r
    Status = gBS->SetTimer (\r
                    Timer,\r
                    TimerRelative,\r
                    ISCSI_GET_MAPPING_TIMEOUT\r
                    );\r
\r
    if (EFI_ERROR (Status)) {\r
      goto ON_EXIT;\r
    }\r
\r
    do {\r
      TimerStatus = gBS->CheckEvent (Timer);\r
\r
      if (!EFI_ERROR (TimerStatus)) {\r
        Status = Dhcp6->InfoRequest (\r
                          Dhcp6,\r
                          TRUE,\r
                          Oro,\r
                          0,\r
                          NULL,\r
                          &InfoReqReXmit,\r
                          NULL,\r
                          IScsiDhcp6ParseReply,\r
                          ConfigData\r
                          );\r
      }\r
    } while (TimerStatus == EFI_NOT_READY);\r
  }\r
\r
ON_EXIT:\r
\r
  if (Oro != NULL) {\r
    FreePool (Oro);\r
  }\r
\r
  if (Timer != NULL) {\r
    gBS->CloseEvent (Timer);\r
  }\r
\r
  if (Dhcp6 != NULL) {\r
    gBS->CloseProtocol (\r
           Dhcp6Handle,\r
           &gEfiDhcp6ProtocolGuid,\r
           Image,\r
           Controller\r
           );\r
  }\r
\r
  NetLibDestroyServiceChild (\r
    Controller,\r
    Image,\r
    &gEfiDhcp6ServiceBindingProtocolGuid,\r
    Dhcp6Handle\r
    );\r
\r
  return Status;\r
}\r