MdeModulePkg/Core/Dxe/Misc/DebugImageInfo.c

   1 /** @file
   2   Support functions for managing debug image info table when loading and unloading
   3   images.
   4
   5 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #include "DxeMain.h"
  17
  18
  19 EFI_DEBUG_IMAGE_INFO_TABLE_HEADER  mDebugInfoTableHeader = {
  20   0,          // volatile UINT32                 UpdateStatus;
  21   0,          // UINT32                          TableSize;
  22   NULL        // EFI_DEBUG_IMAGE_INFO            *EfiDebugImageInfoTable;
  23 };
  24
  25 EFI_SYSTEM_TABLE_POINTER *mDebugTable = NULL;
  26
  27 #define FOUR_MEG_ALIGNMENT   0x400000
  28
  29 #define EFI_DEBUG_TABLE_ENTRY_SIZE       (sizeof (VOID *))
  30
  31 /**
  32   Creates and initializes the DebugImageInfo Table.  Also creates the configuration
  33   table and registers it into the system table.
  34
  35 **/
  36 VOID
  37 CoreInitializeDebugImageInfoTable (
  38   VOID
  39   )
  40 {
  41   EFI_STATUS                          Status;
  42
  43   //
  44   // Allocate 4M aligned page for the structure and fill in the data.
  45   // Ideally we would update the CRC now as well, but the service may not yet be available.
  46   // See comments in the CoreUpdateDebugTableCrc32() function below for details.
  47   //
  48   mDebugTable = AllocateAlignedPages (EFI_SIZE_TO_PAGES (sizeof (EFI_SYSTEM_TABLE_POINTER)), FOUR_MEG_ALIGNMENT);
  49   mDebugTable->Signature = EFI_SYSTEM_TABLE_SIGNATURE;
  50   mDebugTable->EfiSystemTableBase = (EFI_PHYSICAL_ADDRESS) (UINTN) gDxeCoreST;
  51   mDebugTable->Crc32 = 0;
  52   Status = CoreInstallConfigurationTable (&gEfiDebugImageInfoTableGuid, &mDebugInfoTableHeader);
  53   ASSERT_EFI_ERROR (Status);
  54 }
  55
  56
  57 /**
  58   Update the CRC32 in the Debug Table.
  59   Since the CRC32 service is made available by the Runtime driver, we have to
  60   wait for the Runtime Driver to be installed before the CRC32 can be computed.
  61   This function is called elsewhere by the core when the runtime architectural
  62   protocol is produced.
  63
  64 **/
  65 VOID
  66 CoreUpdateDebugTableCrc32 (
  67   VOID
  68   )
  69 {
  70   ASSERT(mDebugTable != NULL);
  71   mDebugTable->Crc32 = 0;
  72   gBS->CalculateCrc32 ((VOID *)mDebugTable, sizeof (EFI_SYSTEM_TABLE_POINTER), &mDebugTable->Crc32);
  73 }
  74
  75
  76 /**
  77   Adds a new DebugImageInfo structure to the DebugImageInfo Table.  Re-Allocates
  78   the table if it's not large enough to accomidate another entry.
  79
  80   @param  ImageInfoType  type of debug image information
  81   @param  LoadedImage    pointer to the loaded image protocol for the image being
  82                          loaded
  83   @param  ImageHandle    image handle for the image being loaded
  84
  85 **/
  86 VOID
  87 CoreNewDebugImageInfoEntry (
  88   IN  UINT32                      ImageInfoType,
  89   IN  EFI_LOADED_IMAGE_PROTOCOL   *LoadedImage,
  90   IN  EFI_HANDLE                  ImageHandle
  91   )
  92 {
  93   EFI_DEBUG_IMAGE_INFO      *Table;
  94   EFI_DEBUG_IMAGE_INFO      *NewTable;
  95   UINTN                     Index;
  96   UINTN                     MaxTableIndex;
  97   UINTN                     TableSize;
  98
  99   //
 100   // Set the flag indicating that we're in the process of updating the table.
 101   //
 102   mDebugInfoTableHeader.UpdateStatus |= EFI_DEBUG_IMAGE_INFO_UPDATE_IN_PROGRESS;
 103
 104   Table = mDebugInfoTableHeader.EfiDebugImageInfoTable;
 105   MaxTableIndex = mDebugInfoTableHeader.TableSize;
 106
 107   for (Index = 0; Index < MaxTableIndex; Index++) {
 108     if (Table[Index].NormalImage == NULL) {
 109       //
 110       // We have found a free entry so exit the loop
 111       //
 112       break;
 113     }
 114   }
 115   if (Index == MaxTableIndex) {
 116     //
 117     //  Table is full, so re-allocate another page for a larger table...
 118     //
 119     TableSize = MaxTableIndex * EFI_DEBUG_TABLE_ENTRY_SIZE;
 120     NewTable = AllocateZeroPool (TableSize + EFI_PAGE_SIZE);
 121     if (NewTable == NULL) {
 122       mDebugInfoTableHeader.UpdateStatus &= ~EFI_DEBUG_IMAGE_INFO_UPDATE_IN_PROGRESS;
 123       return;
 124     }
 125     //
 126     // Copy the old table into the new one
 127     //
 128     CopyMem (NewTable, Table, TableSize);
 129     //
 130     // Free the old table
 131     //
 132     CoreFreePool (Table);
 133     //
 134     // Update the table header
 135     //
 136     Table = NewTable;
 137     mDebugInfoTableHeader.EfiDebugImageInfoTable = NewTable;
 138     mDebugInfoTableHeader.TableSize += EFI_PAGE_SIZE / EFI_DEBUG_TABLE_ENTRY_SIZE;
 139   }
 140   //
 141   // Allocate data for new entry
 142   //
 143   Table[Index].NormalImage = AllocateZeroPool (sizeof (EFI_DEBUG_IMAGE_INFO_NORMAL));
 144   if (Table[Index].NormalImage != NULL) {
 145     //
 146     // Update the entry
 147     //
 148     Table[Index].NormalImage->ImageInfoType               = (UINT32) ImageInfoType;
 149     Table[Index].NormalImage->LoadedImageProtocolInstance = LoadedImage;
 150     Table[Index].NormalImage->ImageHandle                 = ImageHandle;
 151   }
 152   mDebugInfoTableHeader.UpdateStatus &= ~EFI_DEBUG_IMAGE_INFO_UPDATE_IN_PROGRESS;
 153 }
 154
 155
 156
 157 /**
 158   Removes and frees an entry from the DebugImageInfo Table.
 159
 160   @param  ImageHandle    image handle for the image being unloaded
 161
 162 **/
 163 VOID
 164 CoreRemoveDebugImageInfoEntry (
 165   EFI_HANDLE ImageHandle
 166   )
 167 {
 168   EFI_DEBUG_IMAGE_INFO  *Table;
 169   UINTN                 Index;
 170
 171   mDebugInfoTableHeader.UpdateStatus |= EFI_DEBUG_IMAGE_INFO_UPDATE_IN_PROGRESS;
 172
 173   Table = mDebugInfoTableHeader.EfiDebugImageInfoTable;
 174
 175   for (Index = 0; Index < mDebugInfoTableHeader.TableSize; Index++) {
 176     if (Table[Index].NormalImage != NULL && Table[Index].NormalImage->ImageHandle == ImageHandle) {
 177       //
 178       // Found a match. Free up the record, then NULL the pointer to indicate the slot
 179       // is free.
 180       //
 181       CoreFreePool (Table[Index].NormalImage);
 182       Table[Index].NormalImage = NULL;
 183       break;
 184     }
 185   }
 186   mDebugInfoTableHeader.UpdateStatus &= ~EFI_DEBUG_IMAGE_INFO_UPDATE_IN_PROGRESS;
 187 }
 188
 189