2 Provides interface to EFI_FILE_HANDLE functionality.
4 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved. <BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <Protocol/SimpleFileSystem.h>
18 #include <Protocol/UnicodeCollation.h>
20 #include <Guid/FileInfo.h>
22 #include <Library/DebugLib.h>
23 #include <Library/MemoryAllocationLib.h>
24 #include <Library/BaseLib.h>
25 #include <Library/BaseMemoryLib.h>
26 #include <Library/FileHandleLib.h>
27 #include <Library/PcdLib.h>
28 #include <Library/PrintLib.h>
30 CONST UINT16 gUnicodeFileTag
= EFI_UNICODE_BYTE_ORDER_MARK
;
32 #define MAX_FILE_NAME_LEN 522 // (20 * (6+5+2))+1) unicode characters from EFI FAT spec (doubled for bytes)
33 #define FIND_XXXXX_FILE_BUFFER_SIZE (SIZE_OF_EFI_FILE_INFO + MAX_FILE_NAME_LEN)
36 This function will retrieve the information about the file for the handle
37 specified and store it in allocated pool memory.
39 This function allocates a buffer to store the file's information. It is the
40 caller's responsibility to free the buffer
42 @param FileHandle The file handle of the file for which information is
45 @retval NULL information could not be retrieved.
47 @return the information about the file
52 IN EFI_FILE_HANDLE FileHandle
55 EFI_FILE_INFO
*FileInfo
;
59 if (FileHandle
== NULL
) {
64 // Get the required size to allocate
68 Status
= FileHandle
->GetInfo(FileHandle
,
72 if (Status
== EFI_BUFFER_TOO_SMALL
){
74 // error is expected. getting size to allocate
76 FileInfo
= AllocateZeroPool(FileInfoSize
);
78 // now get the information
80 Status
= FileHandle
->GetInfo(FileHandle
,
85 // if we got an error free the memory and return NULL
87 if (EFI_ERROR(Status
)) {
96 This function sets the information about the file for the opened handle
99 @param[in] FileHandle The file handle of the file for which information
102 @param[in] FileInfo The information to set.
104 @retval EFI_SUCCESS The information was set.
105 @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.
106 @retval EFI_UNSUPPORTED The FileHandle does not support FileInfo.
107 @retval EFI_NO_MEDIA The device has no medium.
108 @retval EFI_DEVICE_ERROR The device reported an error.
109 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
110 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
111 @retval EFI_ACCESS_DENIED The file was opened read only.
112 @retval EFI_VOLUME_FULL The volume is full.
117 IN EFI_FILE_HANDLE FileHandle
,
118 IN CONST EFI_FILE_INFO
*FileInfo
123 // ASSERT if the FileHandle or FileInfo is NULL
125 ASSERT (FileHandle
!= NULL
);
126 ASSERT (FileInfo
!= NULL
);
131 return (FileHandle
->SetInfo(FileHandle
,
133 (UINTN
)FileInfo
->Size
,
134 (EFI_FILE_INFO
*)FileInfo
));
138 This function reads information from an opened file.
140 If FileHandle is not a directory, the function reads the requested number of
141 bytes from the file at the file's current position and returns them in Buffer.
142 If the read goes beyond the end of the file, the read length is truncated to the
143 end of the file. The file's current position is increased by the number of bytes
144 returned. If FileHandle is a directory, the function reads the directory entry
145 at the file's current position and returns the entry in Buffer. If the Buffer
146 is not large enough to hold the current directory entry, then
147 EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.
148 BufferSize is set to be the size of the buffer needed to read the entry. On
149 success, the current position is updated to the next directory entry. If there
150 are no more directory entries, the read returns a zero-length buffer.
151 EFI_FILE_INFO is the structure returned as the directory entry.
153 @param FileHandle the opened file handle
154 @param BufferSize on input the size of buffer in bytes. on return
155 the number of bytes written.
156 @param Buffer the buffer to put read data into.
158 @retval EFI_SUCCESS Data was read.
159 @retval EFI_NO_MEDIA The device has no media.
160 @retval EFI_DEVICE_ERROR The device reported an error.
161 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
162 @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required
169 IN EFI_FILE_HANDLE FileHandle
,
170 IN OUT UINTN
*BufferSize
,
175 // ASSERT if FileHandle is NULL
177 ASSERT (FileHandle
!= NULL
);
180 // Perform the read based on EFI_FILE_PROTOCOL
182 return (FileHandle
->Read(FileHandle
, BufferSize
, Buffer
));
187 Write data to a file.
189 This function writes the specified number of bytes to the file at the current
190 file position. The current file position is advanced the actual number of bytes
191 written, which is returned in BufferSize. Partial writes only occur when there
192 has been a data error during the write attempt (such as "volume space full").
193 The file is automatically grown to hold the data if required. Direct writes to
194 opened directories are not supported.
196 @param FileHandle The opened file for writing
197 @param BufferSize on input the number of bytes in Buffer. On output
198 the number of bytes written.
199 @param Buffer the buffer containing data to write is stored.
201 @retval EFI_SUCCESS Data was written.
202 @retval EFI_UNSUPPORTED Writes to an open directory are not supported.
203 @retval EFI_NO_MEDIA The device has no media.
204 @retval EFI_DEVICE_ERROR The device reported an error.
205 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
206 @retval EFI_WRITE_PROTECTED The device is write-protected.
207 @retval EFI_ACCESS_DENIED The file was open for read only.
208 @retval EFI_VOLUME_FULL The volume is full.
213 IN EFI_FILE_HANDLE FileHandle
,
214 IN OUT UINTN
*BufferSize
,
219 // ASSERT if FileHandle is NULL
221 ASSERT (FileHandle
!= NULL
);
223 // Perform the write based on EFI_FILE_PROTOCOL
225 return (FileHandle
->Write(FileHandle
, BufferSize
, Buffer
));
229 Close an open file handle.
231 This function closes a specified file handle. All "dirty" cached file data is
232 flushed to the device, and the file is closed. In all cases the handle is
235 @param FileHandle the file handle to close.
237 @retval EFI_SUCCESS the file handle was closed sucessfully.
242 IN EFI_FILE_HANDLE FileHandle
247 // ASSERT if FileHandle is NULL
249 ASSERT (FileHandle
!= NULL
);
251 // Perform the Close based on EFI_FILE_PROTOCOL
253 Status
= FileHandle
->Close(FileHandle
);
258 Delete a file and close the handle
260 This function closes and deletes a file. In all cases the file handle is closed.
261 If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is
262 returned, but the handle is still closed.
264 @param FileHandle the file handle to delete
266 @retval EFI_SUCCESS the file was closed sucessfully
267 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
269 @retval INVALID_PARAMETER One of the parameters has an invalid value.
274 IN EFI_FILE_HANDLE FileHandle
279 // ASSERT if FileHandle is NULL
281 ASSERT (FileHandle
!= NULL
);
283 // Perform the Delete based on EFI_FILE_PROTOCOL
285 Status
= FileHandle
->Delete(FileHandle
);
290 Set the current position in a file.
292 This function sets the current file position for the handle to the position
293 supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only
294 absolute positioning is supported, and seeking past the end of the file is
295 allowed (a subsequent write would grow the file). Seeking to position
296 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.
297 If FileHandle is a directory, the only position that may be set is zero. This
298 has the effect of starting the read process of the directory entries over.
300 @param FileHandle The file handle on which the position is being set
301 @param Position Byte position from begining of file
303 @retval EFI_SUCCESS Operation completed sucessfully.
304 @retval EFI_UNSUPPORTED the seek request for non-zero is not valid on
306 @retval INVALID_PARAMETER One of the parameters has an invalid value.
310 FileHandleSetPosition (
311 IN EFI_FILE_HANDLE FileHandle
,
316 // ASSERT if FileHandle is NULL
318 ASSERT (FileHandle
!= NULL
);
320 // Perform the SetPosition based on EFI_FILE_PROTOCOL
322 return (FileHandle
->SetPosition(FileHandle
, Position
));
326 Gets a file's current position
328 This function retrieves the current file position for the file handle. For
329 directories, the current file position has no meaning outside of the file
330 system driver and as such the operation is not supported. An error is returned
331 if FileHandle is a directory.
333 @param FileHandle The open file handle on which to get the position.
334 @param Position Byte position from begining of file.
336 @retval EFI_SUCCESS the operation completed sucessfully.
337 @retval INVALID_PARAMETER One of the parameters has an invalid value.
338 @retval EFI_UNSUPPORTED the request is not valid on directories.
342 FileHandleGetPosition (
343 IN EFI_FILE_HANDLE FileHandle
,
347 if (Position
== NULL
) {
348 return (EFI_INVALID_PARAMETER
);
351 // ASSERT if FileHandle is NULL
353 ASSERT (FileHandle
!= NULL
);
355 // Perform the GetPosition based on EFI_FILE_PROTOCOL
357 return (FileHandle
->GetPosition(FileHandle
, Position
));
360 Flushes data on a file
362 This function flushes all modified data associated with a file to a device.
364 @param FileHandle The file handle on which to flush data
366 @retval EFI_SUCCESS The data was flushed.
367 @retval EFI_NO_MEDIA The device has no media.
368 @retval EFI_DEVICE_ERROR The device reported an error.
369 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
370 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
371 @retval EFI_ACCESS_DENIED The file was opened for read only.
376 IN EFI_FILE_HANDLE FileHandle
380 // ASSERT if FileHandle is NULL
382 ASSERT (FileHandle
!= NULL
);
384 // Perform the Flush based on EFI_FILE_PROTOCOL
386 return (FileHandle
->Flush(FileHandle
));
390 function to determine if a given handle is a directory handle
392 if DirHandle is NULL then ASSERT()
394 open the file information on the DirHandle and verify that the Attribute
395 includes EFI_FILE_DIRECTORY bit set.
397 @param DirHandle Handle to open file
399 @retval EFI_SUCCESS DirHandle is a directory
400 @retval EFI_INVALID_PARAMETER DirHandle did not have EFI_FILE_INFO available
401 @retval EFI_NOT_FOUND DirHandle is not a directory
405 FileHandleIsDirectory (
406 IN EFI_FILE_HANDLE DirHandle
409 EFI_FILE_INFO
*DirInfo
;
412 // ASSERT if DirHandle is NULL
414 ASSERT(DirHandle
!= NULL
);
417 // get the file information for DirHandle
419 DirInfo
= FileHandleGetInfo (DirHandle
);
424 if (DirInfo
== NULL
) {
428 return (EFI_INVALID_PARAMETER
);
430 if ((DirInfo
->Attribute
& EFI_FILE_DIRECTORY
) == 0) {
432 // Attributes say this is not a directory
435 return (EFI_NOT_FOUND
);
441 return (EFI_SUCCESS
);
444 /** Retrieve first entry from a directory.
446 This function takes an open directory handle and gets information from the
447 first entry in the directory. A buffer is allocated to contain
448 the information and a pointer to the buffer is returned in *Buffer. The
449 caller can use FileHandleFindNextFile() to get subsequent directory entries.
451 The buffer will be freed by FileHandleFindNextFile() when the last directory
452 entry is read. Otherwise, the caller must free the buffer, using FreePool,
453 when finished with it.
455 @param[in] DirHandle The file handle of the directory to search.
456 @param[out] Buffer The pointer to pointer to buffer for file's information.
458 @retval EFI_SUCCESS Found the first file.
459 @retval EFI_NOT_FOUND Cannot find the directory.
460 @retval EFI_NO_MEDIA The device has no media.
461 @retval EFI_DEVICE_ERROR The device reported an error.
462 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
463 @return Others status of FileHandleGetInfo, FileHandleSetPosition,
468 FileHandleFindFirstFile (
469 IN EFI_FILE_HANDLE DirHandle
,
470 OUT EFI_FILE_INFO
**Buffer
476 if (Buffer
== NULL
|| DirHandle
== NULL
) {
477 return (EFI_INVALID_PARAMETER
);
481 // verify that DirHandle is a directory
483 Status
= FileHandleIsDirectory(DirHandle
);
484 if (EFI_ERROR(Status
)) {
489 // Allocate a buffer sized to struct size + enough for the string at the end
491 BufferSize
= FIND_XXXXX_FILE_BUFFER_SIZE
;
492 *Buffer
= AllocateZeroPool(BufferSize
);
493 if (*Buffer
== NULL
){
494 return (EFI_OUT_OF_RESOURCES
);
498 // reset to the begining of the directory
500 Status
= FileHandleSetPosition(DirHandle
, 0);
501 if (EFI_ERROR(Status
)) {
508 // read in the info about the first file
510 Status
= FileHandleRead (DirHandle
, &BufferSize
, *Buffer
);
511 ASSERT(Status
!= EFI_BUFFER_TOO_SMALL
);
512 if (EFI_ERROR(Status
)) {
517 return (EFI_SUCCESS
);
520 /** Retrieve next entries from a directory.
522 To use this function, the caller must first call the FileHandleFindFirstFile()
523 function to get the first directory entry. Subsequent directory entries are
524 retrieved by using the FileHandleFindNextFile() function. This function can
525 be called several times to get each entry from the directory. If the call of
526 FileHandleFindNextFile() retrieved the last directory entry, the next call of
527 this function will set *NoFile to TRUE and free the buffer.
529 @param[in] DirHandle The file handle of the directory.
530 @param[out] Buffer The pointer to buffer for file's information.
531 @param[out] NoFile The pointer to boolean when last file is found.
533 @retval EFI_SUCCESS Found the next file, or reached last file
534 @retval EFI_NO_MEDIA The device has no media.
535 @retval EFI_DEVICE_ERROR The device reported an error.
536 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
540 FileHandleFindNextFile(
541 IN EFI_FILE_HANDLE DirHandle
,
542 OUT EFI_FILE_INFO
*Buffer
,
550 // ASSERTs for DirHandle or Buffer or NoFile poitners being NULL
552 ASSERT (DirHandle
!= NULL
);
553 ASSERT (Buffer
!= NULL
);
554 ASSERT (NoFile
!= NULL
);
557 // This BufferSize MUST stay equal to the originally allocated one in GetFirstFile
559 BufferSize
= FIND_XXXXX_FILE_BUFFER_SIZE
;
562 // read in the info about the next file
564 Status
= FileHandleRead (DirHandle
, &BufferSize
, Buffer
);
565 ASSERT(Status
!= EFI_BUFFER_TOO_SMALL
);
566 if (EFI_ERROR(Status
)) {
571 // If we read 0 bytes (but did not have erros) we already read in the last file.
573 if (BufferSize
== 0) {
578 return (EFI_SUCCESS
);
582 Retrieve the size of a file.
584 if FileHandle is NULL then ASSERT()
585 if Size is NULL then ASSERT()
587 This function extracts the file size info from the FileHandle's EFI_FILE_INFO
590 @param FileHandle file handle from which size is retrieved
591 @param Size pointer to size
593 @retval EFI_SUCCESS operation was completed sucessfully
594 @retval EFI_DEVICE_ERROR cannot access the file
599 IN EFI_FILE_HANDLE FileHandle
,
603 EFI_FILE_INFO
*FileInfo
;
606 // ASSERT for FileHandle or Size being NULL
608 ASSERT (FileHandle
!= NULL
);
609 ASSERT (Size
!= NULL
);
612 // get the FileInfo structure
614 FileInfo
= FileHandleGetInfo(FileHandle
);
615 if (FileInfo
== NULL
) {
616 return (EFI_DEVICE_ERROR
);
620 // Assign the Size pointer to the correct value
622 *Size
= FileInfo
->FileSize
;
625 // free the FileInfo memory
629 return (EFI_SUCCESS
);
633 Set the size of a file.
635 If FileHandle is NULL then ASSERT().
637 This function changes the file size info from the FileHandle's EFI_FILE_INFO
640 @param FileHandle File handle whose size is to be changed.
641 @param Size New size.
643 @retval EFI_SUCCESS operation was completed sucessfully.
644 @retval EFI_DEVICE_ERROR cannot access the file.
649 IN EFI_FILE_HANDLE FileHandle
,
653 EFI_FILE_INFO
*FileInfo
;
657 // ASSERT for FileHandle or Size being NULL
659 ASSERT (FileHandle
!= NULL
);
662 // get the FileInfo structure
664 FileInfo
= FileHandleGetInfo(FileHandle
);
665 if (FileInfo
== NULL
) {
666 return (EFI_DEVICE_ERROR
);
670 // Assign the FileSize pointer to the new value
672 FileInfo
->FileSize
= Size
;
674 Status
= FileHandleSetInfo(FileHandle
, FileInfo
);
676 // free the FileInfo memory
684 Safely append (on the left) with automatic string resizing given length of Destination and
685 desired length of copy from Source.
687 append the first D characters of Source to the end of Destination, where D is
688 the lesser of Count and the StrLen() of Source. If appending those D characters
689 will fit within Destination (whose Size is given as CurrentSize) and
690 still leave room for a NULL terminator, then those characters are appended,
691 starting at the original terminating NULL of Destination, and a new terminating
694 If appending D characters onto Destination will result in a overflow of the size
695 given in CurrentSize the string will be grown such that the copy can be performed
696 and CurrentSize will be updated to the new size.
698 If Source is NULL, there is nothing to append, just return the current buffer in
701 if Destination is NULL, then ASSERT()
702 if Destination's current length (including NULL terminator) is already more then
703 CurrentSize, then ASSERT()
705 @param[in, out] Destination The String to append onto
706 @param[in, out] CurrentSize on call the number of bytes in Destination. On
707 return possibly the new size (still in bytes). if NULL
708 then allocate whatever is needed.
709 @param[in] Source The String to append from
710 @param[in] Count Maximum number of characters to append. if 0 then
713 @return Destination return the resultant string.
718 IN OUT CHAR16
**Destination
,
719 IN OUT UINTN
*CurrentSize
,
720 IN CONST CHAR16
*Source
,
724 UINTN DestinationStartSize
;
731 ASSERT(Destination
!= NULL
);
734 // If there's nothing to do then just return Destination
736 if (Source
== NULL
) {
737 return (*Destination
);
741 // allow for NULL pointers address as Destination
743 if (*Destination
!= NULL
) {
744 ASSERT(CurrentSize
!= 0);
745 DestinationStartSize
= StrSize(*Destination
);
746 ASSERT(DestinationStartSize
<= *CurrentSize
);
748 DestinationStartSize
= 0;
749 // ASSERT(*CurrentSize == 0);
753 // Append all of Source?
756 Count
= StrSize(Source
);
760 // Test and grow if required
762 if (CurrentSize
!= NULL
) {
763 NewSize
= *CurrentSize
;
764 while (NewSize
< (DestinationStartSize
+ Count
)) {
765 NewSize
+= 2 * Count
;
767 *Destination
= ReallocatePool(*CurrentSize
, NewSize
, *Destination
);
768 *CurrentSize
= NewSize
;
770 *Destination
= AllocateZeroPool(Count
+sizeof(CHAR16
));
772 if (*Destination
== NULL
) {
776 CopySize
= StrSize(*Destination
);
777 CopyMem((*Destination
)+((Count
-2)/sizeof(CHAR16
)), *Destination
, CopySize
);
778 CopyMem(*Destination
, Source
, Count
-2);
779 return (*Destination
);
783 Function to get a full filename given a EFI_FILE_HANDLE somewhere lower on the
786 if Handle is NULL, return EFI_INVALID_PARAMETER
788 @param[in] Handle Handle to the Directory or File to create path to.
789 @param[out] FullFileName pointer to pointer to generated full file name. It
790 is the responsibility of the caller to free this memory
791 with a call to FreePool().
792 @retval EFI_SUCCESS the operation was sucessful and the FullFileName is valid.
793 @retval EFI_INVALID_PARAMETER Handle was NULL.
794 @retval EFI_INVALID_PARAMETER FullFileName was NULL.
795 @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
799 FileHandleGetFileName (
800 IN CONST EFI_FILE_HANDLE Handle
,
801 OUT CHAR16
**FullFileName
806 EFI_FILE_HANDLE CurrentHandle
;
807 EFI_FILE_HANDLE NextHigherHandle
;
808 EFI_FILE_INFO
*FileInfo
;
813 // Check our parameters
815 if (FullFileName
== NULL
|| Handle
== NULL
) {
816 return (EFI_INVALID_PARAMETER
);
819 *FullFileName
= NULL
;
820 CurrentHandle
= NULL
;
822 Status
= Handle
->Open(Handle
, &CurrentHandle
, L
".", EFI_FILE_MODE_READ
, 0);
823 if (!EFI_ERROR(Status
)) {
825 // Reverse out the current directory on the device
828 FileInfo
= FileHandleGetInfo(CurrentHandle
);
829 if (FileInfo
== NULL
) {
830 Status
= EFI_OUT_OF_RESOURCES
;
834 // We got info... do we have a name? if yes preceed the current path with it...
836 if (StrLen (FileInfo
->FileName
) == 0) {
837 if (*FullFileName
== NULL
) {
838 ASSERT((*FullFileName
== NULL
&& Size
== 0) || (*FullFileName
!= NULL
));
839 *FullFileName
= StrnCatGrowLeft(FullFileName
, &Size
, L
"\\", 0);
844 if (*FullFileName
== NULL
) {
845 ASSERT((*FullFileName
== NULL
&& Size
== 0) || (*FullFileName
!= NULL
));
846 *FullFileName
= StrnCatGrowLeft(FullFileName
, &Size
, L
"\\", 0);
848 ASSERT((*FullFileName
== NULL
&& Size
== 0) || (*FullFileName
!= NULL
));
849 *FullFileName
= StrnCatGrowLeft(FullFileName
, &Size
, FileInfo
->FileName
, 0);
850 *FullFileName
= StrnCatGrowLeft(FullFileName
, &Size
, L
"\\", 0);
855 // Move to the parent directory
857 Status
= CurrentHandle
->Open (CurrentHandle
, &NextHigherHandle
, L
"..", EFI_FILE_MODE_READ
, 0);
858 if (EFI_ERROR (Status
)) {
862 FileHandleClose(CurrentHandle
);
863 CurrentHandle
= NextHigherHandle
;
865 } else if (Status
== EFI_NOT_FOUND
) {
866 Status
= EFI_SUCCESS
;
867 ASSERT((*FullFileName
== NULL
&& Size
== 0) || (*FullFileName
!= NULL
));
868 *FullFileName
= StrnCatGrowLeft(FullFileName
, &Size
, L
"\\", 0);
871 if (CurrentHandle
!= NULL
) {
872 CurrentHandle
->Close (CurrentHandle
);
875 if (EFI_ERROR(Status
) && *FullFileName
!= NULL
) {
876 FreePool(*FullFileName
);
883 Function to read a single line from a file. The \n is not included in the returned
884 buffer. The returned buffer must be callee freed.
886 If the position upon start is 0, then the Ascii Boolean will be set. This should be
887 maintained and not changed for all operations with the same file.
889 @param[in] Handle FileHandle to read from.
890 @param[in, out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);
892 @return The line of text from the file.
894 @sa FileHandleReadLine
898 FileHandleReturnLine(
899 IN EFI_FILE_HANDLE Handle
,
900 IN OUT BOOLEAN
*Ascii
910 Status
= FileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
911 if (Status
== EFI_BUFFER_TOO_SMALL
) {
912 RetVal
= AllocateZeroPool(Size
);
913 Status
= FileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
915 ASSERT_EFI_ERROR(Status
);
916 if (EFI_ERROR(Status
) && (RetVal
!= NULL
)) {
924 Function to read a single line (up to but not including the \n) from a EFI_FILE_HANDLE.
926 If the position upon start is 0, then the Ascii Boolean will be set. This should be
927 maintained and not changed for all operations with the same file.
929 @param[in] Handle FileHandle to read from
930 @param[in, out] Buffer pointer to buffer to read into
931 @param[in, out] Size pointer to number of bytes in buffer
932 @param[in] Truncate if TRUE then allows for truncation of the line to fit.
933 if FALSE will reset the position to the begining of the
934 line if the buffer is not large enough.
935 @param[in, out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);
937 @retval EFI_SUCCESS the operation was sucessful. the line is stored in
939 @retval EFI_INVALID_PARAMETER Handle was NULL.
940 @retval EFI_INVALID_PARAMETER Size was NULL.
941 @retval EFI_BUFFER_TOO_SMALL Size was not enough space to store the line.
942 Size was updated to minimum space required.
948 IN EFI_FILE_HANDLE Handle
,
949 IN OUT CHAR16
*Buffer
,
952 IN OUT BOOLEAN
*Ascii
959 UINT64 OriginalFilePosition
;
965 return (EFI_INVALID_PARAMETER
);
967 if (Buffer
== NULL
) {
972 FileHandleGetPosition(Handle
, &OriginalFilePosition
);
973 if (OriginalFilePosition
== 0) {
974 CharSize
= sizeof(CHAR16
);
975 Status
= FileHandleRead(Handle
, &CharSize
, &CharBuffer
);
976 ASSERT_EFI_ERROR(Status
);
977 if (CharBuffer
== gUnicodeFileTag
) {
981 FileHandleSetPosition(Handle
, OriginalFilePosition
);
985 for (CountSoFar
= 0;;CountSoFar
++){
988 CharSize
= sizeof(CHAR8
);
990 CharSize
= sizeof(CHAR16
);
992 Status
= FileHandleRead(Handle
, &CharSize
, &CharBuffer
);
993 if ( EFI_ERROR(Status
)
995 || (CharBuffer
== L
'\n' && !(*Ascii
))
996 || (CharBuffer
== '\n' && *Ascii
)
1001 // if we have space save it...
1003 if ((CountSoFar
+1)*sizeof(CHAR16
) < *Size
){
1004 ASSERT(Buffer
!= NULL
);
1005 ((CHAR16
*)Buffer
)[CountSoFar
] = CharBuffer
;
1006 ((CHAR16
*)Buffer
)[CountSoFar
+1] = CHAR_NULL
;
1011 // if we ran out of space tell when...
1013 if ((CountSoFar
+1)*sizeof(CHAR16
) > *Size
){
1014 *Size
= (CountSoFar
+1)*sizeof(CHAR16
);
1016 FileHandleSetPosition(Handle
, OriginalFilePosition
);
1018 DEBUG((DEBUG_WARN
, "The line was truncated in FileHandleReadLine"));
1020 return (EFI_BUFFER_TOO_SMALL
);
1022 while(Buffer
[StrLen(Buffer
)-1] == L
'\r') {
1023 Buffer
[StrLen(Buffer
)-1] = CHAR_NULL
;
1030 function to write a line of unicode text to a file.
1032 if Handle is NULL, ASSERT.
1033 if Buffer is NULL, do nothing. (return SUCCESS)
1035 @param[in] Handle FileHandle to write to
1036 @param[in] Buffer Buffer to write
1038 @retval EFI_SUCCESS the data was written.
1039 @retval other failure.
1045 FileHandleWriteLine(
1046 IN EFI_FILE_HANDLE Handle
,
1053 ASSERT(Handle
!= NULL
);
1055 if (Buffer
== NULL
) {
1056 return (EFI_SUCCESS
);
1059 Size
= StrSize(Buffer
) - sizeof(Buffer
[0]);
1060 Status
= FileHandleWrite(Handle
, &Size
, Buffer
);
1061 if (EFI_ERROR(Status
)) {
1064 Size
= StrSize(L
"\r\n") - sizeof(CHAR16
);
1065 return FileHandleWrite(Handle
, &Size
, L
"\r\n");
1069 function to take a formatted argument and print it to a file.
1071 @param[in] Handle the file handle for the file to write to
1072 @param[in] Format the format argument (see printlib for format specifier)
1073 @param[in] ... the variable arguments for the format
1075 @retval EFI_SUCCESS the operation was sucessful
1076 @return other a return value from FileHandleWriteLine
1078 @sa FileHandleWriteLine
1082 FileHandlePrintLine(
1083 IN EFI_FILE_HANDLE Handle
,
1084 IN CONST CHAR16
*Format
,
1092 VA_START (Marker
, Format
);
1095 // Get a buffer to print into
1097 Buffer
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
1098 ASSERT (Buffer
!= NULL
);
1101 // Print into our buffer
1103 UnicodeVSPrint (Buffer
, PcdGet16 (PcdShellPrintBufferSize
), Format
, Marker
);
1106 // Print buffer into file
1108 Status
= FileHandleWriteLine(Handle
, Buffer
);
1111 // Cleanup and return
1118 Function to determine if a FILE_HANDLE is at the end of the file.
1120 This will NOT work on directories.
1122 If Handle is NULL, then ASSERT.
1124 @param[in] Handle the file handle
1126 @retval TRUE the position is at the end of the file
1127 @retval FALSE the position is not at the end of the file
1132 IN EFI_FILE_HANDLE Handle
1135 EFI_FILE_INFO
*Info
;
1140 // ASSERT if Handle is NULL
1142 ASSERT(Handle
!= NULL
);
1144 FileHandleGetPosition(Handle
, &Pos
);
1145 Info
= FileHandleGetInfo (Handle
);
1146 ASSERT(Info
!= NULL
);
1147 FileHandleSetPosition(Handle
, Pos
);
1153 if (Pos
== Info
->FileSize
) {