[PATCH V3 5/5] RedfishPkg: Fix compile issue on Linux

[PATCH V3 5/5] RedfishPkg: Fix compile issue on Linux

[Minh Nguyen]

From: Vu Nguyen <vunguyen@os.amperecomputing.com>

It requires a fixed size array to store the content of device path PCD.
Add the array size to solve this issue.

Signed-off-by: Minh Nguyen <minhnguyen1@os.amperecomputing.com>
Cc: Abner Chang <abner.chang@amd.com>
Cc: Igor Kulchytskyy <igork@ami.com>
Cc: Nick Ramirez <nramirez@nvidia.com>
Reviewed-by: Abner Chang <Abner.Chang@amd.com>
---
 RedfishPkg/Include/Pcd/RestExServiceDevicePath.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/RedfishPkg/Include/Pcd/RestExServiceDevicePath.h b/RedfishPkg/Include/Pcd/RestExServiceDevicePath.h
index 91b1198297c2..57fc199f61f2 100644
--- a/RedfishPkg/Include/Pcd/RestExServiceDevicePath.h
+++ b/RedfishPkg/Include/Pcd/RestExServiceDevicePath.h
@@ -4,6 +4,7 @@
 
   Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
   (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
+  Copyright (c) 2023, Ampere Computing LLC. All rights reserved.<BR>
 
     SPDX-License-Identifier: BSD-2-Clause-Patent
 
@@ -14,6 +15,8 @@
 
 #include <Protocol/DevicePath.h>
 
+#define MAX_DEVICE_PATH_NODE      40
+
 typedef enum {
   DEVICE_PATH_MATCH_MAC_NODE = 1,
   DEVICE_PATH_MATCH_PCI_NODE = 2,
@@ -32,7 +35,7 @@ typedef struct {
   //    0x03,0x0b,0x25,0x00,0x00,0x50,0x56,0xc0,0x00,0x02,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x01,
   //    0x7f,0xff,0x04,0x00}
   //
-  EFI_DEVICE_PATH_PROTOCOL    DevicePath[];
+  EFI_DEVICE_PATH_PROTOCOL      DevicePath[MAX_DEVICE_PATH_NODE];
 } REST_EX_SERVICE_DEVICE_PATH_DATA;
 
 #endif
-- 
2.39.0

[PATCH V3 0/5] Adding necessary changes for RedfishPkg

[minhnampere]

This patchset adds necessary changes for RedfishPkg to avoid some unexpected cases and fix compilation.

Changes since v3:
 + Replaced __FUNCTION__ with __func__ to be more C11 compliant.
Changes since v2:
 + Added "Cc:" to maintainers in commit message.
 + Corrected patch format subject prefix.
Changes since v1:
 + Removed redundant change and change the commit message for more precise in PATCH 2/5.

Nhi Pham (1):
  RedfishPkg: Add missing newline character

Vu Nguyen (4):
  RedfishPkg: Correct variable type to prevent memory corruption
  RedfishPkg: Fix condition checking of error status
  RedfishPkg: Create RestEx child on selected interface
  RedfishPkg: Fix compile issue on Linux

 RedfishPkg/Include/Library/RestExLib.h                       |   3 +
 RedfishPkg/Include/Pcd/RestExServiceDevicePath.h             |   5 +-
 RedfishPkg/RedfishRestExDxe/RedfishRestExDriver.h            |   3 +-
 RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c               | 153 ++++++++------------
 RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c           |   4 +-
 RedfishPkg/RedfishHostInterfaceDxe/RedfishHostInterfaceDxe.c |   3 +-
 6 files changed, 73 insertions(+), 98 deletions(-)

-- 
2.39.0

[PATCH V3 1/5] RedfishPkg: Correct variable type to prevent memory corruption

[minhnampere]

From: Vu Nguyen <vunguyen@os.amperecomputing.com>

Id will be casted by CoreOpenProtocol, declare this variable with a
wrong type might result in the corruption of other local variables.

Signed-off-by: Minh Nguyen <minhnguyen1@os.amperecomputing.com>
Cc: Abner Chang <abner.chang@amd.com>
Cc: Igor Kulchytskyy <igork@ami.com>
Cc: Nick Ramirez <nramirez@nvidia.com>
Reviewed-by: Nickle Wang <nicklew@nvidia.com>
---
 RedfishPkg/RedfishRestExDxe/RedfishRestExDriver.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/RedfishPkg/RedfishRestExDxe/RedfishRestExDriver.h b/RedfishPkg/RedfishRestExDxe/RedfishRestExDriver.h
index 4a9e9f7b81a4..6b94e5814c43 100644
--- a/RedfishPkg/RedfishRestExDxe/RedfishRestExDriver.h
+++ b/RedfishPkg/RedfishRestExDxe/RedfishRestExDriver.h
@@ -3,6 +3,7 @@
 
   Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
   (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
+  Copyright (c) 2023, Ampere Computing LLC. All rights reserved.<BR>
 
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
@@ -84,7 +85,7 @@ struct _RESTEX_SERVICE {
   //
   EFI_HANDLE                      HttpChildHandle;
 
-  UINT32                          Id;
+  UINT32                          *Id;
 
   EFI_REST_EX_SERVICE_INFO        RestExServiceInfo;
 };
-- 
2.39.0

[PATCH V3 2/5] RedfishPkg: Fix condition checking of error status

[minhnampere]

From: Vu Nguyen <vunguyen@os.amperecomputing.com>

This change fixes condition checking of error status, the condition
should be compared with TRUE status to be identical with an error message.

Signed-off-by: Minh Nguyen <minhnguyen1@os.amperecomputing.com>
Cc: Abner Chang <abner.chang@amd.com>
Cc: Igor Kulchytskyy <igork@ami.com>
Cc: Nick Ramirez <nramirez@nvidia.com>
Reviewed-by: Nickle Wang <nicklew@nvidia.com>
---
 RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c b/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c
index 0900a2479e7b..14702748813b 100644
--- a/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c
+++ b/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c
@@ -5,6 +5,7 @@
   (C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
   Copyright (c) 2022, AMD Incorporated. All rights reserved.
   Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+  Copyright (c) 2023, Ampere Computing LLC. All rights reserved.<BR>
 
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
@@ -926,7 +927,7 @@ AddAndSignalNewRedfishService (
     }
 
     Status = gBS->SignalEvent (Instance->DiscoverToken->Event);
-    if (!EFI_ERROR (Status)) {
+    if (EFI_ERROR (Status)) {
       DEBUG ((DEBUG_ERROR, "%a:No event to signal!\n", __func__));
     }
   }
-- 
2.39.0

[PATCH V3 3/5] RedfishPkg: Create RestEx child on selected interface

[minhnampere]

From: Vu Nguyen <vunguyen@os.amperecomputing.com>

When a MAC address matching interface is found, a RestEx child will be
created to provide the Redfish communication on that interface.
Currently, It will try to locate all RestEx binding services and choose
the first satisfied instance without taking care about current selected
interface. This might raise an issue on the system with multiple network
devices that the RestEx child was installed on wrong interface.

Signed-off-by: Minh Nguyen <minhnguyen1@os.amperecomputing.com>
Cc: Abner Chang <abner.chang@amd.com>
Cc: Igor Kulchytskyy <igork@ami.com>
Cc: Nick Ramirez <nramirez@nvidia.com>
---
 RedfishPkg/Include/Library/RestExLib.h             |   3 +
 RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c     | 153 ++++++++------------
 RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c |   1 +
 3 files changed, 63 insertions(+), 94 deletions(-)

diff --git a/RedfishPkg/Include/Library/RestExLib.h b/RedfishPkg/Include/Library/RestExLib.h
index bc4e4ca6caa7..2c32c3684cf4 100644
--- a/RedfishPkg/Include/Library/RestExLib.h
+++ b/RedfishPkg/Include/Library/RestExLib.h
@@ -2,6 +2,7 @@
   This library provides help functions for REST EX Protocol.
 
   (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
+  Copyright (c) 2023, Ampere Computing LLC. All rights reserved.<BR>
 
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
@@ -20,6 +21,7 @@
   This function allows the caller to create child handle for specific
   REST server.
 
+  @param[in]  Controller           The controller handle used of selected interface.
   @param[in]  Image                The image handle used to open service.
   @param[in]  AccessMode           Access mode of REST server.
   @param[in]  ConfigType           Underlying configuration to communicate with REST server.
@@ -32,6 +34,7 @@
 **/
 EFI_STATUS
 RestExLibCreateChild (
+  IN EFI_HANDLE                       Controller,
   IN EFI_HANDLE                       Image,
   IN EFI_REST_EX_SERVICE_ACCESS_MODE  AccessMode,
   IN EFI_REST_EX_CONFIG_TYPE          ConfigType,
diff --git a/RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c b/RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c
index d9acad24dec1..0b3ae2755e86 100644
--- a/RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c
+++ b/RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c
@@ -2,6 +2,7 @@
   This library provides help functions for REST EX Protocol.
 
   (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
+  Copyright (c) 2023, Ampere Computing LLC. All rights reserved.<BR>
 
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
@@ -9,6 +10,7 @@
 
 #include <Uefi.h>
 #include <Library/BaseMemoryLib.h>
+#include <Library/DebugLib.h>
 #include <Library/MemoryAllocationLib.h>
 #include <Library/NetLib.h>
 #include <Library/UefiBootServicesTableLib.h>
@@ -21,6 +23,7 @@
   This function allows the caller to create child handle for specific
   REST server.
 
+  @param[in]  Controller           The controller handle used of selected interface.
   @param[in]  Image                The image handle used to open service.
   @param[in]  AccessMode           Access mode of REST server.
   @param[in]  ConfigType           Underlying configuration to communicate with REST server.
@@ -33,6 +36,7 @@
 **/
 EFI_STATUS
 RestExLibCreateChild (
+  IN EFI_HANDLE                       Controller,
   IN EFI_HANDLE                       Image,
   IN EFI_REST_EX_SERVICE_ACCESS_MODE  AccessMode,
   IN EFI_REST_EX_CONFIG_TYPE          ConfigType,
@@ -41,8 +45,6 @@ RestExLibCreateChild (
   )
 {
   EFI_STATUS                Status;
-  UINTN                     NoBuffer;
-  EFI_HANDLE                *Handle;
   EFI_HANDLE                ChildHandle;
   EFI_REST_EX_PROTOCOL      *RestEx;
   EFI_REST_EX_SERVICE_INFO  *RestExServiceInfo;
@@ -59,116 +61,79 @@ RestExLibCreateChild (
   }
 
   *ChildInstanceHandle = NULL;
-  //
-  // Locate all REST EX binding service.
-  //
-  Handle   = NULL;
-  NoBuffer = 0;
-  Status   = gBS->LocateHandleBuffer (
-                    ByProtocol,
-                    &gEfiRestExServiceBindingProtocolGuid,
-                    NULL,
-                    &NoBuffer,
-                    &Handle
-                    );
-  if (EFI_ERROR (Status) && (Status != EFI_BUFFER_TOO_SMALL)) {
+
+  ChildHandle = NULL;
+  Status = NetLibCreateServiceChild (
+             Controller,
+             Image,
+             &gEfiRestExServiceBindingProtocolGuid,
+             &ChildHandle
+             );
+  if (EFI_ERROR (Status)) {
+    DEBUG ((
+      DEBUG_ERROR,
+      "%a: Failed to create service child - %r \n",
+      __func__,
+      Status
+      ));
     return Status;
   }
-
-  Handle = (EFI_HANDLE *)AllocateZeroPool (sizeof (EFI_HANDLE) * NoBuffer);
-  if (Handle == NULL) {
-    return EFI_OUT_OF_RESOURCES;
-  }
-
-  Status = gBS->LocateHandleBuffer (
-                  ByProtocol,
-                  &gEfiRestExServiceBindingProtocolGuid,
+  Status = gBS->OpenProtocol (
+                  ChildHandle,
+                  &gEfiRestExProtocolGuid,
+                  (VOID **)&RestEx,
+                  Image,
                   NULL,
-                  &NoBuffer,
-                  &Handle
+                  EFI_OPEN_PROTOCOL_GET_PROTOCOL
                   );
   if (EFI_ERROR (Status)) {
-    FreePool (Handle);
-    return Status;
+    goto ON_ERROR;
   }
 
   //
-  // Search for the proper REST EX instance.
+  // Get the information of REST service provided by this EFI REST EX driver
   //
-  while (NoBuffer != 0) {
-    ChildHandle = NULL;
-    Status      = NetLibCreateServiceChild (
-                    *(Handle + (NoBuffer - 1)),
-                    Image,
-                    &gEfiRestExServiceBindingProtocolGuid,
-                    &ChildHandle
-                    );
-    if (!EFI_ERROR (Status)) {
-      Status = gBS->OpenProtocol (
-                      ChildHandle,
-                      &gEfiRestExProtocolGuid,
-                      (VOID **)&RestEx,
-                      Image,
-                      NULL,
-                      EFI_OPEN_PROTOCOL_GET_PROTOCOL
-                      );
-      if (EFI_ERROR (Status)) {
-        goto ON_ERROR;
-      }
-
-      //
-      // Get the information of REST service provided by this EFI REST EX driver
-      //
-      Status = RestEx->GetService (
-                         RestEx,
-                         &RestExServiceInfo
-                         );
-      if (EFI_ERROR (Status)) {
-        goto ON_ERROR;
-      }
-
-      //
-      // Check REST EX property.
-      //
-      switch (ConfigType) {
-        case EfiRestExConfigHttp:
-          LenOfConfig = sizeof (EFI_REST_EX_HTTP_CONFIG_DATA);
-          break;
-
-        case EfiRestExConfigUnspecific:
-          LenOfConfig = REST_EX_CONFIG_DATA_LEN_UNKNOWN;
-          break;
+  Status = RestEx->GetService (
+                     RestEx,
+                     &RestExServiceInfo
+                     );
+  if (EFI_ERROR (Status)) {
+    goto ON_ERROR;
+  }
+  //
+  // Check REST EX property.
+  //
+  switch (ConfigType) {
+  case EfiRestExConfigHttp:
+    LenOfConfig = sizeof (EFI_REST_EX_HTTP_CONFIG_DATA);
+    break;
 
-        default:
-          goto ON_ERROR;
-      }
+  case EfiRestExConfigUnspecific:
+    LenOfConfig = REST_EX_CONFIG_DATA_LEN_UNKNOWN;
+    break;
 
-      if ((RestExServiceInfo->EfiRestExServiceInfoV10.RestServiceAccessMode != AccessMode) ||
-          (RestExServiceInfo->EfiRestExServiceInfoV10.RestServiceType != ServiceType) ||
-          (RestExServiceInfo->EfiRestExServiceInfoV10.RestExConfigType != ConfigType) ||
-          ((LenOfConfig != REST_EX_CONFIG_DATA_LEN_UNKNOWN) && (RestExServiceInfo->EfiRestExServiceInfoV10.RestExConfigDataLength != LenOfConfig)))
-      {
-        goto ON_ERROR;
-      }
-    }
+  default:
+    goto ON_ERROR;
+  }
+  if (RestExServiceInfo->EfiRestExServiceInfoV10.RestServiceAccessMode != AccessMode ||
+      RestExServiceInfo->EfiRestExServiceInfoV10.RestServiceType != ServiceType ||
+      RestExServiceInfo->EfiRestExServiceInfoV10.RestExConfigType != ConfigType ||
+      ((LenOfConfig != REST_EX_CONFIG_DATA_LEN_UNKNOWN) && (RestExServiceInfo->EfiRestExServiceInfoV10.RestExConfigDataLength != LenOfConfig))) {
+    goto ON_ERROR;
+  }
 
-    //
-    // This is proper REST EX instance.
-    //
-    *ChildInstanceHandle = ChildHandle;
-    FreePool (Handle);
-    return EFI_SUCCESS;
+  //
+  // This is proper REST EX instance.
+  //
+  *ChildInstanceHandle = ChildHandle;
+  return EFI_SUCCESS;
 
 ON_ERROR:;
     NetLibDestroyServiceChild (
-      *(Handle + (NoBuffer - 1)),
+      Controller,
       Image,
       &gEfiRestExServiceBindingProtocolGuid,
       ChildHandle
       );
-    NoBuffer--;
-  }
-
-  FreePool (Handle);
   return EFI_NOT_FOUND;
 }
diff --git a/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c b/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c
index 14702748813b..0b86a7b5cc4b 100644
--- a/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c
+++ b/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c
@@ -87,6 +87,7 @@ CreateRestExInstance (
   EFI_STATUS  Status;
 
   Status = RestExLibCreateChild (
+             Instance->NetworkInterface->OpenDriverControllerHandle,
              Instance->Owner,
              FixedPcdGetBool (PcdRedfishDiscoverAccessModeInBand) ? EfiRestExServiceInBandAccess : EfiRestExServiceOutOfBandAccess,
              EfiRestExConfigHttp,
-- 
2.39.0

[PATCH V3 4/5] RedfishPkg: Add missing newline character

[minhnampere]

From: Nhi Pham <nhi@os.amperecomputing.com>

This adds a missing newline character to make the error log
readable in case the module is failed.

Signed-off-by: Minh Nguyen <minhnguyen1@os.amperecomputing.com>
Cc: Abner Chang <abner.chang@amd.com>
Cc: Igor Kulchytskyy <igork@ami.com>
Cc: Nick Ramirez <nramirez@nvidia.com>
Reviewed-by: Nickle Wang <nicklew@nvidia.com>
---
 RedfishPkg/RedfishHostInterfaceDxe/RedfishHostInterfaceDxe.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/RedfishPkg/RedfishHostInterfaceDxe/RedfishHostInterfaceDxe.c b/RedfishPkg/RedfishHostInterfaceDxe/RedfishHostInterfaceDxe.c
index 45fc6e2182bc..c4fa59193a2f 100644
--- a/RedfishPkg/RedfishHostInterfaceDxe/RedfishHostInterfaceDxe.c
+++ b/RedfishPkg/RedfishHostInterfaceDxe/RedfishHostInterfaceDxe.c
@@ -8,6 +8,7 @@
   (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
   Copyright (C) 2022 Advanced Micro Devices, Inc. All rights reserved.<BR>
   Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+  Copyright (c) 2023, Ampere Computing LLC. All rights reserved.<BR>
 
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
@@ -59,7 +60,7 @@ RedfishCreateSmbiosTable42 (
   Status = RedfishPlatformHostInterfaceDeviceDescriptor (&DeviceType, &DeviceDescriptor);
   if (EFI_ERROR (Status)) {
     if (Status == EFI_NOT_FOUND) {
-      DEBUG ((DEBUG_ERROR, "%a: No Redfish host interface descriptor is provided on this platform.", __func__));
+      DEBUG ((DEBUG_ERROR, "%a: No Redfish host interface descriptor is provided on this platform.\n", __func__));
       return EFI_NOT_FOUND;
     }
 
-- 
2.39.0

[PATCH V3 5/5] RedfishPkg: Fix compile issue on Linux

[minhnampere]

From: Vu Nguyen <vunguyen@os.amperecomputing.com>

It requires a fixed size array to store the content of device path PCD.
Add the array size to solve this issue.

Signed-off-by: Minh Nguyen <minhnguyen1@os.amperecomputing.com>
Cc: Abner Chang <abner.chang@amd.com>
Cc: Igor Kulchytskyy <igork@ami.com>
Cc: Nick Ramirez <nramirez@nvidia.com>
Reviewed-by: Abner Chang <Abner.Chang@amd.com>
---
 RedfishPkg/Include/Pcd/RestExServiceDevicePath.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/RedfishPkg/Include/Pcd/RestExServiceDevicePath.h b/RedfishPkg/Include/Pcd/RestExServiceDevicePath.h
index 91b1198297c2..57fc199f61f2 100644
--- a/RedfishPkg/Include/Pcd/RestExServiceDevicePath.h
+++ b/RedfishPkg/Include/Pcd/RestExServiceDevicePath.h
@@ -4,6 +4,7 @@
 
   Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
   (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
+  Copyright (c) 2023, Ampere Computing LLC. All rights reserved.<BR>
 
     SPDX-License-Identifier: BSD-2-Clause-Patent
 
@@ -14,6 +15,8 @@
 
 #include <Protocol/DevicePath.h>
 
+#define MAX_DEVICE_PATH_NODE      40
+
 typedef enum {
   DEVICE_PATH_MATCH_MAC_NODE = 1,
   DEVICE_PATH_MATCH_PCI_NODE = 2,
@@ -32,7 +35,7 @@ typedef struct {
   //    0x03,0x0b,0x25,0x00,0x00,0x50,0x56,0xc0,0x00,0x02,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x01,
   //    0x7f,0xff,0x04,0x00}
   //
-  EFI_DEVICE_PATH_PROTOCOL    DevicePath[];
+  EFI_DEVICE_PATH_PROTOCOL      DevicePath[MAX_DEVICE_PATH_NODE];
 } REST_EX_SERVICE_DEVICE_PATH_DATA;
 
 #endif
-- 
2.39.0

Re: [PATCH V3 3/5] RedfishPkg: Create RestEx child on selected interface

[Chang, Abner]

[AMD Official Use Only - General]

Thanks Minh,

Reviewed-by: Abner Chang <Abner.Chang@amd.com>

> -----Original Message-----
> From: minhnampere <minhnguyen1@os.amperecomputing.com>
> Sent: Friday, May 5, 2023 2:46 PM
> To: devel@edk2.groups.io
> Cc: patches@amperecomputing.com; Chang, Abner
> <Abner.Chang@amd.com>; nicklew@nvidia.com; igork@ami.com;
> nhi@os.amperecomputing.com; tinhnguyen@os.amperecomputing.com; Vu
> Nguyen <vunguyen@os.amperecomputing.com>; Minh Nguyen
> <minhnguyen1@os.amperecomputing.com>; Nick Ramirez
> <nramirez@nvidia.com>
> Subject: [PATCH V3 3/5] RedfishPkg: Create RestEx child on selected
> interface
> 
> Caution: This message originated from an External Source. Use proper
> caution when opening attachments, clicking links, or responding.
> 
> 
> From: Vu Nguyen <vunguyen@os.amperecomputing.com>
> 
> When a MAC address matching interface is found, a RestEx child will be
> created to provide the Redfish communication on that interface.
> Currently, It will try to locate all RestEx binding services and choose the first
> satisfied instance without taking care about current selected interface. This
> might raise an issue on the system with multiple network devices that the
> RestEx child was installed on wrong interface.
> 
> Signed-off-by: Minh Nguyen <minhnguyen1@os.amperecomputing.com>
> Cc: Abner Chang <abner.chang@amd.com>
> Cc: Igor Kulchytskyy <igork@ami.com>
> Cc: Nick Ramirez <nramirez@nvidia.com>
> ---
>  RedfishPkg/Include/Library/RestExLib.h             |   3 +
>  RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c     | 153 ++++++++----------
> --
>  RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c |   1 +
>  3 files changed, 63 insertions(+), 94 deletions(-)
> 
> diff --git a/RedfishPkg/Include/Library/RestExLib.h
> b/RedfishPkg/Include/Library/RestExLib.h
> index bc4e4ca6caa7..2c32c3684cf4 100644
> --- a/RedfishPkg/Include/Library/RestExLib.h
> +++ b/RedfishPkg/Include/Library/RestExLib.h
> @@ -2,6 +2,7 @@
>    This library provides help functions for REST EX Protocol.
> 
>    (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
> +  Copyright (c) 2023, Ampere Computing LLC. All rights reserved.<BR>
> 
>    SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> @@ -20,6 +21,7 @@
>    This function allows the caller to create child handle for specific
>    REST server.
> 
> +  @param[in]  Controller           The controller handle used of selected
> interface.
>    @param[in]  Image                The image handle used to open service.
>    @param[in]  AccessMode           Access mode of REST server.
>    @param[in]  ConfigType           Underlying configuration to communicate
> with REST server.
> @@ -32,6 +34,7 @@
>  **/
>  EFI_STATUS
>  RestExLibCreateChild (
> +  IN EFI_HANDLE                       Controller,
>    IN EFI_HANDLE                       Image,
>    IN EFI_REST_EX_SERVICE_ACCESS_MODE  AccessMode,
>    IN EFI_REST_EX_CONFIG_TYPE          ConfigType,
> diff --git a/RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c
> b/RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c
> index d9acad24dec1..0b3ae2755e86 100644
> --- a/RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c
> +++ b/RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c
> @@ -2,6 +2,7 @@
>    This library provides help functions for REST EX Protocol.
> 
>    (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
> +  Copyright (c) 2023, Ampere Computing LLC. All rights reserved.<BR>
> 
>    SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> @@ -9,6 +10,7 @@
> 
>  #include <Uefi.h>
>  #include <Library/BaseMemoryLib.h>
> +#include <Library/DebugLib.h>
>  #include <Library/MemoryAllocationLib.h>  #include <Library/NetLib.h>
> #include <Library/UefiBootServicesTableLib.h>
> @@ -21,6 +23,7 @@
>    This function allows the caller to create child handle for specific
>    REST server.
> 
> +  @param[in]  Controller           The controller handle used of selected
> interface.
>    @param[in]  Image                The image handle used to open service.
>    @param[in]  AccessMode           Access mode of REST server.
>    @param[in]  ConfigType           Underlying configuration to communicate
> with REST server.
> @@ -33,6 +36,7 @@
>  **/
>  EFI_STATUS
>  RestExLibCreateChild (
> +  IN EFI_HANDLE                       Controller,
>    IN EFI_HANDLE                       Image,
>    IN EFI_REST_EX_SERVICE_ACCESS_MODE  AccessMode,
>    IN EFI_REST_EX_CONFIG_TYPE          ConfigType,
> @@ -41,8 +45,6 @@ RestExLibCreateChild (
>    )
>  {
>    EFI_STATUS                Status;
> -  UINTN                     NoBuffer;
> -  EFI_HANDLE                *Handle;
>    EFI_HANDLE                ChildHandle;
>    EFI_REST_EX_PROTOCOL      *RestEx;
>    EFI_REST_EX_SERVICE_INFO  *RestExServiceInfo; @@ -59,116 +61,79 @@
> RestExLibCreateChild (
>    }
> 
>    *ChildInstanceHandle = NULL;
> -  //
> -  // Locate all REST EX binding service.
> -  //
> -  Handle   = NULL;
> -  NoBuffer = 0;
> -  Status   = gBS->LocateHandleBuffer (
> -                    ByProtocol,
> -                    &gEfiRestExServiceBindingProtocolGuid,
> -                    NULL,
> -                    &NoBuffer,
> -                    &Handle
> -                    );
> -  if (EFI_ERROR (Status) && (Status != EFI_BUFFER_TOO_SMALL)) {
> +
> +  ChildHandle = NULL;
> +  Status = NetLibCreateServiceChild (
> +             Controller,
> +             Image,
> +             &gEfiRestExServiceBindingProtocolGuid,
> +             &ChildHandle
> +             );
> +  if (EFI_ERROR (Status)) {
> +    DEBUG ((
> +      DEBUG_ERROR,
> +      "%a: Failed to create service child - %r \n",
> +      __func__,
> +      Status
> +      ));
>      return Status;
>    }
> -
> -  Handle = (EFI_HANDLE *)AllocateZeroPool (sizeof (EFI_HANDLE) *
> NoBuffer);
> -  if (Handle == NULL) {
> -    return EFI_OUT_OF_RESOURCES;
> -  }
> -
> -  Status = gBS->LocateHandleBuffer (
> -                  ByProtocol,
> -                  &gEfiRestExServiceBindingProtocolGuid,
> +  Status = gBS->OpenProtocol (
> +                  ChildHandle,
> +                  &gEfiRestExProtocolGuid,
> +                  (VOID **)&RestEx,
> +                  Image,
>                    NULL,
> -                  &NoBuffer,
> -                  &Handle
> +                  EFI_OPEN_PROTOCOL_GET_PROTOCOL
>                    );
>    if (EFI_ERROR (Status)) {
> -    FreePool (Handle);
> -    return Status;
> +    goto ON_ERROR;
>    }
> 
>    //
> -  // Search for the proper REST EX instance.
> +  // Get the information of REST service provided by this EFI REST EX
> + driver
>    //
> -  while (NoBuffer != 0) {
> -    ChildHandle = NULL;
> -    Status      = NetLibCreateServiceChild (
> -                    *(Handle + (NoBuffer - 1)),
> -                    Image,
> -                    &gEfiRestExServiceBindingProtocolGuid,
> -                    &ChildHandle
> -                    );
> -    if (!EFI_ERROR (Status)) {
> -      Status = gBS->OpenProtocol (
> -                      ChildHandle,
> -                      &gEfiRestExProtocolGuid,
> -                      (VOID **)&RestEx,
> -                      Image,
> -                      NULL,
> -                      EFI_OPEN_PROTOCOL_GET_PROTOCOL
> -                      );
> -      if (EFI_ERROR (Status)) {
> -        goto ON_ERROR;
> -      }
> -
> -      //
> -      // Get the information of REST service provided by this EFI REST EX driver
> -      //
> -      Status = RestEx->GetService (
> -                         RestEx,
> -                         &RestExServiceInfo
> -                         );
> -      if (EFI_ERROR (Status)) {
> -        goto ON_ERROR;
> -      }
> -
> -      //
> -      // Check REST EX property.
> -      //
> -      switch (ConfigType) {
> -        case EfiRestExConfigHttp:
> -          LenOfConfig = sizeof (EFI_REST_EX_HTTP_CONFIG_DATA);
> -          break;
> -
> -        case EfiRestExConfigUnspecific:
> -          LenOfConfig = REST_EX_CONFIG_DATA_LEN_UNKNOWN;
> -          break;
> +  Status = RestEx->GetService (
> +                     RestEx,
> +                     &RestExServiceInfo
> +                     );
> +  if (EFI_ERROR (Status)) {
> +    goto ON_ERROR;
> +  }
> +  //
> +  // Check REST EX property.
> +  //
> +  switch (ConfigType) {
> +  case EfiRestExConfigHttp:
> +    LenOfConfig = sizeof (EFI_REST_EX_HTTP_CONFIG_DATA);
> +    break;
> 
> -        default:
> -          goto ON_ERROR;
> -      }
> +  case EfiRestExConfigUnspecific:
> +    LenOfConfig = REST_EX_CONFIG_DATA_LEN_UNKNOWN;
> +    break;
> 
> -      if ((RestExServiceInfo-
> >EfiRestExServiceInfoV10.RestServiceAccessMode != AccessMode) ||
> -          (RestExServiceInfo->EfiRestExServiceInfoV10.RestServiceType !=
> ServiceType) ||
> -          (RestExServiceInfo->EfiRestExServiceInfoV10.RestExConfigType !=
> ConfigType) ||
> -          ((LenOfConfig != REST_EX_CONFIG_DATA_LEN_UNKNOWN) &&
> (RestExServiceInfo->EfiRestExServiceInfoV10.RestExConfigDataLength !=
> LenOfConfig)))
> -      {
> -        goto ON_ERROR;
> -      }
> -    }
> +  default:
> +    goto ON_ERROR;
> +  }
> +  if (RestExServiceInfo->EfiRestExServiceInfoV10.RestServiceAccessMode !=
> AccessMode ||
> +      RestExServiceInfo->EfiRestExServiceInfoV10.RestServiceType !=
> ServiceType ||
> +      RestExServiceInfo->EfiRestExServiceInfoV10.RestExConfigType !=
> ConfigType ||
> +      ((LenOfConfig != REST_EX_CONFIG_DATA_LEN_UNKNOWN) &&
> (RestExServiceInfo->EfiRestExServiceInfoV10.RestExConfigDataLength !=
> LenOfConfig))) {
> +    goto ON_ERROR;
> +  }
> 
> -    //
> -    // This is proper REST EX instance.
> -    //
> -    *ChildInstanceHandle = ChildHandle;
> -    FreePool (Handle);
> -    return EFI_SUCCESS;
> +  //
> +  // This is proper REST EX instance.
> +  //
> +  *ChildInstanceHandle = ChildHandle;
> +  return EFI_SUCCESS;
> 
>  ON_ERROR:;
>      NetLibDestroyServiceChild (
> -      *(Handle + (NoBuffer - 1)),
> +      Controller,
>        Image,
>        &gEfiRestExServiceBindingProtocolGuid,
>        ChildHandle
>        );
> -    NoBuffer--;
> -  }
> -
> -  FreePool (Handle);
>    return EFI_NOT_FOUND;
>  }
> diff --git a/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c
> b/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c
> index 14702748813b..0b86a7b5cc4b 100644
> --- a/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c
> +++ b/RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c
> @@ -87,6 +87,7 @@ CreateRestExInstance (
>    EFI_STATUS  Status;
> 
>    Status = RestExLibCreateChild (
> +             Instance->NetworkInterface->OpenDriverControllerHandle,
>               Instance->Owner,
>               FixedPcdGetBool (PcdRedfishDiscoverAccessModeInBand) ?
> EfiRestExServiceInBandAccess : EfiRestExServiceOutOfBandAccess,
>               EfiRestExConfigHttp,
> --
> 2.39.0

Re: [PATCH V3 0/5] Adding necessary changes for RedfishPkg

[Chang, Abner]

[AMD Official Use Only - General]

Hi Minh,
Please add my RB for 3/5 in commit message and push to minhnampere:Adding_necessary_changes_for_RedfishPkg again.   I will check the PR and merge it once it passes CI.

Thank for your contribution.
Abner

> -----Original Message-----
> From: minhnampere <minhnguyen1@os.amperecomputing.com>
> Sent: Friday, May 5, 2023 2:46 PM
> To: devel@edk2.groups.io
> Cc: patches@amperecomputing.com; Chang, Abner
> <Abner.Chang@amd.com>; nicklew@nvidia.com; igork@ami.com;
> nhi@os.amperecomputing.com; tinhnguyen@os.amperecomputing.com;
> minhnampere <minhnguyen1@os.amperecomputing.com>
> Subject: [PATCH V3 0/5] Adding necessary changes for RedfishPkg
> 
> Caution: This message originated from an External Source. Use proper
> caution when opening attachments, clicking links, or responding.
> 
> 
> This patchset adds necessary changes for RedfishPkg to avoid some
> unexpected cases and fix compilation.
> 
> Changes since v3:
>  + Replaced __FUNCTION__ with __func__ to be more C11 compliant.
> Changes since v2:
>  + Added "Cc:" to maintainers in commit message.
>  + Corrected patch format subject prefix.
> Changes since v1:
>  + Removed redundant change and change the commit message for more
> precise in PATCH 2/5.
> 
> Nhi Pham (1):
>   RedfishPkg: Add missing newline character
> 
> Vu Nguyen (4):
>   RedfishPkg: Correct variable type to prevent memory corruption
>   RedfishPkg: Fix condition checking of error status
>   RedfishPkg: Create RestEx child on selected interface
>   RedfishPkg: Fix compile issue on Linux
> 
>  RedfishPkg/Include/Library/RestExLib.h                       |   3 +
>  RedfishPkg/Include/Pcd/RestExServiceDevicePath.h             |   5 +-
>  RedfishPkg/RedfishRestExDxe/RedfishRestExDriver.h            |   3 +-
>  RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c               | 153 ++++++++----
> --------
>  RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c           |   4 +-
>  RedfishPkg/RedfishHostInterfaceDxe/RedfishHostInterfaceDxe.c |   3 +-
>  6 files changed, 73 insertions(+), 98 deletions(-)
> 
> --
> 2.39.0

Re: [PATCH V3 0/5] Adding necessary changes for RedfishPkg

[Minh Nguyen]

Hi Abner,

  I've updated. Thanks for your review.

Thanks,

Minh Nguyen

On 5/5/2023 2:38 PM, Chang, Abner wrote:
> [AMD Official Use Only - General]
>
> Hi Minh,
> Please add my RB for 3/5 in commit message and push to minhnampere:Adding_necessary_changes_for_RedfishPkg again.   I will check the PR and merge it once it passes CI.
>
> Thank for your contribution.
> Abner
>
>> -----Original Message-----
>> From: minhnampere <minhnguyen1@os.amperecomputing.com>
>> Sent: Friday, May 5, 2023 2:46 PM
>> To: devel@edk2.groups.io
>> Cc: patches@amperecomputing.com; Chang, Abner
>> <Abner.Chang@amd.com>; nicklew@nvidia.com; igork@ami.com;
>> nhi@os.amperecomputing.com; tinhnguyen@os.amperecomputing.com;
>> minhnampere <minhnguyen1@os.amperecomputing.com>
>> Subject: [PATCH V3 0/5] Adding necessary changes for RedfishPkg
>>
>> Caution: This message originated from an External Source. Use proper
>> caution when opening attachments, clicking links, or responding.
>>
>>
>> This patchset adds necessary changes for RedfishPkg to avoid some
>> unexpected cases and fix compilation.
>>
>> Changes since v3:
>>   + Replaced __FUNCTION__ with __func__ to be more C11 compliant.
>> Changes since v2:
>>   + Added "Cc:" to maintainers in commit message.
>>   + Corrected patch format subject prefix.
>> Changes since v1:
>>   + Removed redundant change and change the commit message for more
>> precise in PATCH 2/5.
>>
>> Nhi Pham (1):
>>    RedfishPkg: Add missing newline character
>>
>> Vu Nguyen (4):
>>    RedfishPkg: Correct variable type to prevent memory corruption
>>    RedfishPkg: Fix condition checking of error status
>>    RedfishPkg: Create RestEx child on selected interface
>>    RedfishPkg: Fix compile issue on Linux
>>
>>   RedfishPkg/Include/Library/RestExLib.h                       |   3 +
>>   RedfishPkg/Include/Pcd/RestExServiceDevicePath.h             |   5 +-
>>   RedfishPkg/RedfishRestExDxe/RedfishRestExDriver.h            |   3 +-
>>   RedfishPkg/Library/DxeRestExLib/DxeRestExLib.c               | 153 ++++++++----
>> --------
>>   RedfishPkg/RedfishDiscoverDxe/RedfishDiscoverDxe.c           |   4 +-
>>   RedfishPkg/RedfishHostInterfaceDxe/RedfishHostInterfaceDxe.c |   3 +-
>>   6 files changed, 73 insertions(+), 98 deletions(-)
>>
>> --
>> 2.39.0