]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.c
MdeModulePkg/FvSimpleFileSystem:Fix a potential NULL dereference issue.
[mirror_edk2.git] / MdeModulePkg / Universal / FaultTolerantWriteDxe / FaultTolerantWrite.c
index 3d1d29dfd9d3400f99e2c8183f9c5210543c4f61..f08f280b46adf43fbd25cf5fac4b8afbb2a401eb 100644 (file)
@@ -3,7 +3,7 @@
   These are the common Fault Tolerant Write (FTW) functions that are shared \r
   by DXE FTW driver and SMM FTW driver.\r
 \r
-Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2014, 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
@@ -81,7 +81,6 @@ FtwAllocate (
   )\r
 {\r
   EFI_STATUS                      Status;\r
-  UINTN                           Length;\r
   UINTN                           Offset;\r
   EFI_FTW_DEVICE                  *FtwDevice;\r
   EFI_FAULT_TOLERANT_WRITE_HEADER *FtwHeader;\r
@@ -134,14 +133,14 @@ FtwAllocate (
   FtwHeader->PrivateDataSize  = PrivateDataSize;\r
   FtwHeader->HeaderAllocated  = FTW_VALID_STATE;\r
 \r
-  Length                      = sizeof (EFI_FAULT_TOLERANT_WRITE_HEADER);\r
-  Status = FtwDevice->FtwFvBlock->Write (\r
-                                    FtwDevice->FtwFvBlock,\r
-                                    FtwDevice->FtwWorkSpaceLba,\r
-                                    FtwDevice->FtwWorkSpaceBase + Offset,\r
-                                    &Length,\r
-                                    (UINT8 *) FtwHeader\r
-                                    );\r
+  Status = WriteWorkSpaceData (\r
+             FtwDevice->FtwFvBlock,\r
+             FtwDevice->WorkBlockSize,\r
+             FtwDevice->FtwWorkSpaceLba,\r
+             FtwDevice->FtwWorkSpaceBase + Offset,\r
+             sizeof (EFI_FAULT_TOLERANT_WRITE_HEADER),\r
+             (UINT8 *) FtwHeader\r
+             );\r
   if (EFI_ERROR (Status)) {\r
     return EFI_ABORTED;\r
   }\r
@@ -150,6 +149,7 @@ FtwAllocate (
   //\r
   Status = FtwUpdateFvState (\r
             FtwDevice->FtwFvBlock,\r
+            FtwDevice->WorkBlockSize,\r
             FtwDevice->FtwWorkSpaceLba,\r
             FtwDevice->FtwWorkSpaceBase + Offset,\r
             WRITES_ALLOCATED\r
@@ -159,7 +159,7 @@ FtwAllocate (
   }\r
 \r
   DEBUG (\r
-    (EFI_D_ERROR,\r
+    (EFI_D_INFO,\r
     "Ftw: Allocate() success, Caller:%g, # %d\n",\r
     CallerId,\r
     NumberOfWrites)\r
@@ -170,13 +170,14 @@ FtwAllocate (
 \r
 \r
 /**\r
-  Write a record with fault tolerant mannaer.\r
+  Write a record with fault tolerant manner.\r
   Since the content has already backuped in spare block, the write is\r
   guaranteed to be completed with fault tolerant manner.\r
 \r
   @param This            The pointer to this protocol instance. \r
   @param Fvb             The FVB protocol that provides services for\r
                          reading, writing, and erasing the target block.\r
+  @param BlockSize       The size of the block.\r
 \r
   @retval  EFI_SUCCESS          The function completed successfully\r
   @retval  EFI_ABORTED          The function could not complete successfully\r
@@ -185,7 +186,8 @@ FtwAllocate (
 EFI_STATUS\r
 FtwWriteRecord (\r
   IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL     *This,\r
-  IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL    *Fvb\r
+  IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL    *Fvb,\r
+  IN UINTN                                 BlockSize\r
   )\r
 {\r
   EFI_STATUS                      Status;\r
@@ -193,12 +195,10 @@ FtwWriteRecord (
   EFI_FAULT_TOLERANT_WRITE_HEADER *Header;\r
   EFI_FAULT_TOLERANT_WRITE_RECORD *Record;\r
   UINTN                           Offset;\r
-  EFI_LBA                         WorkSpaceLbaOffset;\r
+  UINTN                           NumberOfWriteBlocks;\r
 \r
   FtwDevice = FTW_CONTEXT_FROM_THIS (This);\r
 \r
-  WorkSpaceLbaOffset = FtwDevice->FtwWorkSpaceLba - FtwDevice->FtwWorkBlockLba;\r
-\r
   //\r
   // Spare Complete but Destination not complete,\r
   // Recover the target block with the spare block.\r
@@ -218,8 +218,9 @@ FtwWriteRecord (
     Offset = (UINT8 *) Record - FtwDevice->FtwWorkSpace;\r
     Status = FtwUpdateFvState (\r
               FtwDevice->FtwBackupFvb,\r
-              FtwDevice->FtwSpareLba + WorkSpaceLbaOffset,\r
-              FtwDevice->FtwWorkSpaceBase + Offset,\r
+              FtwDevice->SpareBlockSize,\r
+              FtwDevice->FtwSpareLba + FtwDevice->FtwWorkSpaceLbaInSpare,\r
+              FtwDevice->FtwWorkSpaceBaseInSpare + Offset,\r
               SPARE_COMPLETED\r
               );\r
     if (EFI_ERROR (Status)) {\r
@@ -227,7 +228,7 @@ FtwWriteRecord (
     }\r
 \r
     Status = FlushSpareBlockToWorkingBlock (FtwDevice);\r
-  } else if (IsBootBlock (FtwDevice, Fvb, Record->Lba)) {\r
+  } else if (IsBootBlock (FtwDevice, Fvb)) {\r
     //\r
     // Update boot block\r
     //\r
@@ -236,7 +237,8 @@ FtwWriteRecord (
     //\r
     // Update blocks other than working block or boot block\r
     //\r
-    Status = FlushSpareBlockToTargetBlock (FtwDevice, Fvb, Record->Lba);\r
+    NumberOfWriteBlocks = FTW_BLOCKS ((UINTN) (Record->Offset + Record->Length), BlockSize);\r
+    Status = FlushSpareBlockToTargetBlock (FtwDevice, Fvb, Record->Lba, BlockSize, NumberOfWriteBlocks);\r
   }\r
 \r
   if (EFI_ERROR (Status)) {\r
@@ -248,6 +250,7 @@ FtwWriteRecord (
   Offset = (UINT8 *) Record - FtwDevice->FtwWorkSpace;\r
   Status = FtwUpdateFvState (\r
             FtwDevice->FtwFvBlock,\r
+            FtwDevice->WorkBlockSize,\r
             FtwDevice->FtwWorkSpaceLba,\r
             FtwDevice->FtwWorkSpaceBase + Offset,\r
             DEST_COMPLETED\r
@@ -266,6 +269,7 @@ FtwWriteRecord (
     Offset = (UINT8 *) Header - FtwDevice->FtwWorkSpace;\r
     Status = FtwUpdateFvState (\r
               FtwDevice->FtwFvBlock,\r
+              FtwDevice->WorkBlockSize,\r
               FtwDevice->FtwWorkSpaceLba,\r
               FtwDevice->FtwWorkSpaceBase + Offset,\r
               WRITES_COMPLETED\r
@@ -330,6 +334,10 @@ FtwWrite (
   UINTN                               Index;\r
   UINT8                               *Ptr;\r
   EFI_PHYSICAL_ADDRESS                FvbPhysicalAddress;\r
+  UINTN                               BlockSize;\r
+  UINTN                               NumberOfBlocks;\r
+  UINTN                               NumberOfWriteBlocks;\r
+  UINTN                               WriteLength;\r
 \r
   FtwDevice = FTW_CONTEXT_FROM_THIS (This);\r
 \r
@@ -383,12 +391,7 @@ FtwWrite (
   if ((Record->SpareComplete == FTW_VALID_STATE) && (Record->DestinationComplete != FTW_VALID_STATE)) {\r
     return EFI_NOT_READY;\r
   }\r
-  //\r
-  // Check if the input data can fit within the target block\r
-  //\r
-  if ((Offset + Length) > FtwDevice->SpareAreaLength) {\r
-    return EFI_BAD_BUFFER_SIZE;\r
-  }\r
+\r
   //\r
   // Get the FVB protocol by handle\r
   //\r
@@ -399,15 +402,39 @@ FtwWrite (
 \r
   Status = Fvb->GetPhysicalAddress (Fvb, &FvbPhysicalAddress);\r
   if (EFI_ERROR (Status)) {\r
-    DEBUG ((EFI_D_ERROR, "FtwLite: Get FVB physical address - %r\n", Status));\r
+    DEBUG ((EFI_D_ERROR, "Ftw: Write(), Get FVB physical address - %r\n", Status));\r
+    return EFI_ABORTED;\r
+  }\r
+\r
+  //\r
+  // Now, one FVB has one type of BlockSize.\r
+  //\r
+  Status = Fvb->GetBlockSize (Fvb, 0, &BlockSize, &NumberOfBlocks);\r
+  if (EFI_ERROR (Status)) {\r
+    DEBUG ((EFI_D_ERROR, "Ftw: Write(), Get block size - %r\n", Status));\r
     return EFI_ABORTED;\r
   }\r
 \r
+  NumberOfWriteBlocks = FTW_BLOCKS (Offset + Length, BlockSize);\r
+  DEBUG ((EFI_D_INFO, "Ftw: Write(), BlockSize - 0x%x, NumberOfWriteBlock - 0x%x\n", BlockSize, NumberOfWriteBlocks));\r
+  WriteLength = NumberOfWriteBlocks * BlockSize;\r
+\r
+  //\r
+  // Check if the input data can fit within the spare block.\r
+  //\r
+  if (WriteLength > FtwDevice->SpareAreaLength) {\r
+    return EFI_BAD_BUFFER_SIZE;\r
+  }\r
+\r
   //\r
   // Set BootBlockUpdate FLAG if it's updating boot block.\r
   //\r
-  if (IsBootBlock (FtwDevice, Fvb, Lba)) {\r
+  if (IsBootBlock (FtwDevice, Fvb)) {\r
     Record->BootBlockUpdate = FTW_VALID_STATE;\r
+    //\r
+    // Boot Block and Spare Block should have same block size and block numbers.\r
+    //\r
+    ASSERT ((BlockSize == FtwDevice->SpareBlockSize) && (NumberOfWriteBlocks == FtwDevice->NumberOfSpareBlock));\r
   }\r
   //\r
   // Write the record to the work space.\r
@@ -415,7 +442,7 @@ FtwWrite (
   Record->Lba     = Lba;\r
   Record->Offset  = Offset;\r
   Record->Length  = Length;\r
-  Record->RelativeOffset = (INT64) (FvbPhysicalAddress + (UINTN) Lba * FtwDevice->BlockSize) - (INT64) FtwDevice->SpareAreaAddress;\r
+  Record->RelativeOffset = (INT64) (FvbPhysicalAddress + (UINTN) Lba * BlockSize) - (INT64) FtwDevice->SpareAreaAddress;\r
   if (PrivateData != NULL) {\r
     CopyMem ((Record + 1), PrivateData, (UINTN) Header->PrivateDataSize);\r
   }\r
@@ -423,13 +450,14 @@ FtwWrite (
   MyOffset  = (UINT8 *) Record - FtwDevice->FtwWorkSpace;\r
   MyLength  = FTW_RECORD_SIZE (Header->PrivateDataSize);\r
 \r
-  Status = FtwDevice->FtwFvBlock->Write (\r
-                                    FtwDevice->FtwFvBlock,\r
-                                    FtwDevice->FtwWorkSpaceLba,\r
-                                    FtwDevice->FtwWorkSpaceBase + MyOffset,\r
-                                    &MyLength,\r
-                                    (UINT8 *) Record\r
-                                    );\r
+  Status = WriteWorkSpaceData (\r
+             FtwDevice->FtwFvBlock,\r
+             FtwDevice->WorkBlockSize,\r
+             FtwDevice->FtwWorkSpaceLba,\r
+             FtwDevice->FtwWorkSpaceBase + MyOffset,\r
+             MyLength,\r
+             (UINT8 *) Record\r
+             );\r
   if (EFI_ERROR (Status)) {\r
     return EFI_ABORTED;\r
   }\r
@@ -439,7 +467,7 @@ FtwWrite (
   //\r
   // Allocate a memory buffer\r
   //\r
-  MyBufferSize  = FtwDevice->SpareAreaLength;\r
+  MyBufferSize  = WriteLength;\r
   MyBuffer      = AllocatePool (MyBufferSize);\r
   if (MyBuffer == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
@@ -448,8 +476,8 @@ FtwWrite (
   // Read all original data from target block to memory buffer\r
   //\r
   Ptr = MyBuffer;\r
-  for (Index = 0; Index < FtwDevice->NumberOfSpareBlock; Index += 1) {\r
-    MyLength  = FtwDevice->BlockSize;\r
+  for (Index = 0; Index < NumberOfWriteBlocks; Index += 1) {\r
+    MyLength  = BlockSize;\r
     Status    = Fvb->Read (Fvb, Lba + Index, 0, &MyLength, Ptr);\r
     if (EFI_ERROR (Status)) {\r
       FreePool (MyBuffer);\r
@@ -477,7 +505,7 @@ FtwWrite (
 \r
   Ptr = SpareBuffer;\r
   for (Index = 0; Index < FtwDevice->NumberOfSpareBlock; Index += 1) {\r
-    MyLength = FtwDevice->BlockSize;\r
+    MyLength = FtwDevice->SpareBlockSize;\r
     Status = FtwDevice->FtwBackupFvb->Read (\r
                                         FtwDevice->FtwBackupFvb,\r
                                         FtwDevice->FtwSpareLba + Index,\r
@@ -495,11 +523,16 @@ FtwWrite (
   }\r
   //\r
   // Write the memory buffer to spare block\r
+  // Do not assume Spare Block and Target Block have same block size\r
   //\r
   Status  = FtwEraseSpareBlock (FtwDevice);\r
   Ptr     = MyBuffer;\r
-  for (Index = 0; Index < FtwDevice->NumberOfSpareBlock; Index += 1) {\r
-    MyLength = FtwDevice->BlockSize;\r
+  for (Index = 0; MyBufferSize > 0; Index += 1) {\r
+    if (MyBufferSize > FtwDevice->SpareBlockSize) {\r
+      MyLength = FtwDevice->SpareBlockSize;\r
+    } else {\r
+      MyLength = MyBufferSize;\r
+    }\r
     Status = FtwDevice->FtwBackupFvb->Write (\r
                                         FtwDevice->FtwBackupFvb,\r
                                         FtwDevice->FtwSpareLba + Index,\r
@@ -514,6 +547,7 @@ FtwWrite (
     }\r
 \r
     Ptr += MyLength;\r
+    MyBufferSize -= MyLength;\r
   }\r
   //\r
   // Free MyBuffer\r
@@ -526,6 +560,7 @@ FtwWrite (
   MyOffset = (UINT8 *) Record - FtwDevice->FtwWorkSpace;\r
   Status = FtwUpdateFvState (\r
             FtwDevice->FtwFvBlock,\r
+            FtwDevice->WorkBlockSize,\r
             FtwDevice->FtwWorkSpaceLba,\r
             FtwDevice->FtwWorkSpaceBase + MyOffset,\r
             SPARE_COMPLETED\r
@@ -541,7 +576,7 @@ FtwWrite (
   //  Since the content has already backuped in spare block, the write is\r
   //  guaranteed to be completed with fault tolerant manner.\r
   //\r
-  Status = FtwWriteRecord (This, Fvb);\r
+  Status = FtwWriteRecord (This, Fvb, BlockSize);\r
   if (EFI_ERROR (Status)) {\r
     FreePool (SpareBuffer);\r
     return EFI_ABORTED;\r
@@ -552,7 +587,7 @@ FtwWrite (
   Status  = FtwEraseSpareBlock (FtwDevice);\r
   Ptr     = SpareBuffer;\r
   for (Index = 0; Index < FtwDevice->NumberOfSpareBlock; Index += 1) {\r
-    MyLength = FtwDevice->BlockSize;\r
+    MyLength = FtwDevice->SpareBlockSize;\r
     Status = FtwDevice->FtwBackupFvb->Write (\r
                                         FtwDevice->FtwBackupFvb,\r
                                         FtwDevice->FtwSpareLba + Index,\r
@@ -573,7 +608,7 @@ FtwWrite (
   FreePool (SpareBuffer);\r
 \r
   DEBUG (\r
-    (EFI_D_ERROR,\r
+    (EFI_D_INFO,\r
     "Ftw: Write() success, (Lba:Offset)=(%lx:0x%x), Length: 0x%x\n",\r
     Lba,\r
     Offset,\r
@@ -609,6 +644,8 @@ FtwRestart (
   EFI_FAULT_TOLERANT_WRITE_HEADER     *Header;\r
   EFI_FAULT_TOLERANT_WRITE_RECORD     *Record;\r
   EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *Fvb;\r
+  UINTN                               BlockSize;\r
+  UINTN                               NumberOfBlocks;\r
 \r
   FtwDevice = FTW_CONTEXT_FROM_THIS (This);\r
 \r
@@ -629,6 +666,15 @@ FtwRestart (
     return EFI_NOT_FOUND;\r
   }\r
 \r
+  //\r
+  // Now, one FVB has one type of BlockSize\r
+  //\r
+  Status = Fvb->GetBlockSize (Fvb, 0, &BlockSize, &NumberOfBlocks);\r
+  if (EFI_ERROR (Status)) {\r
+    DEBUG ((EFI_D_ERROR, "Ftw: Restart(), Get block size - %r\n", Status));\r
+    return EFI_ABORTED;\r
+  }\r
+\r
   //\r
   // Check the COMPLETE flag of last write header\r
   //\r
@@ -651,7 +697,7 @@ FtwRestart (
   //  Since the content has already backuped in spare block, the write is\r
   //  guaranteed to be completed with fault tolerant manner.\r
   //\r
-  Status = FtwWriteRecord (This, Fvb);\r
+  Status = FtwWriteRecord (This, Fvb, BlockSize);\r
   if (EFI_ERROR (Status)) {\r
     return EFI_ABORTED;\r
   }\r
@@ -706,6 +752,7 @@ FtwAbort (
   Offset = (UINT8 *) FtwDevice->FtwLastWriteHeader - FtwDevice->FtwWorkSpace;\r
   Status = FtwUpdateFvState (\r
             FtwDevice->FtwFvBlock,\r
+            FtwDevice->WorkBlockSize,\r
             FtwDevice->FtwWorkSpaceLba,\r
             FtwDevice->FtwWorkSpaceBase + Offset,\r
             WRITES_COMPLETED\r