summaryrefslogtreecommitdiff
path: root/OvmfPkg/MemDebugLogPei/MemDebugLog.c
blob: e557202c6de85f508ada85256b11a6bec43e47f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/** @file

  Memory Debug Log PEIM

  Copyright (C) 2025, Oracle and/or its affiliates.

  SPDX-License-Identifier: BSD-2-Clause-Patent
**/

#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/HobLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/PeiServicesLib.h>
#include <Library/PeimEntryPoint.h>
#include <Library/PcdLib.h>
#include <Library/MemDebugLogLib.h>

EFI_STATUS
EFIAPI
MemDebugLogMemAvailCB (
  IN EFI_PEI_SERVICES           **PeiServices,
  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,
  IN VOID                       *Ppi
  );

CONST EFI_PEI_NOTIFY_DESCRIPTOR  mMemAvailNotifyList[] = {
  {
    (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
    &gEfiPeiMemoryDiscoveredPpiGuid,
    MemDebugLogMemAvailCB
  }
};

EFI_STATUS
EFIAPI
MemDebugLogMemAvailCB (
  IN EFI_PEI_SERVICES           **PeiServices,
  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,
  IN VOID                       *Ppi
  )
{
  UINT32                  MemDebugLogBufPages;
  EFI_PHYSICAL_ADDRESS    MemDebugLogBufAddr;
  EFI_HOB_GUID_TYPE       *GuidHob;
  MEM_DEBUG_LOG_HOB_DATA  *HobData;
  EFI_STATUS              Status;

  MemDebugLogBufPages = MemDebugLogPages ();

  //
  // Buffer size of 0 disables memory debug logging.
  //
  if (!MemDebugLogBufPages) {
    MemDebugLogBufAddr = 0;
    Status             = EFI_SUCCESS;
    goto done;
  }

  //
  // Allocate the memory debug log buffer.
  // NOTE: We allocate the buffer as type EfiRuntimeServicesData
  // as this seems to allow the buffer to persist and be
  // accessible/modifiable throughout runtime (i.e. and avoid
  // being locked down by the MemoryAttributesTable code).
  //
  Status = PeiServicesAllocatePages (
             EfiRuntimeServicesData,
             MemDebugLogBufPages,
             &MemDebugLogBufAddr
             );
  if (EFI_ERROR (Status)) {
    DEBUG ((DEBUG_ERROR, "%a: Failed to allocate Memory Debug Log buffer: %r. Logging disabled\n", __func__, Status));
    MemDebugLogBufAddr = 0;
    goto done;
  }

  //
  // Init the debug log buffer
  //
  Status = MemDebugLogInit (MemDebugLogBufAddr, (UINT32)EFI_PAGES_TO_SIZE ((UINTN)MemDebugLogBufPages));
  if (EFI_ERROR (Status)) {
    DEBUG ((DEBUG_ERROR, "%a: Failed to init Memory Debug Log buffer: %r. Logging disabled\n", __func__, Status));
    PeiServicesFreePages (MemDebugLogBufAddr, MemDebugLogBufPages);
    MemDebugLogBufAddr = 0;
    goto done;
  }

  //
  // Copy over the messages from the Early Debug Log buffer.
  //
  if (FixedPcdGet32 (PcdOvmfEarlyMemDebugLogBase) != 0) {
    MemDebugLogCopy (MemDebugLogBufAddr, (EFI_PHYSICAL_ADDRESS)(UINTN)FixedPcdGet32 (PcdOvmfEarlyMemDebugLogBase));
  }

done:
  //
  // Zero the early buffer if we successfully
  // created the main memory log buffer.
  //
  if ((Status == EFI_SUCCESS) && (FixedPcdGet32 (PcdOvmfEarlyMemDebugLogBase) != 0)) {
    ZeroMem (
      (VOID *)(UINTN)FixedPcdGet32 (PcdOvmfEarlyMemDebugLogBase),
      (UINT32)FixedPcdGet32 (PcdOvmfEarlyMemDebugLogSize)
      );
  }

  //
  // Create HOB to pass mem debug log buffer addr
  //
  Status = PeiServicesCreateHob (
             EFI_HOB_TYPE_GUID_EXTENSION,
             (UINT16)(sizeof (EFI_HOB_GUID_TYPE) + sizeof (MEM_DEBUG_LOG_HOB_DATA)),
             (VOID **)&GuidHob
             );
  if (EFI_ERROR (Status)) {
    if (MemDebugLogBufAddr) {
      PeiServicesFreePages (MemDebugLogBufAddr, MemDebugLogBufPages);
    }
  } else {
    //
    // Populate the HOB
    //
    CopyGuid (&GuidHob->Name, &gMemDebugLogHobGuid);
    HobData                     = (MEM_DEBUG_LOG_HOB_DATA *)GET_GUID_HOB_DATA (GuidHob);
    HobData->MemDebugLogBufAddr = MemDebugLogBufAddr;
  }

  return Status;
}

EFI_STATUS
EFIAPI
MemDebugLogEntry (
  IN       EFI_PEI_FILE_HANDLE  FileHandle,
  IN CONST EFI_PEI_SERVICES     **PeiServices
  )
{
  EFI_STATUS  Status;

  //
  // Setup callback for memory available notification
  //
  Status = PeiServicesNotifyPpi (mMemAvailNotifyList);
  if (EFI_ERROR (Status)) {
    DEBUG ((DEBUG_ERROR, "%a: Failed to create MemDebugLog PEIM Callback: %r. Logging disabled\n", __func__, Status));
  }

  return Status;
}