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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/** @file
This contains some useful functions for accessing files.
Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include <assert.h>
#include <string.h>
#include <ctype.h>
#include <stdlib.h>
#include "CommonLib.h"
#include "MemoryFile.h"
//
// Local (static) function prototypes
//
STATIC
VOID
CheckMemoryFileState (
IN EFI_HANDLE InputMemoryFile
);
//
// Function implementations
//
EFI_STATUS
GetMemoryFile (
IN CHAR8 *InputFileName,
OUT EFI_HANDLE *OutputMemoryFile
)
/*++
Routine Description:
This opens a file, reads it into memory and returns a memory file
object.
Arguments:
InputFile Memory file image.
OutputMemoryFile Handle to memory file
Returns:
EFI_STATUS
OutputMemoryFile is valid if !EFI_ERROR
--*/
{
EFI_STATUS Status;
CHAR8 *InputFileImage;
UINT32 BytesRead;
MEMORY_FILE *NewMemoryFile;
Status = GetFileImage (InputFileName, &InputFileImage, &BytesRead);
if (EFI_ERROR (Status)) {
return Status;
}
NewMemoryFile = malloc (sizeof (*NewMemoryFile));
if (NewMemoryFile == NULL) {
free (InputFileImage);
return EFI_OUT_OF_RESOURCES;
}
NewMemoryFile->FileImage = InputFileImage;
NewMemoryFile->CurrentFilePointer = InputFileImage;
NewMemoryFile->Eof = InputFileImage + BytesRead;
*OutputMemoryFile = (EFI_HANDLE)NewMemoryFile;
CheckMemoryFileState (*OutputMemoryFile);
return EFI_SUCCESS;
}
EFI_STATUS
FreeMemoryFile (
IN EFI_HANDLE InputMemoryFile
)
/*++
Routine Description:
Frees all memory associated with the input memory file.
Arguments:
InputMemoryFile Handle to memory file
Returns:
EFI_STATUS
--*/
{
MEMORY_FILE *MemoryFile;
CheckMemoryFileState (InputMemoryFile);
MemoryFile = (MEMORY_FILE*)InputMemoryFile;
free (MemoryFile->FileImage);
//
// Invalidate state of MEMORY_FILE structure to catch invalid usage.
//
memset (MemoryFile, 0xcc, sizeof (*MemoryFile));
MemoryFile->Eof -= 1;
free (MemoryFile);
return EFI_SUCCESS;
}
CHAR8 *
ReadMemoryFileLine (
IN EFI_HANDLE InputMemoryFile
)
/*++
Routine Description:
This function reads a line from the memory file. The newline characters
are stripped and a null terminated string is returned.
If the string pointer returned is non-NULL, then the caller must free the
memory associated with this string.
Arguments:
InputMemoryFile Handle to memory file
Returns:
NULL if error or EOF
NULL character termincated string otherwise (MUST BE FREED BY CALLER)
--*/
{
CHAR8 *EndOfLine;
UINTN CharsToCopy;
MEMORY_FILE *InputFile;
UINTN BytesToEof;
CHAR8 *OutputString;
//
// Verify input parameters are not null
//
CheckMemoryFileState (InputMemoryFile);
InputFile = (MEMORY_FILE*)InputMemoryFile;
//
// Check for end of file condition
//
if (InputFile->CurrentFilePointer >= InputFile->Eof) {
return NULL;
}
//
// Determine the number of bytes remaining until the EOF
//
BytesToEof = InputFile->Eof - InputFile->CurrentFilePointer;
//
// Find the next newline char
//
EndOfLine = memchr (InputFile->CurrentFilePointer, '\n', BytesToEof);
//
// Determine the number of characters to copy.
//
if (EndOfLine == 0) {
//
// If no newline found, copy to the end of the file.
//
CharsToCopy = InputFile->Eof - InputFile->CurrentFilePointer;
} else {
//
// Newline found in the file.
//
CharsToCopy = EndOfLine - InputFile->CurrentFilePointer;
}
OutputString = malloc (CharsToCopy + 1);
if (OutputString == NULL) {
return NULL;
}
//
// Copy the line.
//
memcpy (OutputString, InputFile->CurrentFilePointer, CharsToCopy);
//
// Add the null termination over the 0x0D
//
if (OutputString[CharsToCopy - 1] == '\r') {
OutputString[CharsToCopy - 1] = '\0';
} else {
OutputString[CharsToCopy] = '\0';
}
//
// Increment the current file pointer (include the 0x0A)
//
InputFile->CurrentFilePointer += CharsToCopy + 1;
if (InputFile->CurrentFilePointer > InputFile->Eof) {
InputFile->CurrentFilePointer = InputFile->Eof;
}
CheckMemoryFileState (InputMemoryFile);
//
// Return the string
//
return OutputString;
}
STATIC
VOID
CheckMemoryFileState (
IN EFI_HANDLE InputMemoryFile
)
{
MEMORY_FILE *MemoryFile;
assert (InputMemoryFile != NULL);
MemoryFile = (MEMORY_FILE*)InputMemoryFile;
assert (MemoryFile->FileImage != NULL);
assert (MemoryFile->CurrentFilePointer != NULL);
assert (MemoryFile->Eof != NULL);
assert (MemoryFile->Eof >= MemoryFile->FileImage);
assert (MemoryFile->CurrentFilePointer >= MemoryFile->FileImage);
assert (MemoryFile->CurrentFilePointer <= MemoryFile->Eof);
}
|
