/*++\r
\r
-Copyright (c) 2004 - 2006, Intel Corporation \r
+Copyright (c) 2004 - 2007, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
#include "BsDataHubStatusCode.h"\r
\r
//\r
-// Globals only work at BootService Time. NOT at Runtime!\r
+// Initialize FIFO to cache records.\r
//\r
-static EFI_DATA_HUB_PROTOCOL *mDataHub;\r
-static EFI_LIST_ENTRY *mRecordHead;\r
-static EFI_LIST_ENTRY *mRecordTail;\r
-static INTN mRecordNum = 0;\r
-static EFI_EVENT mLogDataHubEvent;\r
-static EFI_LOCK mStatusCodeReportLock = EFI_INITIALIZE_LOCK_VARIABLE(EFI_TPL_HIGH_LEVEL);\r
-static BOOLEAN mEventHandlerActive = FALSE;\r
+STATIC EFI_LIST_ENTRY mRecordsFifo = INITIALIZE_LIST_HEAD_VARIABLE (mRecordsFifo);\r
+STATIC EFI_LIST_ENTRY mRecordsBuffer = INITIALIZE_LIST_HEAD_VARIABLE (mRecordsBuffer);\r
+STATIC EFI_EVENT mLogDataHubEvent;\r
+STATIC BOOLEAN mEventHandlerActive = FALSE;\r
\r
+//\r
+// Cache data hub protocol.\r
+//\r
+STATIC EFI_DATA_HUB_PROTOCOL *mDataHubProtocol;\r
\r
-STATUS_CODE_RECORD_LIST *\r
-AllocateRecordBuffer (\r
+STATIC\r
+DATA_HUB_STATUS_CODE_DATA_RECORD *\r
+AcquireRecordBuffer (\r
VOID\r
)\r
/*++\r
\r
Routine Description:\r
\r
- Allocate a new record list node and initialize it.\r
- Inserting the node into the list isn't the task of this function.\r
+ Return one DATAHUB_STATUSCODE_RECORD space.\r
+ The size of free record pool would be extend, if the pool is empty.\r
\r
Arguments:\r
\r
\r
--*/\r
{\r
- STATUS_CODE_RECORD_LIST *DataBuffer;\r
-\r
- DataBuffer = NULL;\r
-\r
- gBS->AllocatePool (EfiBootServicesData, sizeof (STATUS_CODE_RECORD_LIST), &DataBuffer);\r
- if (DataBuffer == NULL) {\r
- return NULL;\r
- }\r
-\r
- EfiCommonLibZeroMem (DataBuffer, sizeof (STATUS_CODE_RECORD_LIST));\r
- DataBuffer->Signature = BS_DATA_HUB_STATUS_CODE_SIGNATURE;\r
-\r
- return DataBuffer;\r
-}\r
-\r
-DATA_HUB_STATUS_CODE_DATA_RECORD *\r
-AquireEmptyRecordBuffer (\r
- VOID\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Acquire an empty record buffer from the record list if there's free node,\r
- or allocate one new node and insert it to the list if the list is full and\r
- the function isn't run in EFI_TPL_HIGH_LEVEL.\r
+ DATAHUB_STATUSCODE_RECORD *Record;\r
+ EFI_TPL CurrentTpl;\r
+ EFI_LIST_ENTRY *Node;\r
+ UINT32 Index;\r
\r
-Arguments:\r
-\r
- None\r
-\r
-Returns:\r
-\r
- Pointer to new record buffer. NULL if none available.\r
-\r
---*/\r
-{\r
- EFI_TPL OldTpl;\r
- STATUS_CODE_RECORD_LIST *DataBuffer;\r
+ Record = NULL;\r
+ CurrentTpl = gBS->RaiseTPL (EFI_TPL_HIGH_LEVEL);\r
\r
- DataBuffer = NULL;\r
+ if (!IsListEmpty (&mRecordsBuffer)) {\r
+ Node = GetFirstNode (&mRecordsBuffer);\r
+ RemoveEntryList (Node);\r
\r
- //\r
- // This function must be reentrant because an event with higher priority may interrupt it\r
- // and also report status code.\r
- //\r
- EfiAcquireLock (&mStatusCodeReportLock);\r
- if (mRecordTail != mRecordHead->ForwardLink) {\r
- if (mRecordNum != 0) {\r
- mRecordHead = mRecordHead->ForwardLink;\r
+ Record = _CR (Node, DATAHUB_STATUSCODE_RECORD, Node);\r
+ } else {\r
+ if (CurrentTpl > EFI_TPL_NOTIFY) {\r
+ gBS->RestoreTPL (CurrentTpl);\r
+ return NULL;\r
}\r
- DataBuffer = CR (mRecordHead, STATUS_CODE_RECORD_LIST, Link, BS_DATA_HUB_STATUS_CODE_SIGNATURE);\r
- mRecordNum++;\r
- EfiReleaseLock (&mStatusCodeReportLock);\r
\r
- //\r
- // Initalize the record buffer is the responsibility of the producer,\r
- // because the consummer is in a lock so must keep it short.\r
- //\r
- EfiCommonLibZeroMem (&DataBuffer->RecordBuffer[0], BYTES_PER_BUFFER);\r
- } else if (mRecordNum < MAX_RECORD_NUM) {\r
- //\r
- // The condition of "mRecordNum < MAX_RECORD_NUM" is not promised,\r
- // because mRecodeNum may be increased out of this lock.\r
- //\r
- EfiReleaseLock (&mStatusCodeReportLock);\r
-\r
- //\r
- // Can't allocate additional buffer in EFI_TPL_HIGH_LEVEL.\r
- // Reporting too many status code in EFI_TPL_HIGH_LEVEL may cause status code lost.\r
- //\r
- OldTpl = gBS->RaiseTPL (EFI_TPL_HIGH_LEVEL);\r
- if (OldTpl == EFI_TPL_HIGH_LEVEL) {\r
+ gBS->RestoreTPL (CurrentTpl);\r
+ \r
+ gBS->AllocatePool (EfiBootServicesData, sizeof (DATAHUB_STATUSCODE_RECORD) * 16, &Record);\r
+ if (Record == NULL) {\r
return NULL;\r
}\r
- gBS->RestoreTPL (OldTpl);\r
- DataBuffer = AllocateRecordBuffer ();\r
- if (DataBuffer == NULL) {\r
- return NULL;\r
+ EfiCommonLibZeroMem (Record, sizeof (DATAHUB_STATUSCODE_RECORD) * 16); \r
+\r
+\r
+ CurrentTpl = gBS->RaiseTPL (EFI_TPL_HIGH_LEVEL);\r
+ for (Index = 1; Index < 16; Index++) {\r
+ InsertTailList (&mRecordsBuffer, &Record[Index].Node);\r
}\r
- EfiAcquireLock (&mStatusCodeReportLock);\r
- InsertHeadList (mRecordHead, &DataBuffer->Link);\r
- mRecordHead = mRecordHead->ForwardLink;\r
- mRecordNum++;\r
- EfiReleaseLock (&mStatusCodeReportLock);\r
- } else {\r
- EfiReleaseLock (&mStatusCodeReportLock);\r
- return NULL;\r
}\r
\r
- return (DATA_HUB_STATUS_CODE_DATA_RECORD *) DataBuffer->RecordBuffer;\r
+ Record->Signature = BS_DATA_HUB_STATUS_CODE_SIGNATURE;\r
+ InsertTailList (&mRecordsFifo, &Record->Node);\r
+\r
+ gBS->RestoreTPL (CurrentTpl);\r
+\r
+ return (DATA_HUB_STATUS_CODE_DATA_RECORD *) (Record->Data);\r
}\r
\r
-EFI_STATUS\r
-ReleaseRecordBuffer (\r
- IN STATUS_CODE_RECORD_LIST *RecordBuffer\r
+STATIC\r
+DATA_HUB_STATUS_CODE_DATA_RECORD *\r
+RetrieveRecord (\r
+ VOID\r
)\r
/*++\r
\r
Routine Description:\r
\r
- Release a buffer in the list, remove some nodes to keep the list inital length.\r
+ Retrieve one record from Records FIFO. The record would be removed from FIFO and \r
+ release to free record buffer.\r
\r
Arguments:\r
\r
- RecordBuffer - Buffer to release\r
+ None\r
\r
Returns:\r
\r
- EFI_SUCCESS - If DataRecord is valid\r
- EFI_UNSUPPORTED - The record list has empty\r
+ Point to record which is ready to be logged, or NULL if the FIFO of record is empty.\r
\r
---*/\r
+--*/ \r
{\r
- ASSERT (RecordBuffer != NULL);\r
+ DATA_HUB_STATUS_CODE_DATA_RECORD *RecordData;\r
+ DATAHUB_STATUSCODE_RECORD *Record;\r
+ EFI_LIST_ENTRY *Node;\r
+ EFI_TPL CurrentTpl;\r
+ \r
+ RecordData = NULL;\r
+ \r
+ CurrentTpl = gBS->RaiseTPL (EFI_TPL_HIGH_LEVEL);\r
\r
- //\r
- // The consummer needn't to be reentrient and the producer won't do any meaningful thing\r
- // when consummer is logging records.\r
- //\r
- if (mRecordNum <= 0) {\r
- return EFI_UNSUPPORTED;\r
- } else if (mRecordNum > INITIAL_RECORD_NUM) {\r
- mRecordTail = mRecordTail->ForwardLink;\r
- RemoveEntryList (&RecordBuffer->Link);\r
- mRecordNum--;\r
- gBS->FreePool (RecordBuffer);\r
- } else {\r
- if (mRecordNum != 1) {\r
- mRecordTail = mRecordTail->ForwardLink;\r
- }\r
- mRecordNum--;\r
+ if (!IsListEmpty (&mRecordsFifo)) {\r
+ Node = GetFirstNode (&mRecordsFifo);\r
+ Record = CR (Node, DATAHUB_STATUSCODE_RECORD, Node, BS_DATA_HUB_STATUS_CODE_SIGNATURE);\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
- return EFI_SUCCESS;\r
+ gBS->RestoreTPL (CurrentTpl);\r
+\r
+ return RecordData;\r
}\r
\r
-EFI_BOOTSERVICE\r
EFI_STATUS\r
EFIAPI\r
BsDataHubReportStatusCode (\r
\r
--*/\r
{\r
- DATA_HUB_STATUS_CODE_DATA_RECORD *DataHub;\r
- UINT32 ErrorLevel;\r
- VA_LIST Marker;\r
- CHAR8 *Format;\r
- UINTN Index;\r
- CHAR16 FormatBuffer[BYTES_PER_RECORD];\r
-\r
- DataHub = NULL;\r
+ DATA_HUB_STATUS_CODE_DATA_RECORD *Record;\r
+ UINT32 ErrorLevel;\r
+ VA_LIST Marker;\r
+ CHAR8 *Format;\r
+ CHAR16 FormatBuffer[BYTES_PER_RECORD];\r
+ UINTN Index;\r
\r
+ //\r
+ // See whether in runtime phase or not.\r
+ //\r
if (EfiAtRuntime ()) {\r
//\r
// For now all we do is post code at runtime\r
//\r
return EFI_SUCCESS;\r
}\r
+\r
//\r
- // If we had an error while in our event handler, then do nothing so\r
- // that we don't get in an endless loop.\r
+ // Discard new DataHubRecord caused by DataHub->LogData()\r
//\r
if (mEventHandlerActive) {\r
return EFI_SUCCESS;\r
}\r
\r
- DataHub = (DATA_HUB_STATUS_CODE_DATA_RECORD *) AquireEmptyRecordBuffer ();\r
- if (DataHub == NULL) {\r
+ Record = AcquireRecordBuffer ();\r
+ if (Record == NULL) {\r
//\r
// There are no empty record buffer in private buffers\r
//\r
//\r
// Construct Data Hub Extended Data\r
//\r
- DataHub->CodeType = CodeType;\r
- DataHub->Value = Value;\r
- DataHub->Instance = Instance;\r
+ Record->CodeType = CodeType;\r
+ Record->Value = Value;\r
+ Record->Instance = Instance;\r
\r
if (CallerId != NULL) {\r
- EfiCopyMem (&DataHub->CallerId, CallerId, sizeof (EFI_GUID));\r
- } else {\r
- EfiZeroMem (&DataHub->CallerId, sizeof (EFI_GUID));\r
+ EfiCopyMem (&Record->CallerId, CallerId, sizeof (EFI_GUID));\r
}\r
\r
- if (Data == NULL) {\r
- EfiZeroMem (&DataHub->Data, sizeof (EFI_STATUS_CODE_DATA));\r
- } else {\r
- //\r
- // Copy generic Header\r
- //\r
- EfiCopyMem (&DataHub->Data, Data, sizeof (EFI_STATUS_CODE_DATA));\r
-\r
+ if (Data != NULL) {\r
if (ReportStatusCodeExtractDebugInfo (Data, &ErrorLevel, &Marker, &Format)) {\r
//\r
// Convert Ascii Format string to Unicode.\r
// Put processed string into the buffer\r
//\r
Index = VSPrint (\r
- (UINT16 *) (DataHub + 1),\r
+ (CHAR16 *) (Record + 1),\r
BYTES_PER_RECORD - (sizeof (DATA_HUB_STATUS_CODE_DATA_RECORD)),\r
FormatBuffer,\r
Marker\r
);\r
-\r
- //\r
- // DATA_HUB_STATUS_CODE_DATA_RECORD followed by VSPrint String Buffer\r
- //\r
- DataHub->Data.Size = (UINT16) (Index * sizeof (CHAR16));\r
-\r
+ \r
+ EfiCopyMem (&Record->Data.Type, &gEfiStatusCodeDataTypeDebugGuid, sizeof (EFI_GUID));\r
+ Record->Data.HeaderSize = Data->HeaderSize;\r
+ Record->Data.Size = (UINT16) (Index * sizeof (CHAR16));\r
} else {\r
//\r
- // Default behavior is to copy optional data\r
+ // Copy status code data header\r
//\r
- if (Data->Size > (BYTES_PER_RECORD - sizeof (DATA_HUB_STATUS_CODE_DATA_RECORD))) {\r
- DataHub->Data.Size = (UINT16) (BYTES_PER_RECORD - sizeof (DATA_HUB_STATUS_CODE_DATA_RECORD));\r
- }\r
+ EfiCopyMem (&Record->Data, Data, sizeof (EFI_STATUS_CODE_DATA));\r
\r
- EfiCopyMem (DataHub + 1, Data + 1, DataHub->Data.Size);\r
+ if (Data->Size > BYTES_PER_RECORD - sizeof (DATA_HUB_STATUS_CODE_DATA_RECORD)) {\r
+ Record->Data.Size = (UINT16) (BYTES_PER_RECORD - sizeof (DATA_HUB_STATUS_CODE_DATA_RECORD));\r
+ } \r
+ EfiCopyMem ((VOID *) (Record + 1), Data + 1, Record->Data.Size);\r
}\r
}\r
\r
\r
--*/\r
{\r
- EFI_STATUS Status;\r
- DATA_HUB_STATUS_CODE_DATA_RECORD *DataRecord;\r
- UINTN Size;\r
+ DATA_HUB_STATUS_CODE_DATA_RECORD *Record;\r
+ UINT32 Size;\r
UINT64 DataRecordClass;\r
- EFI_LIST_ENTRY *Link;\r
- STATUS_CODE_RECORD_LIST *BufferEntry;\r
\r
//\r
- // Set our global flag so we don't recurse if we get an error here.\r
+ // Set global flag so we don't recurse if DataHub->LogData eventually causes new DataHubRecord\r
//\r
mEventHandlerActive = TRUE;\r
\r
//\r
// Log DataRecord in Data Hub.\r
- // If there are multiple DataRecords, Log all of them.\r
+ // Journal records fifo to find all record entry.\r
//\r
- Link = mRecordTail;\r
-\r
- while (mRecordNum != 0) {\r
- BufferEntry = CR (Link, STATUS_CODE_RECORD_LIST, Link, BS_DATA_HUB_STATUS_CODE_SIGNATURE);\r
- DataRecord = (DATA_HUB_STATUS_CODE_DATA_RECORD *) (BufferEntry->RecordBuffer);\r
- Link = Link->ForwardLink;\r
-\r
+ while (1) {\r
+ Record = RetrieveRecord ();\r
+ if (Record == NULL) {\r
+ break;\r
+ }\r
//\r
// Add in the size of the header we added.\r
//\r
- Size = sizeof (DATA_HUB_STATUS_CODE_DATA_RECORD) + DataRecord->Data.Size;\r
+ Size = sizeof (DATA_HUB_STATUS_CODE_DATA_RECORD) + (UINT32) Record->Data.Size;\r
\r
- if ((DataRecord->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) {\r
+ if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) {\r
DataRecordClass = EFI_DATA_RECORD_CLASS_PROGRESS_CODE;\r
- } else if ((DataRecord->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) {\r
+ } else if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) {\r
DataRecordClass = EFI_DATA_RECORD_CLASS_ERROR;\r
- } else if ((DataRecord->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE) {\r
+ } else if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE) {\r
DataRecordClass = EFI_DATA_RECORD_CLASS_DEBUG;\r
} else {\r
//\r
EFI_DATA_RECORD_CLASS_PROGRESS_CODE;\r
}\r
\r
- if (((DataRecord->Instance & EFI_D_ERROR) != 0) &&\r
- (((DataRecord->Instance & EFI_D_POOL) != 0) || ((DataRecord->Instance & EFI_D_PAGE) != 0))\r
- ) {\r
- //\r
- // If memory error, do not call LogData ().\r
- //\r
- ErrorPrint (L"ERROR", "Memory Error\n");\r
- Status = EFI_OUT_OF_RESOURCES;\r
- } else {\r
- //\r
- // We don't log EFI_D_POOL and EFI_D_PAGE debug info to datahub\r
- // to avoid recursive logging due to the memory allocation in datahub\r
- //\r
- if (DataRecordClass != EFI_DATA_RECORD_CLASS_DEBUG ||\r
- ((DataRecord->Instance & EFI_D_POOL) == 0 && (DataRecord->Instance & EFI_D_PAGE) == 0)) {\r
- //\r
- // Log DataRecord in Data Hub\r
- //\r
- Status = mDataHub->LogData (\r
- mDataHub,\r
- &gEfiStatusCodeGuid,\r
- &gEfiStatusCodeRuntimeProtocolGuid,\r
- DataRecordClass,\r
- DataRecord,\r
- (UINT32) Size\r
- );\r
- }\r
- }\r
+ //\r
+ // Log DataRecord in Data Hub\r
+ //\r
+ \r
+ mDataHubProtocol->LogData (\r
+ mDataHubProtocol,\r
+ &gEfiStatusCodeGuid,\r
+ &gEfiStatusCodeRuntimeProtocolGuid,\r
+ DataRecordClass,\r
+ Record,\r
+ Size\r
+ );\r
\r
- ReleaseRecordBuffer (BufferEntry);\r
}\r
\r
mEventHandlerActive = FALSE;\r
\r
- return ;\r
}\r
\r
-EFI_BOOTSERVICE\r
EFI_STATUS\r
+EFIAPI\r
BsDataHubInitializeStatusCode (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
--*/\r
{\r
EFI_STATUS Status;\r
- STATUS_CODE_RECORD_LIST *DataBuffer;\r
- UINTN Index1;\r
\r
- DataBuffer = NULL;\r
-\r
- Status = gBS->LocateProtocol (&gEfiDataHubProtocolGuid, NULL, &mDataHub);\r
- //\r
- // Should never fail due to dependency grammer\r
- //\r
+ Status = gBS->LocateProtocol (\r
+ &gEfiDataHubProtocolGuid, \r
+ NULL, \r
+ (VOID **) &mDataHubProtocol\r
+ );\r
ASSERT_EFI_ERROR (Status);\r
\r
- //\r
- // Initialize a record list with length not greater than INITIAL_RECORD_NUM.\r
- // If no buffer can be allocated, return EFI_OUT_OF_RESOURCES.\r
- //\r
- DataBuffer = AllocateRecordBuffer ();\r
- if (DataBuffer == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
- mRecordHead = &DataBuffer->Link;\r
- mRecordTail = mRecordHead;\r
- InitializeListHead (mRecordHead);\r
- \r
- for (Index1 = 1; Index1 < INITIAL_RECORD_NUM; Index1++) {\r
- DataBuffer = AllocateRecordBuffer ();\r
- if (DataBuffer == NULL) {\r
- break;\r
- }\r
- InsertHeadList (mRecordHead, &DataBuffer->Link);\r
- }\r
-\r
-\r
//\r
// Create a Notify Event to log data in Data Hub\r
//\r
&mLogDataHubEvent\r
);\r
\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
return EFI_SUCCESS;\r
}\r
+\r
+\r
projects / mirror_edk2.git / blobdiff