MdeModulePkg/Core/RuntimeDxe/Runtime.c

   1 /*++
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   Runtime.c
  15
  16 Abstract:
  17
  18   Runtime Architectural Protocol as defined in the DXE CIS
  19
  20   This code is used to produce the EFI runtime virtual switch over
  21
  22   THIS IS VERY DANGEROUS CODE BE VERY CAREFUL IF YOU CHANGE IT
  23
  24   The transition for calling EFI Runtime functions in physical mode to calling
  25   them in virtual mode is very very complex. Every pointer in needs to be
  26   converted from physical mode to virtual mode. Be very careful walking linked
  27   lists! Then to make it really hard the code it's self needs be relocated into
  28   the new virtual address space.
  29
  30   So here is the concept. The code in this module will never ever be called in
  31   virtual mode. This is the code that collects the information needed to convert
  32   to virtual mode (DXE core registers runtime stuff with this code). Since this
  33   code is used to fixup all runtime images, it CAN NOT fix it's self up. So some
  34   code has to stay behind and that is us.
  35
  36   Also you need to be careful about when you allocate memory, as once we are in
  37   runtime (including our EVT_SIGNAL_EXIT_BOOT_SERVICES event) you can no longer
  38   allocate memory.
  39
  40   Any runtime driver that gets loaded before us will not be callable in virtual
  41   mode. This is due to the fact that the DXE core can not register the info
  42   needed with us. This is good, since it keeps the code in this file from
  43   getting registered.
  44
  45
  46 Revision History:
  47
  48   - Move the CalculateCrc32 function from Runtime Arch Protocol to Boot Service.
  49   Runtime Arch Protocol definition no longer contains CalculateCrc32. Boot Service
  50   Table now contains an item named CalculateCrc32.
  51
  52 --*/
  53
  54 #include "Runtime.h"
  55
  56 //
  57 // Global Variables
  58 //
  59 EFI_MEMORY_DESCRIPTOR         *mVirtualMap                = NULL;
  60 UINTN                         mVirtualMapDescriptorSize;
  61 UINTN                         mVirtualMapMaxIndex;
  62 VOID                          *mMyImageBase;
  63
  64 //
  65 // The handle onto which the Runtime Architectural Protocol instance is installed
  66 //
  67 EFI_HANDLE                    mRuntimeHandle = NULL;
  68
  69 //
  70 // The Runtime Architectural Protocol instance produced by this driver
  71 //
  72 EFI_RUNTIME_ARCH_PROTOCOL     mRuntime = {
  73   INITIALIZE_LIST_HEAD_VARIABLE (mRuntime.ImageHead),
  74   INITIALIZE_LIST_HEAD_VARIABLE (mRuntime.EventHead),
  75
  76   //
  77   // Make sure Size != sizeof (EFI_MEMORY_DESCRIPTOR). This will
  78   // prevent people from having pointer math bugs in their code.
  79   // now you have to use *DescriptorSize to make things work.
  80   //
  81   sizeof (EFI_MEMORY_DESCRIPTOR) + sizeof (UINT64) - (sizeof (EFI_MEMORY_DESCRIPTOR) % sizeof (UINT64)),
  82   EFI_MEMORY_DESCRIPTOR_VERSION,
  83   0,
  84   NULL,
  85   NULL,
  86   FALSE,
  87   FALSE
  88 };
  89
  90 //
  91 // Worker Functions
  92 //
  93 STATIC
  94 VOID
  95 RuntimeDriverCalculateEfiHdrCrc (
  96   IN OUT EFI_TABLE_HEADER  *Hdr
  97   )
  98 /*++
  99
 100 Routine Description:
 101
 102   Calcualte the 32-bit CRC in a EFI table using the Runtime Drivers
 103   internal function.  The EFI Boot Services Table can not be used because
 104   the EFI Boot Services Table was destroyed at ExitBootServices()
 105
 106 Arguments:
 107
 108   Hdr  - Pointer to an EFI standard header
 109
 110 Returns:
 111
 112   None
 113
 114 --*/
 115 {
 116   UINT32  Crc;
 117
 118   Hdr->CRC32  = 0;
 119
 120   Crc         = 0;
 121   RuntimeDriverCalculateCrc32 ((UINT8 *) Hdr, Hdr->HeaderSize, &Crc);
 122   Hdr->CRC32 = Crc;
 123 }
 124
 125 EFI_STATUS
 126 EFIAPI
 127 RuntimeDriverConvertPointer (
 128   IN     UINTN  DebugDisposition,
 129   IN OUT VOID   **ConvertAddress
 130   )
 131 /*++
 132
 133 Routine Description:
 134
 135   Determines the new virtual address that is to be used on subsequent memory accesses.
 136
 137 Arguments:
 138
 139   DebugDisposition    - Supplies type information for the pointer being converted.
 140   ConvertAddress      - A pointer to a pointer that is to be fixed to be the value needed
 141                         for the new virtual address mappings being applied.
 142
 143 Returns:
 144
 145   EFI_SUCCESS             - The pointer pointed to by Address was modified.
 146   EFI_NOT_FOUND           - The pointer pointed to by Address was not found to be part
 147                             of the current memory map. This is normally fatal.
 148   EFI_INVALID_PARAMETER   - One of the parameters has an invalid value.
 149
 150 --*/
 151 {
 152   UINTN                 Address;
 153   UINT64                VirtEndOfRange;
 154   EFI_MEMORY_DESCRIPTOR *VirtEntry;
 155   UINTN                 Index;
 156
 157   //
 158   // Make sure ConvertAddress is a valid pointer
 159   //
 160   if (ConvertAddress == NULL) {
 161     return EFI_INVALID_PARAMETER;
 162   }
 163   //
 164   // Get the address to convert
 165   //
 166   Address = (UINTN) *ConvertAddress;
 167
 168   //
 169   // If this is a null pointer, return if it's allowed
 170   //
 171   if (Address == 0) {
 172     if (DebugDisposition & EFI_OPTIONAL_POINTER) {
 173       return EFI_SUCCESS;
 174     }
 175
 176     return EFI_INVALID_PARAMETER;
 177   }
 178
 179   VirtEntry             = mVirtualMap;
 180   for (Index = 0; Index < mVirtualMapMaxIndex; Index++) {
 181     //
 182     // To prevent the inclusion of 64-bit math functions a UINTN was placed in
 183     //  front of VirtEntry->NumberOfPages to cast it to a 32-bit thing on IA-32
 184     //  platforms. If you get this ASSERT remove the UINTN and do a 64-bit
 185     //  multiply.
 186     //
 187     ASSERT (((UINTN) VirtEntry->NumberOfPages < 0xffffffff) || (sizeof (UINTN) > 4));
 188
 189     if ((VirtEntry->Attribute & EFI_MEMORY_RUNTIME) == EFI_MEMORY_RUNTIME) {
 190       if (Address >= VirtEntry->PhysicalStart) {
 191         VirtEndOfRange = VirtEntry->PhysicalStart + (((UINTN) VirtEntry->NumberOfPages) * EFI_PAGE_SIZE);
 192         if (Address < VirtEndOfRange) {
 193           //
 194           // Compute new address
 195           //
 196           *ConvertAddress = (VOID *) (Address - (UINTN) VirtEntry->PhysicalStart + (UINTN) VirtEntry->VirtualStart);
 197           return EFI_SUCCESS;
 198         }
 199       }
 200     }
 201
 202     VirtEntry = NextMemoryDescriptor (VirtEntry, mVirtualMapDescriptorSize);
 203   }
 204
 205   return EFI_NOT_FOUND;
 206 }
 207
 208 STATIC
 209 EFI_STATUS
 210 RuntimeDriverConvertInternalPointer (
 211   IN OUT VOID   **ConvertAddress
 212   )
 213 /*++
 214
 215 Routine Description:
 216
 217   Determines the new virtual address that is to be used on subsequent memory accesses
 218   for internal pointers.
 219
 220 Arguments:
 221
 222   ConvertAddress  - A pointer to a pointer that is to be fixed to be the value needed
 223                     for the new virtual address mappings being applied.
 224
 225 Returns:
 226
 227   EFI_SUCCESS             - The pointer pointed to by Address was modified.
 228   EFI_NOT_FOUND           - The pointer pointed to by Address was not found to be part
 229                             of the current memory map. This is normally fatal.
 230   EFI_INVALID_PARAMETER   - One of the parameters has an invalid value.
 231
 232 --*/
 233 {
 234   return RuntimeDriverConvertPointer (0x0, ConvertAddress);
 235 }
 236
 237 EFI_STATUS
 238 EFIAPI
 239 RuntimeDriverSetVirtualAddressMap (
 240   IN UINTN                  MemoryMapSize,
 241   IN UINTN                  DescriptorSize,
 242   IN UINT32                 DescriptorVersion,
 243   IN EFI_MEMORY_DESCRIPTOR  *VirtualMap
 244   )
 245 /*++
 246
 247 Routine Description:
 248
 249   Changes the runtime addressing mode of EFI firmware from physical to virtual.
 250
 251 Arguments:
 252
 253   MemoryMapSize     - The size in bytes of VirtualMap.
 254   DescriptorSize    - The size in bytes of an entry in the VirtualMap.
 255   DescriptorVersion - The version of the structure entries in VirtualMap.
 256   VirtualMap        - An array of memory descriptors which contain new virtual
 257                       address mapping information for all runtime ranges.
 258
 259 Returns:
 260
 261   EFI_SUCCESS           - The virtual address map has been applied.
 262   EFI_UNSUPPORTED       - EFI firmware is not at runtime, or the EFI firmware is already in
 263                           virtual address mapped mode.
 264   EFI_INVALID_PARAMETER - DescriptorSize or DescriptorVersion is invalid.
 265   EFI_NO_MAPPING        - A virtual address was not supplied for a range in the memory
 266                           map that requires a mapping.
 267   EFI_NOT_FOUND         - A virtual address was supplied for an address that is not found
 268                           in the memory map.
 269
 270 --*/
 271 {
 272   EFI_STATUS                    Status;
 273   EFI_RUNTIME_EVENT_ENTRY       *RuntimeEvent;
 274   EFI_RUNTIME_IMAGE_ENTRY       *RuntimeImage;
 275   LIST_ENTRY                    *Link;
 276   EFI_PHYSICAL_ADDRESS          VirtImageBase;
 277
 278   //
 279   // Can only switch to virtual addresses once the memory map is locked down,
 280   // and can only set it once
 281   //
 282   if (!mRuntime.AtRuntime || mRuntime.VirtualMode) {
 283     return EFI_UNSUPPORTED;
 284   }
 285   //
 286   // Only understand the original descriptor format
 287   //
 288   if (DescriptorVersion != EFI_MEMORY_DESCRIPTOR_VERSION || DescriptorSize < sizeof (EFI_MEMORY_DESCRIPTOR)) {
 289     return EFI_INVALID_PARAMETER;
 290   }
 291   //
 292   // We are now committed to go to virtual mode, so lets get to it!
 293   //
 294   mRuntime.VirtualMode = TRUE;
 295
 296   //
 297   // ConvertPointer() needs this mVirtualMap to do the conversion. So set up
 298   // globals we need to parse the virtual address map.
 299   //
 300   mVirtualMapDescriptorSize = DescriptorSize;
 301   mVirtualMapMaxIndex       = MemoryMapSize / DescriptorSize;
 302   mVirtualMap               = VirtualMap;
 303
 304   //
 305   // Currently the bug in StatusCode/RuntimeLib has been fixed, it will
 306   // check whether in Runtime or not (this is judged by looking at
 307   // mEfiAtRuntime global So this ReportStatusCode will work
 308   //
 309   REPORT_STATUS_CODE (EFI_PROGRESS_CODE, PcdGet32 (PcdStatusCodeValueSetVirtualAddressMap));
 310
 311   //
 312   // Signal all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE events.
 313   // All runtime events are stored in a list in Runtime AP.
 314   //
 315   for (Link = mRuntime.EventHead.ForwardLink; Link != &mRuntime.EventHead; Link = Link->ForwardLink) {
 316     RuntimeEvent = _CR (Link, EFI_RUNTIME_EVENT_ENTRY, Link);
 317     if ((RuntimeEvent->Type & EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE) == EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE) {
 318       RuntimeEvent->NotifyFunction (
 319                       RuntimeEvent->Event,
 320                       RuntimeEvent->NotifyContext
 321                       );
 322     }
 323   }
 324
 325   //
 326   // Relocate runtime images. All runtime images are stored in a list in Runtime AP.
 327   //
 328   for (Link = mRuntime.ImageHead.ForwardLink; Link != &mRuntime.ImageHead; Link = Link->ForwardLink) {
 329     RuntimeImage = _CR (Link, EFI_RUNTIME_IMAGE_ENTRY, Link);
 330     //
 331     // We don't want to relocate our selves, as we only run in physical mode.
 332     //
 333     if (mMyImageBase != RuntimeImage->ImageBase) {
 334
 335       VirtImageBase = (EFI_PHYSICAL_ADDRESS) (UINTN) RuntimeImage->ImageBase;
 336       Status  = RuntimeDriverConvertPointer (0, (VOID **) &VirtImageBase);
 337       ASSERT_EFI_ERROR (Status);
 338
 339       PeCoffLoaderRelocateImageForRuntime (
 340         (EFI_PHYSICAL_ADDRESS) (UINTN) RuntimeImage->ImageBase,
 341         VirtImageBase,
 342         (UINTN) RuntimeImage->ImageSize,
 343         RuntimeImage->RelocationData
 344         );
 345
 346       InvalidateInstructionCacheRange (RuntimeImage->ImageBase, (UINTN)RuntimeImage->ImageSize);
 347     }
 348   }
 349
 350   //
 351   // Convert all the Runtime Services except ConvertPointer() and SetVirtualAddressMap()
 352   // and recompute the CRC-32
 353   //
 354   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->GetTime);
 355   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->SetTime);
 356   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->GetWakeupTime);
 357   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->SetWakeupTime);
 358   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->ResetSystem);
 359   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->GetNextHighMonotonicCount);
 360   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->GetVariable);
 361   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->SetVariable);
 362   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->GetNextVariableName);
 363   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->QueryVariableInfo);
 364   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->UpdateCapsule);
 365   RuntimeDriverConvertInternalPointer ((VOID **) &gRT->QueryCapsuleCapabilities);
 366   RuntimeDriverCalculateEfiHdrCrc (&gRT->Hdr);
 367
 368   //
 369   // BugBug: PI requires System Configuration Tables Conversion.
 370   // Currently, we do not implement it.
 371   //
 372
 373   //
 374   // Convert the runtime fields of the EFI System Table and recompute the CRC-32
 375   //
 376   RuntimeDriverConvertInternalPointer ((VOID **) &gST->FirmwareVendor);
 377   RuntimeDriverConvertInternalPointer ((VOID **) &gST->ConfigurationTable);
 378   RuntimeDriverConvertInternalPointer ((VOID **) &gST->RuntimeServices);
 379   RuntimeDriverCalculateEfiHdrCrc (&gST->Hdr);
 380
 381   //
 382   // At this point, gRT and gST are physical pointers, but the contents of these tables
 383   // have been converted to runtime.
 384   //
 385   //
 386   // mVirtualMap is only valid during SetVirtualAddressMap() call
 387   //
 388   mVirtualMap = NULL;
 389
 390   return EFI_SUCCESS;
 391 }
 392
 393 EFI_STATUS
 394 EFIAPI
 395 RuntimeDriverInitialize (
 396   IN EFI_HANDLE                            ImageHandle,
 397   IN EFI_SYSTEM_TABLE                      *SystemTable
 398   )
 399 /*++
 400
 401 Routine Description:
 402   Install Runtime AP. This code includes the EfiDriverLib, but it functions at
 403   RT in physical mode. The only Lib services are gBS, gRT, and the DEBUG and
 404   ASSERT macros (they do ReportStatusCode).
 405
 406 Arguments:
 407   (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)
 408
 409 Returns:
 410
 411   EFI_SUCEESS - Runtime Driver Architectural Protocol Installed
 412
 413   Other       - Return value from gBS->InstallMultipleProtocolInterfaces
 414
 415 --*/
 416 {
 417   EFI_STATUS                Status;
 418   EFI_LOADED_IMAGE_PROTOCOL *MyLoadedImage;
 419
 420   //
 421   // This image needs to be exclued from relocation for virtual mode, so cache
 422   // a copy of the Loaded Image protocol to test later.
 423   //
 424   Status = gBS->HandleProtocol (
 425                   ImageHandle,
 426                   &gEfiLoadedImageProtocolGuid,
 427                   (VOID**)&MyLoadedImage
 428                   );
 429   ASSERT_EFI_ERROR (Status);
 430   mMyImageBase = MyLoadedImage->ImageBase;
 431
 432   //
 433   // Initialize the table used to compute 32-bit CRCs
 434   //
 435   RuntimeDriverInitializeCrc32Table ();
 436
 437   //
 438   // Fill in the entries of the EFI Boot Services and EFI Runtime Services Tables
 439   //
 440   gBS->CalculateCrc32       = RuntimeDriverCalculateCrc32;
 441   gRT->SetVirtualAddressMap = RuntimeDriverSetVirtualAddressMap;
 442   gRT->ConvertPointer       = RuntimeDriverConvertPointer;
 443
 444   //
 445   // Install the Runtime Architectural Protocol onto a new handle
 446   //
 447   Status = gBS->InstallMultipleProtocolInterfaces (
 448                   &mRuntimeHandle,
 449                   &gEfiRuntimeArchProtocolGuid,
 450                   &mRuntime,
 451                   NULL
 452                   );
 453   ASSERT_EFI_ERROR (Status);
 454
 455   return EFI_SUCCESS;
 456 }