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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/* $Id$ */
/** @file
* Console.c - VirtualBox Console control emulation
*/
/*
* Copyright (C) 2010-2022 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DebugLib.h>
#include <Library/UefiLib.h>
#include "VBoxPkg.h"
#include "DataHub.h"
/**
* Data hub logged entry.
*/
typedef struct
{
/** List node for the linked list - must be at the top. */
LIST_ENTRY NdEntries;
/** The record header. */
EFI_DATA_RECORD_HEADER RecHdr;
/** The data logged, variable in size. */
UINT8 abData[1];
} EFI_DATA_HUB_ENTRY;
/**
* DataHub instance data.
*/
typedef struct
{
/** Monotonic increasing counter. */
UINT64 cMonotonicCnt;
/** Linked list holding the logged entries. */
LIST_ENTRY LstEntries;
/** The lock protecting the key members above. */
EFI_LOCK Lck;
} EFI_DATA_HUB_INSTANCE;
EFI_DATA_HUB_INSTANCE mDataHubInstance;
EFI_STATUS EFIAPI
DataHubLogData (
IN EFI_DATA_HUB_PROTOCOL *This,
IN EFI_GUID *DataRecordGuid,
IN EFI_GUID *ProducerName,
IN UINT64 DataRecordClass,
IN VOID *RawData,
IN UINT32 RawDataSize
)
{
UINT32 cbEntry = sizeof(EFI_DATA_HUB_ENTRY) + RawDataSize;
EFI_DATA_HUB_ENTRY *pEntry = AllocatePool(cbEntry);
if (pEntry == NULL)
return EFI_OUT_OF_RESOURCES;
pEntry->RecHdr.Version = EFI_DATA_RECORD_HEADER_VERSION;
pEntry->RecHdr.HeaderSize = sizeof(EFI_DATA_RECORD_HEADER);
pEntry->RecHdr.RecordSize = RawDataSize + sizeof(EFI_DATA_RECORD_HEADER);
CopyMem(&pEntry->RecHdr.DataRecordGuid, DataRecordGuid, sizeof(pEntry->RecHdr.DataRecordGuid));
CopyMem(&pEntry->RecHdr.ProducerName, ProducerName, sizeof(pEntry->RecHdr.ProducerName));
pEntry->RecHdr.DataRecordClass = DataRecordClass;
SetMem(&pEntry->RecHdr.LogTime, sizeof(pEntry->RecHdr.LogTime), 0);
pEntry->RecHdr.LogMonotonicCount = ++mDataHubInstance.cMonotonicCnt; /* Ensure non zero value in record. */
CopyMem(&pEntry->abData[0], RawData, RawDataSize);
EfiAcquireLock(&mDataHubInstance.Lck);
InsertTailList(&mDataHubInstance.LstEntries, &pEntry->NdEntries);
EfiReleaseLock(&mDataHubInstance.Lck);
return EFI_SUCCESS;
}
EFI_STATUS EFIAPI
DataHubGetNextDataRecord (
IN EFI_DATA_HUB_PROTOCOL *This,
IN OUT UINT64 *MonotonicCount,
IN EFI_EVENT *FilterDriver OPTIONAL,
OUT EFI_DATA_RECORD_HEADER **Record
)
{
EFI_DATA_HUB_ENTRY *pEntry = NULL;
EfiAcquireLock(&mDataHubInstance.Lck);
if (*MonotonicCount == 0)
{
if (!IsListEmpty(&mDataHubInstance.LstEntries))
pEntry = (EFI_DATA_HUB_ENTRY *)GetFirstNode(&mDataHubInstance.LstEntries);
}
else
{
/* Ignore filter driver handling for now. */
LIST_ENTRY *pHead = &mDataHubInstance.LstEntries;
LIST_ENTRY *pIt = NULL;
for (pIt = GetFirstNode(pHead); pIt != pHead; pIt = GetNextNode(pHead, pIt))
{
EFI_DATA_HUB_ENTRY *pTmp = (EFI_DATA_HUB_ENTRY *)pIt;
if (pTmp->RecHdr.LogMonotonicCount == *MonotonicCount)
{
pEntry = pTmp;
break;
}
}
}
EfiReleaseLock(&mDataHubInstance.Lck);
if (pEntry == NULL)
return EFI_NOT_FOUND;
*Record = &pEntry->RecHdr;
/* Look for the next entry and set MonotonicCount accordingly. */
if (!IsNodeAtEnd(&mDataHubInstance.LstEntries, &pEntry->NdEntries))
{
pEntry = (EFI_DATA_HUB_ENTRY *)GetNextNode(&mDataHubInstance.LstEntries, &pEntry->NdEntries);
*MonotonicCount = pEntry->RecHdr.LogMonotonicCount;
}
else
*MonotonicCount = 0;
return EFI_SUCCESS;
}
EFI_STATUS EFIAPI
DataHubRegisterDataFilterDriver (
IN EFI_DATA_HUB_PROTOCOL *This,
IN EFI_EVENT FilterEvent,
IN EFI_TPL FilterTpl,
IN UINT64 FilterClass,
IN EFI_GUID *FilterDataRecordGui OPTIONAL
)
{
return EFI_SUCCESS;
}
EFI_STATUS EFIAPI
DataHubUnregisterDataFilterDriver (
IN EFI_DATA_HUB_PROTOCOL *This,
IN EFI_EVENT FilterEvent
)
{
return EFI_SUCCESS;
}
EFI_DATA_HUB_PROTOCOL gDataHub =
{
DataHubLogData,
DataHubGetNextDataRecord,
DataHubRegisterDataFilterDriver,
DataHubUnregisterDataFilterDriver
};
EFI_GUID gEfiDataHubProtocolGuid = EFI_DATA_HUB_PROTOCOL_GUID;
EFI_STATUS
EFIAPI
InitializeDataHub (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
InitializeListHead(&mDataHubInstance.LstEntries);
EfiInitializeLock (&mDataHubInstance.Lck, TPL_NOTIFY);
Status = gBS->InstallMultipleProtocolInterfaces (
&ImageHandle,
&gEfiDataHubProtocolGuid,
&gDataHub,
NULL);
ASSERT_EFI_ERROR (Status);
return Status;
}
|
