1) Fix bug in StatusCodeDxe about the nested DataHub->Log in callback.

2) Close a small window which may result in the data collision of records.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3641 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkModulePkg/Universal/StatusCode/Dxe/DataHubStatusCodeWorker.c b/IntelFrameworkModulePkg/Universal/StatusCode/Dxe/DataHubStatusCodeWorker.c
index 70f41e9923e4e2d41a402f8e8b9d8cc980a169c1..c14dfc8d33c2d0b4239bffd22e8cdb1810234f69 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/StatusCode/Dxe/DataHubStatusCodeWorker.c
+++ b/IntelFrameworkModulePkg/Universal/StatusCode/Dxe/DataHubStatusCodeWorker.c
@@ -22,6 +22,8 @@ LIST_ENTRY                mRecordsFifo          = INITIALIZE_LIST_HEAD_VARIABLE
 STATIC\r
 LIST_ENTRY                mRecordsBuffer        = INITIALIZE_LIST_HEAD_VARIABLE (mRecordsBuffer);\r
 STATIC\r
 STATIC\r
 LIST_ENTRY                mRecordsBuffer        = INITIALIZE_LIST_HEAD_VARIABLE (mRecordsBuffer);\r
 STATIC\r

+UINT32                    mLogDataHubStatus     = 0;\r
+STATIC\r

 EFI_EVENT                 mLogDataHubEvent;\r
 //\r
 // Cache data hub protocol.\r
 EFI_EVENT                 mLogDataHubEvent;\r
 //\r
 // Cache data hub protocol.\r


@@ -59,6 +61,9 @@ AcquireRecordBuffer (
     Record = _CR (Node, DATAHUB_STATUSCODE_RECORD, Node);\r
   } else {\r
     if (CurrentTpl > TPL_NOTIFY) {\r
     Record = _CR (Node, DATAHUB_STATUSCODE_RECORD, Node);\r
   } else {\r
     if (CurrentTpl > TPL_NOTIFY) {\r

+      //\r
+      // Memory management should work at <=TPL_NOTIFY\r
+      // \r

       gBS->RestoreTPL (CurrentTpl);\r
       return NULL;\r
     }\r
       gBS->RestoreTPL (CurrentTpl);\r
       return NULL;\r
     }\r


@@ -108,10 +113,9 @@ RetrieveRecord (
   if (!IsListEmpty (&mRecordsFifo)) {\r
     Node = GetFirstNode (&mRecordsFifo);\r
     Record = CR (Node, DATAHUB_STATUSCODE_RECORD, Node, DATAHUB_STATUS_CODE_SIGNATURE);\r
   if (!IsListEmpty (&mRecordsFifo)) {\r
     Node = GetFirstNode (&mRecordsFifo);\r
     Record = CR (Node, DATAHUB_STATUSCODE_RECORD, Node, DATAHUB_STATUS_CODE_SIGNATURE);\r

+    ASSERT (NULL != Record);\r

 \r
     RemoveEntryList (&Record->Node);\r
 \r
     RemoveEntryList (&Record->Node);\r

-    InsertTailList (&mRecordsBuffer, &Record->Node);\r
-    Record->Signature = 0;\r

     RecordData = (DATA_HUB_STATUS_CODE_DATA_RECORD *) Record->Data;\r
   }\r
 \r
     RecordData = (DATA_HUB_STATUS_CODE_DATA_RECORD *) Record->Data;\r
   }\r
 \r


@@ -120,6 +124,34 @@ RetrieveRecord (
   return RecordData;\r
 }\r
 \r
   return RecordData;\r
 }\r
 \r

+/**\r
+  Release Records to FIFO.\r
+  \r
+  @param RecordData  Point to the record buffer allocated\r
+                     from AcquireRecordBuffer.\r
+\r
+**/\r
+STATIC\r
+VOID\r
+ReleaseRecord (\r
+  DATA_HUB_STATUS_CODE_DATA_RECORD  *RecordData\r
+  )\r
+{\r
+  DATAHUB_STATUSCODE_RECORD         *Record;\r
+  EFI_TPL                           CurrentTpl;\r
+\r
+  Record = CR (RecordData, DATAHUB_STATUSCODE_RECORD, Data[0], DATAHUB_STATUS_CODE_SIGNATURE);\r
+  ASSERT (NULL != Record);\r
+\r
+  CurrentTpl = gBS->RaiseTPL (TPL_HIGH_LEVEL);\r
+\r
+  InsertTailList (&mRecordsBuffer, &Record->Node);\r
+  Record->Signature = 0;\r
+\r
+  gBS->RestoreTPL (CurrentTpl);\r
+}\r
+\r
+\r

 \r
 /**\r
   Report status code into DataHub.\r
 \r
 /**\r
   Report status code into DataHub.\r


@@ -166,6 +198,15 @@ DataHubStatusCodeReportWorker (
   CHAR8                             *Format;\r
   UINTN                             CharCount;\r
 \r
   CHAR8                             *Format;\r
   UINTN                             CharCount;\r
 \r

+\r
+  //\r
+  // Use atom operation to avoid the reentant of report.\r
+  // If current status is not zero, then the function is reentrancy.\r
+  //\r
+  if (1 == InterlockedCompareExchange32 (&mLogDataHubStatus, 0, 0)) {\r
+    return EFI_DEVICE_ERROR;\r
+  }\r
+\r

   //\r
   // See whether in runtime phase or not.\r
   //\r
   //\r
   // See whether in runtime phase or not.\r
   //\r


@@ -245,6 +286,14 @@ LogDataHubEventCallBack (
   UINT32                            Size;\r
   UINT64                            DataRecordClass;\r
 \r
   UINT32                            Size;\r
   UINT64                            DataRecordClass;\r
 \r

+  //\r
+  // Use atom operation to avoid the reentant of report.\r
+  // If current status is not zero, then the function is reentrancy.\r
+  //\r
+  if (1 == InterlockedCompareExchange32 (&mLogDataHubStatus, 0, 1)) {\r
+    return;\r
+  }\r
+\r

   //\r
   // Log DataRecord in Data Hub.\r
   // Journal records fifo to find all record entry.\r
   //\r
   // Log DataRecord in Data Hub.\r
   // Journal records fifo to find all record entry.\r


@@ -288,7 +337,13 @@ LogDataHubEventCallBack (
                         Size\r
                         );\r
 \r
                         Size\r
                         );\r
 \r

+    ReleaseRecord (Record);\r

   }\r
   }\r

+\r
+  //\r
+  // Restore the nest status of report\r
+  //\r
+  InterlockedCompareExchange32 (&mLogDataHubStatus, 1, 0);\r

 }\r
 \r
 \r
 }\r
 \r
 \r