]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/HiiDatabaseDxe/Database.c
MdeModulePkg:Modify the incorrect DestStr length in safe string functions
[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / Database.c
index 3d70207952918b21966ec741736f9c536cb16849..ec56795ebb1924942403472a062cc3129aecbc8c 100644 (file)
@@ -1,9 +1,8 @@
 /** @file\r
 Implementation for EFI_HII_DATABASE_PROTOCOL.\r
 \r
-\r
-Copyright (c) 2007 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>\r
+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
 http://opensource.org/licenses/bsd-license.php\r
@@ -16,12 +15,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "HiiDatabase.h"\r
 \r
-//\r
-// Global variables\r
-//\r
-EFI_GUID mHiiDatabaseNotifyGuid = HII_DATABASE_NOTIFY_GUID;\r
-\r
-\r
 /**\r
   This function generates a HII_DATABASE_RECORD node and adds into hii database.\r
   This is a internal function.\r
@@ -87,7 +80,7 @@ GenerateHiiDatabaseRecord (
   // Backup the number of Hii handles\r
   //\r
   Private->HiiHandleCount++;\r
-  HiiHandle->Key = Private->HiiHandleCount;\r
+  HiiHandle->Key = (UINTN) Private->HiiHandleCount;\r
   //\r
   // Insert the handle to hii handle list of the whole database.\r
   //\r
@@ -659,7 +652,7 @@ ExportFormPackages (
   for (Link = PackageList->FormPkgHdr.ForwardLink; Link != &PackageList->FormPkgHdr; Link = Link->ForwardLink) {\r
     FormPackage = CR (Link, HII_IFR_PACKAGE_INSTANCE, IfrEntry, HII_IFR_PACKAGE_SIGNATURE);\r
     PackageLength += FormPackage->FormPkgHdr.Length;\r
-    if (PackageLength + *ResultSize + UsedSize <= BufferSize) {\r
+    if ((Buffer != NULL) && (PackageLength + *ResultSize + UsedSize <= BufferSize)) {\r
       //\r
       // Invoke registered notification if exists\r
       //\r
@@ -776,7 +769,6 @@ InsertStringPackage (
   IN     EFI_HII_DATABASE_NOTIFY_TYPE       NotifyType,\r
   IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageList,\r
   OUT    HII_STRING_PACKAGE_INSTANCE        **Package\r
-\r
   )\r
 {\r
   HII_STRING_PACKAGE_INSTANCE *StringPackage;\r
@@ -806,10 +798,10 @@ InsertStringPackage (
   if (Language == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
-  AsciiStrCpy (Language, (CHAR8 *) PackageHdr + HeaderSize - LanguageSize);\r
+  AsciiStrCpyS (Language, LanguageSize / sizeof (CHAR8), (CHAR8 *) PackageHdr + HeaderSize - LanguageSize);\r
   for (Link = PackageList->StringPkgHdr.ForwardLink; Link != &PackageList->StringPkgHdr; Link = Link->ForwardLink) {\r
     StringPackage = CR (Link, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
-    if (R8_EfiLibCompareLanguage (Language, StringPackage->StringPkgHdr->Language)) {\r
+    if (HiiCompareLanguage (Language, StringPackage->StringPkgHdr->Language)) {\r
       FreePool (Language);\r
       return EFI_UNSUPPORTED;\r
     }\r
@@ -858,7 +850,7 @@ InsertStringPackage (
   //\r
   // Collect all font block info\r
   //\r
-  Status = FindStringBlock (Private, StringPackage, (EFI_STRING_ID) (-1), NULL, NULL, NULL, NULL);\r
+  Status = FindStringBlock (Private, StringPackage, (EFI_STRING_ID) (-1), NULL, NULL, NULL, &StringPackage->MaxStringId, NULL);\r
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
@@ -890,6 +882,83 @@ Error:
 \r
 }\r
 \r
+/**\r
+ Adjust all string packages in a single package list to have the same max string ID.\r
\r
+ @param  PackageList        Pointer to a package list which will be adjusted.\r
+\r
+ @retval EFI_SUCCESS  Adjust all string packages successfully.\r
+ @retval others       Can't adjust string packges.\r
+\r
+**/\r
+EFI_STATUS\r
+AdjustStringPackage (\r
+  IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageList\r
+)\r
+{\r
+  LIST_ENTRY                  *Link;\r
+  HII_STRING_PACKAGE_INSTANCE *StringPackage;\r
+  UINT32                      Skip2BlockSize;\r
+  UINT32                      OldBlockSize;\r
+  UINT8                       *StringBlock;\r
+  UINT8                       *BlockPtr;\r
+  EFI_STRING_ID               MaxStringId;\r
+  UINT16                      SkipCount;\r
+\r
+  MaxStringId = 0;\r
+  for (Link = PackageList->StringPkgHdr.ForwardLink;\r
+       Link != &PackageList->StringPkgHdr;\r
+       Link = Link->ForwardLink\r
+      ) {\r
+    StringPackage = CR (Link, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
+    if (MaxStringId < StringPackage->MaxStringId) {\r
+      MaxStringId = StringPackage->MaxStringId;\r
+    }\r
+  }\r
+\r
+  for (Link = PackageList->StringPkgHdr.ForwardLink;\r
+       Link != &PackageList->StringPkgHdr;\r
+       Link = Link->ForwardLink\r
+      ) {\r
+    StringPackage = CR (Link, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
+    if (StringPackage->MaxStringId < MaxStringId) {\r
+      OldBlockSize = StringPackage->StringPkgHdr->Header.Length - StringPackage->StringPkgHdr->HdrSize;\r
+      //\r
+      // Create SKIP2 EFI_HII_SIBT_SKIP2_BLOCKs to reserve the missing string IDs.\r
+      //\r
+      SkipCount      = (UINT16) (MaxStringId - StringPackage->MaxStringId);\r
+      Skip2BlockSize = (UINT32) sizeof (EFI_HII_SIBT_SKIP2_BLOCK);\r
+\r
+      StringBlock = (UINT8 *) AllocateZeroPool (OldBlockSize + Skip2BlockSize);\r
+      if (StringBlock == NULL) {\r
+        return EFI_OUT_OF_RESOURCES;\r
+      }\r
+      //\r
+      // Copy original string blocks, except the EFI_HII_SIBT_END.\r
+      //\r
+      CopyMem (StringBlock, StringPackage->StringBlock, OldBlockSize - sizeof (EFI_HII_SIBT_END_BLOCK));\r
+      //\r
+      // Create SKIP2 EFI_HII_SIBT_SKIP2_BLOCK blocks\r
+      //\r
+      BlockPtr  = StringBlock + OldBlockSize - sizeof (EFI_HII_SIBT_END_BLOCK);\r
+      *BlockPtr = EFI_HII_SIBT_SKIP2;\r
+      CopyMem (BlockPtr + 1, &SkipCount, sizeof (UINT16));\r
+      BlockPtr  += sizeof (EFI_HII_SIBT_SKIP2_BLOCK);\r
+\r
+      //\r
+      // Append a EFI_HII_SIBT_END block to the end.\r
+      //\r
+      *BlockPtr = EFI_HII_SIBT_END;\r
+      FreePool (StringPackage->StringBlock);\r
+      StringPackage->StringBlock = StringBlock;\r
+      StringPackage->StringPkgHdr->Header.Length += Skip2BlockSize;\r
+      PackageList->PackageListHdr.PackageLength += Skip2BlockSize;\r
+      StringPackage->MaxStringId = MaxStringId;\r
+    }\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
 \r
 /**\r
   This function exports String packages to a buffer.\r
@@ -1113,7 +1182,7 @@ InsertFontPackage (
   }\r
   FontInfo->FontStyle = FontPkgHdr->FontStyle;\r
   FontInfo->FontSize  = FontPkgHdr->Cell.Height;\r
-  StrCpy (FontInfo->FontName, FontPkgHdr->FontFamily);\r
+  StrCpyS (FontInfo->FontName, (FontInfoSize - OFFSET_OF(EFI_FONT_INFO,FontName)) / sizeof (CHAR16), FontPkgHdr->FontFamily);\r
 \r
   if (IsFontInfoExisted (Private, FontInfo, NULL, NULL, NULL)) {\r
     Status = EFI_UNSUPPORTED;\r
@@ -2343,11 +2412,19 @@ AddPackages (
   EFI_HII_PACKAGE_HEADER               *PackageHdrPtr;\r
   EFI_HII_PACKAGE_HEADER               PackageHeader;\r
   UINT32                               OldPackageListLen;\r
+  BOOLEAN                              StringPkgIsAdd;\r
 \r
   //\r
   // Initialize Variables\r
   //\r
-  FontPackage = NULL;\r
+  StringPkgIsAdd        = FALSE;\r
+  FontPackage           = NULL;\r
+  StringPackage         = NULL;\r
+  GuidPackage           = NULL;\r
+  FormPackage           = NULL;\r
+  ImagePackage          = NULL;\r
+  SimpleFontPackage     = NULL;\r
+  KeyboardLayoutPackage = NULL;\r
 \r
   //\r
   // Process the package list header\r
@@ -2434,6 +2511,7 @@ AddPackages (
       if (EFI_ERROR (Status)) {\r
         return Status;\r
       }\r
+      ASSERT (StringPackage != NULL);\r
       Status = InvokeRegisteredFunction (\r
                  Private,\r
                  NotifyType,\r
@@ -2441,6 +2519,7 @@ AddPackages (
                  (UINT8) (PackageHeader.Type),\r
                  DatabaseRecord->Handle\r
                  );\r
+      StringPkgIsAdd = TRUE;\r
       break;\r
     case EFI_HII_PACKAGE_FONTS:\r
       Status = InsertFontPackage (\r
@@ -2518,6 +2597,13 @@ AddPackages (
     PackageHdrPtr = (EFI_HII_PACKAGE_HEADER *) ((UINT8 *) PackageHdrPtr + PackageHeader.Length);\r
     CopyMem (&PackageHeader, PackageHdrPtr, sizeof (EFI_HII_PACKAGE_HEADER));\r
   }\r
+  \r
+  //\r
+  // Adjust String Package to make sure all string packages have the same max string ID.\r
+  //\r
+  if (!EFI_ERROR (Status) && StringPkgIsAdd) {\r
+    Status = AdjustStringPackage (DatabaseRecord->PackageList);\r
+  }\r
 \r
   return Status;\r
 }\r
@@ -2556,7 +2642,7 @@ ExportPackageList (
   UINTN                               ResultSize;\r
   EFI_HII_PACKAGE_HEADER              EndofPackageList;\r
 \r
-  ASSERT (Private != NULL || PackageList != NULL || UsedSize != NULL);\r
+  ASSERT (Private != NULL && PackageList != NULL && UsedSize != NULL);\r
   ASSERT (Private->Signature == HII_DATABASE_PRIVATE_DATA_SIGNATURE);\r
   ASSERT (IsHiiHandleValid (Handle));\r
 \r
@@ -2700,6 +2786,8 @@ ExportPackageList (
   @param  PackageList            A pointer to an EFI_HII_PACKAGE_LIST_HEADER\r
                                  structure.\r
   @param  DriverHandle           Associate the package list with this EFI handle.\r
+                                 If a NULL is specified, this data will not be associate\r
+                                 with any drivers and cannot have a callback induced.\r
   @param  Handle                 A pointer to the EFI_HII_HANDLE instance.\r
 \r
   @retval EFI_SUCCESS            The package list associated with the Handle was\r
@@ -2715,7 +2803,7 @@ EFIAPI
 HiiNewPackageList (\r
   IN CONST EFI_HII_DATABASE_PROTOCOL    *This,\r
   IN CONST EFI_HII_PACKAGE_LIST_HEADER  *PackageList,\r
-  IN CONST EFI_HANDLE                   DriverHandle,\r
+  IN CONST EFI_HANDLE                   DriverHandle, OPTIONAL\r
   OUT EFI_HII_HANDLE                    *Handle\r
   )\r
 {\r
@@ -2740,9 +2828,8 @@ HiiNewPackageList (
     DatabaseRecord = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);\r
     if (CompareGuid (\r
           &(DatabaseRecord->PackageList->PackageListHdr.PackageListGuid),\r
-          &PackageListGuid\r
-          )\r
-        ) {\r
+          &PackageListGuid) && \r
+        DatabaseRecord->DriverHandle == DriverHandle) {\r
       return EFI_INVALID_PARAMETER;\r
     }\r
   }\r
@@ -3020,17 +3107,18 @@ HiiUpdatePackageList (
   @param  Handle                 An array of EFI_HII_HANDLE instances returned.\r
 \r
   @retval EFI_SUCCESS            The matching handles are outputed successfully.\r
-                                               HandleBufferLength is updated with the actual length.\r
+                                 HandleBufferLength is updated with the actual length.\r
   @retval EFI_BUFFER_TO_SMALL    The HandleBufferLength parameter indicates that\r
                                  Handle is too small to support the number of\r
                                  handles. HandleBufferLength is updated with a\r
                                  value that will  enable the data to fit.\r
   @retval EFI_NOT_FOUND          No matching handle could not be found in database.\r
-  @retval EFI_INVALID_PARAMETER  Handle or HandleBufferLength was NULL.\r
-  \r
+  @retval EFI_INVALID_PARAMETER  HandleBufferLength was NULL.\r
+  @retval EFI_INVALID_PARAMETER  The value referenced by HandleBufferLength was not\r
+                                 zero and Handle was NULL.\r
   @retval EFI_INVALID_PARAMETER  PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but\r
-                                                     PackageGuid is not NULL, PackageType is a EFI_HII_\r
-                                                     PACKAGE_TYPE_GUID but PackageGuid is NULL.\r
+                                 PackageGuid is not NULL, PackageType is a EFI_HII_\r
+                                 PACKAGE_TYPE_GUID but PackageGuid is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -3183,7 +3271,9 @@ HiiListPackageLists (
                                  value that will enable the data to fit.\r
   @retval EFI_NOT_FOUND          The specifiecd Handle could not be found in the\r
                                  current database.\r
-  @retval EFI_INVALID_PARAMETER  Handle or Buffer or BufferSize was NULL.\r
+  @retval EFI_INVALID_PARAMETER  BufferSize was NULL.\r
+  @retval EFI_INVALID_PARAMETER  The value referenced by BufferSize was not zero \r
+                                 and Buffer was NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -3201,13 +3291,13 @@ HiiExportPackageLists (
   HII_DATABASE_RECORD                 *Node;\r
   UINTN                               UsedSize;\r
 \r
-  if (This == NULL || BufferSize == NULL || Handle == NULL) {\r
+  if (This == NULL || BufferSize == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
   if (*BufferSize > 0 && Buffer == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
-  if (!IsHiiHandleValid (Handle)) {\r
+  if ((Handle != NULL) && (!IsHiiHandleValid (Handle))) {\r
     return EFI_NOT_FOUND;\r
   }\r
 \r
@@ -3229,8 +3319,7 @@ HiiExportPackageLists (
                  (EFI_HII_PACKAGE_LIST_HEADER *)((UINT8 *) Buffer + UsedSize)\r
                  );\r
       ASSERT_EFI_ERROR (Status);\r
-    }\r
-    else if (Handle != NULL && Node->Handle == Handle) {\r
+    } else if (Handle != NULL && Node->Handle == Handle) {\r
       Status = ExportPackageList (\r
                  Private,\r
                  Handle,\r
@@ -3334,7 +3423,7 @@ HiiRegisterPackageNotify (
   //\r
   Status = gBS->InstallMultipleProtocolInterfaces (\r
                   &Notify->NotifyHandle,\r
-                  &mHiiDatabaseNotifyGuid,\r
+                  &gEfiCallerIdGuid,\r
                   NULL,\r
                   NULL\r
                   );\r
@@ -3392,7 +3481,7 @@ HiiUnregisterPackageNotify (
 \r
   Status = gBS->OpenProtocol (\r
                   NotificationHandle,\r
-                  &mHiiDatabaseNotifyGuid,\r
+                  &gEfiCallerIdGuid,\r
                   NULL,\r
                   NULL,\r
                   NULL,\r
@@ -3413,7 +3502,7 @@ HiiUnregisterPackageNotify (
       RemoveEntryList (&Notify->DatabaseNotifyEntry);\r
       Status = gBS->UninstallMultipleProtocolInterfaces (\r
                       Notify->NotifyHandle,\r
-                      &mHiiDatabaseNotifyGuid,\r
+                      &gEfiCallerIdGuid,\r
                       NULL,\r
                       NULL\r
                       );\r
@@ -3446,7 +3535,9 @@ HiiUnregisterPackageNotify (
                                  number of GUIDs. KeyGuidBufferLength is\r
                                  updated with a value that will enable the data to\r
                                  fit.\r
-  @retval EFI_INVALID_PARAMETER  The KeyGuidBuffer or KeyGuidBufferLength was NULL.\r
+  @retval EFI_INVALID_PARAMETER  The KeyGuidBufferLength is NULL.\r
+  @retval EFI_INVALID_PARAMETER  The value referenced by KeyGuidBufferLength is not\r
+                                 zero and KeyGuidBuffer is NULL.\r
   @retval EFI_NOT_FOUND          There was no keyboard layout.\r
 \r
 **/\r