2 Provides interface to EFI_FILE_HANDLE functionality.
4 Copyright (c) 2006 - 2012, 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
) && (FileInfo
!= NULL
)) {
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
) || BufferSize
== 0) {
515 if (BufferSize
== 0) {
516 return (EFI_NOT_FOUND
);
520 return (EFI_SUCCESS
);
523 /** Retrieve next entries from a directory.
525 To use this function, the caller must first call the FileHandleFindFirstFile()
526 function to get the first directory entry. Subsequent directory entries are
527 retrieved by using the FileHandleFindNextFile() function. This function can
528 be called several times to get each entry from the directory. If the call of
529 FileHandleFindNextFile() retrieved the last directory entry, the next call of
530 this function will set *NoFile to TRUE and free the buffer.
532 @param[in] DirHandle The file handle of the directory.
533 @param[out] Buffer The pointer to buffer for file's information.
534 @param[out] NoFile The pointer to boolean when last file is found.
536 @retval EFI_SUCCESS Found the next file, or reached last file
537 @retval EFI_NO_MEDIA The device has no media.
538 @retval EFI_DEVICE_ERROR The device reported an error.
539 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
543 FileHandleFindNextFile(
544 IN EFI_FILE_HANDLE DirHandle
,
545 OUT EFI_FILE_INFO
*Buffer
,
553 // ASSERTs for DirHandle or Buffer or NoFile poitners being NULL
555 ASSERT (DirHandle
!= NULL
);
556 ASSERT (Buffer
!= NULL
);
557 ASSERT (NoFile
!= NULL
);
560 // This BufferSize MUST stay equal to the originally allocated one in GetFirstFile
562 BufferSize
= FIND_XXXXX_FILE_BUFFER_SIZE
;
565 // read in the info about the next file
567 Status
= FileHandleRead (DirHandle
, &BufferSize
, Buffer
);
568 ASSERT(Status
!= EFI_BUFFER_TOO_SMALL
);
569 if (EFI_ERROR(Status
)) {
574 // If we read 0 bytes (but did not have erros) we already read in the last file.
576 if (BufferSize
== 0) {
581 return (EFI_SUCCESS
);
585 Retrieve the size of a file.
587 if FileHandle is NULL then ASSERT()
588 if Size is NULL then ASSERT()
590 This function extracts the file size info from the FileHandle's EFI_FILE_INFO
593 @param FileHandle file handle from which size is retrieved
594 @param Size pointer to size
596 @retval EFI_SUCCESS operation was completed sucessfully
597 @retval EFI_DEVICE_ERROR cannot access the file
602 IN EFI_FILE_HANDLE FileHandle
,
606 EFI_FILE_INFO
*FileInfo
;
609 // ASSERT for FileHandle or Size being NULL
611 ASSERT (FileHandle
!= NULL
);
612 ASSERT (Size
!= NULL
);
615 // get the FileInfo structure
617 FileInfo
= FileHandleGetInfo(FileHandle
);
618 if (FileInfo
== NULL
) {
619 return (EFI_DEVICE_ERROR
);
623 // Assign the Size pointer to the correct value
625 *Size
= FileInfo
->FileSize
;
628 // free the FileInfo memory
632 return (EFI_SUCCESS
);
636 Set the size of a file.
638 If FileHandle is NULL then ASSERT().
640 This function changes the file size info from the FileHandle's EFI_FILE_INFO
643 @param FileHandle File handle whose size is to be changed.
644 @param Size New size.
646 @retval EFI_SUCCESS operation was completed sucessfully.
647 @retval EFI_DEVICE_ERROR cannot access the file.
652 IN EFI_FILE_HANDLE FileHandle
,
656 EFI_FILE_INFO
*FileInfo
;
660 // ASSERT for FileHandle or Size being NULL
662 ASSERT (FileHandle
!= NULL
);
665 // get the FileInfo structure
667 FileInfo
= FileHandleGetInfo(FileHandle
);
668 if (FileInfo
== NULL
) {
669 return (EFI_DEVICE_ERROR
);
673 // Assign the FileSize pointer to the new value
675 FileInfo
->FileSize
= Size
;
677 Status
= FileHandleSetInfo(FileHandle
, FileInfo
);
679 // free the FileInfo memory
687 Safely append (on the left) with automatic string resizing given length of Destination and
688 desired length of copy from Source.
690 append the first D characters of Source to the end of Destination, where D is
691 the lesser of Count and the StrLen() of Source. If appending those D characters
692 will fit within Destination (whose Size is given as CurrentSize) and
693 still leave room for a NULL terminator, then those characters are appended,
694 starting at the original terminating NULL of Destination, and a new terminating
697 If appending D characters onto Destination will result in a overflow of the size
698 given in CurrentSize the string will be grown such that the copy can be performed
699 and CurrentSize will be updated to the new size.
701 If Source is NULL, there is nothing to append, just return the current buffer in
704 if Destination is NULL, then ASSERT()
705 if Destination's current length (including NULL terminator) is already more then
706 CurrentSize, then ASSERT()
708 @param[in, out] Destination The String to append onto
709 @param[in, out] CurrentSize on call the number of bytes in Destination. On
710 return possibly the new size (still in bytes). if NULL
711 then allocate whatever is needed.
712 @param[in] Source The String to append from
713 @param[in] Count Maximum number of characters to append. if 0 then
716 @return Destination return the resultant string.
721 IN OUT CHAR16
**Destination
,
722 IN OUT UINTN
*CurrentSize
,
723 IN CONST CHAR16
*Source
,
727 UINTN DestinationStartSize
;
734 ASSERT(Destination
!= NULL
);
737 // If there's nothing to do then just return Destination
739 if (Source
== NULL
) {
740 return (*Destination
);
744 // allow for NULL pointers address as Destination
746 if (*Destination
!= NULL
) {
747 ASSERT(CurrentSize
!= 0);
748 DestinationStartSize
= StrSize(*Destination
);
749 ASSERT(DestinationStartSize
<= *CurrentSize
);
751 DestinationStartSize
= 0;
752 // ASSERT(*CurrentSize == 0);
756 // Append all of Source?
759 Count
= StrSize(Source
);
763 // Test and grow if required
765 if (CurrentSize
!= NULL
) {
766 NewSize
= *CurrentSize
;
767 while (NewSize
< (DestinationStartSize
+ Count
)) {
768 NewSize
+= 2 * Count
;
770 *Destination
= ReallocatePool(*CurrentSize
, NewSize
, *Destination
);
771 *CurrentSize
= NewSize
;
773 *Destination
= AllocateZeroPool(Count
+sizeof(CHAR16
));
775 if (*Destination
== NULL
) {
779 CopySize
= StrSize(*Destination
);
780 CopyMem((*Destination
)+((Count
-2)/sizeof(CHAR16
)), *Destination
, CopySize
);
781 CopyMem(*Destination
, Source
, Count
-2);
782 return (*Destination
);
786 Function to get a full filename given a EFI_FILE_HANDLE somewhere lower on the
789 if Handle is NULL, return EFI_INVALID_PARAMETER
791 @param[in] Handle Handle to the Directory or File to create path to.
792 @param[out] FullFileName pointer to pointer to generated full file name. It
793 is the responsibility of the caller to free this memory
794 with a call to FreePool().
795 @retval EFI_SUCCESS the operation was sucessful and the FullFileName is valid.
796 @retval EFI_INVALID_PARAMETER Handle was NULL.
797 @retval EFI_INVALID_PARAMETER FullFileName was NULL.
798 @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
802 FileHandleGetFileName (
803 IN CONST EFI_FILE_HANDLE Handle
,
804 OUT CHAR16
**FullFileName
809 EFI_FILE_HANDLE CurrentHandle
;
810 EFI_FILE_HANDLE NextHigherHandle
;
811 EFI_FILE_INFO
*FileInfo
;
816 // Check our parameters
818 if (FullFileName
== NULL
|| Handle
== NULL
) {
819 return (EFI_INVALID_PARAMETER
);
822 *FullFileName
= NULL
;
823 CurrentHandle
= NULL
;
825 Status
= Handle
->Open(Handle
, &CurrentHandle
, L
".", EFI_FILE_MODE_READ
, 0);
826 if (!EFI_ERROR(Status
)) {
828 // Reverse out the current directory on the device
831 FileInfo
= FileHandleGetInfo(CurrentHandle
);
832 if (FileInfo
== NULL
) {
833 Status
= EFI_OUT_OF_RESOURCES
;
837 // We got info... do we have a name? if yes preceed the current path with it...
839 if (StrLen (FileInfo
->FileName
) == 0) {
840 if (*FullFileName
== NULL
) {
841 ASSERT((*FullFileName
== NULL
&& Size
== 0) || (*FullFileName
!= NULL
));
842 *FullFileName
= StrnCatGrowLeft(FullFileName
, &Size
, L
"\\", 0);
847 if (*FullFileName
== NULL
) {
848 ASSERT((*FullFileName
== NULL
&& Size
== 0) || (*FullFileName
!= NULL
));
849 *FullFileName
= StrnCatGrowLeft(FullFileName
, &Size
, L
"\\", 0);
851 ASSERT((*FullFileName
== NULL
&& Size
== 0) || (*FullFileName
!= NULL
));
852 *FullFileName
= StrnCatGrowLeft(FullFileName
, &Size
, FileInfo
->FileName
, 0);
853 *FullFileName
= StrnCatGrowLeft(FullFileName
, &Size
, L
"\\", 0);
858 // Move to the parent directory
860 Status
= CurrentHandle
->Open (CurrentHandle
, &NextHigherHandle
, L
"..", EFI_FILE_MODE_READ
, 0);
861 if (EFI_ERROR (Status
)) {
865 FileHandleClose(CurrentHandle
);
866 CurrentHandle
= NextHigherHandle
;
868 } else if (Status
== EFI_NOT_FOUND
) {
869 Status
= EFI_SUCCESS
;
870 ASSERT((*FullFileName
== NULL
&& Size
== 0) || (*FullFileName
!= NULL
));
871 *FullFileName
= StrnCatGrowLeft(FullFileName
, &Size
, L
"\\", 0);
874 if (CurrentHandle
!= NULL
) {
875 CurrentHandle
->Close (CurrentHandle
);
878 if (EFI_ERROR(Status
) && *FullFileName
!= NULL
) {
879 FreePool(*FullFileName
);
886 Function to read a single line from a file. The \n is not included in the returned
887 buffer. The returned buffer must be callee freed.
889 If the position upon start is 0, then the Ascii Boolean will be set. This should be
890 maintained and not changed for all operations with the same file.
892 @param[in] Handle FileHandle to read from.
893 @param[in, out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);
895 @return The line of text from the file.
897 @sa FileHandleReadLine
901 FileHandleReturnLine(
902 IN EFI_FILE_HANDLE Handle
,
903 IN OUT BOOLEAN
*Ascii
913 Status
= FileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
914 if (Status
== EFI_BUFFER_TOO_SMALL
) {
915 RetVal
= AllocateZeroPool(Size
);
916 Status
= FileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
918 ASSERT_EFI_ERROR(Status
);
919 if (EFI_ERROR(Status
) && (RetVal
!= NULL
)) {
927 Function to read a single line (up to but not including the \n) from a EFI_FILE_HANDLE.
929 If the position upon start is 0, then the Ascii Boolean will be set. This should be
930 maintained and not changed for all operations with the same file.
932 @param[in] Handle FileHandle to read from
933 @param[in, out] Buffer pointer to buffer to read into
934 @param[in, out] Size pointer to number of bytes in buffer
935 @param[in] Truncate if TRUE then allows for truncation of the line to fit.
936 if FALSE will reset the position to the begining of the
937 line if the buffer is not large enough.
938 @param[in, out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);
940 @retval EFI_SUCCESS the operation was sucessful. the line is stored in
942 @retval EFI_INVALID_PARAMETER Handle was NULL.
943 @retval EFI_INVALID_PARAMETER Size was NULL.
944 @retval EFI_BUFFER_TOO_SMALL Size was not enough space to store the line.
945 Size was updated to minimum space required.
951 IN EFI_FILE_HANDLE Handle
,
952 IN OUT CHAR16
*Buffer
,
955 IN OUT BOOLEAN
*Ascii
962 UINT64 OriginalFilePosition
;
968 return (EFI_INVALID_PARAMETER
);
970 if (Buffer
== NULL
) {
975 FileHandleGetPosition(Handle
, &OriginalFilePosition
);
976 if (OriginalFilePosition
== 0) {
977 CharSize
= sizeof(CHAR16
);
978 Status
= FileHandleRead(Handle
, &CharSize
, &CharBuffer
);
979 ASSERT_EFI_ERROR(Status
);
980 if (CharBuffer
== gUnicodeFileTag
) {
984 FileHandleSetPosition(Handle
, OriginalFilePosition
);
988 for (CountSoFar
= 0;;CountSoFar
++){
991 CharSize
= sizeof(CHAR8
);
993 CharSize
= sizeof(CHAR16
);
995 Status
= FileHandleRead(Handle
, &CharSize
, &CharBuffer
);
996 if ( EFI_ERROR(Status
)
998 || (CharBuffer
== L
'\n' && !(*Ascii
))
999 || (CharBuffer
== '\n' && *Ascii
)
1004 // if we have space save it...
1006 if ((CountSoFar
+1)*sizeof(CHAR16
) < *Size
){
1007 ASSERT(Buffer
!= NULL
);
1008 ((CHAR16
*)Buffer
)[CountSoFar
] = CharBuffer
;
1009 ((CHAR16
*)Buffer
)[CountSoFar
+1] = CHAR_NULL
;
1014 // if we ran out of space tell when...
1016 if ((CountSoFar
+1)*sizeof(CHAR16
) > *Size
){
1017 *Size
= (CountSoFar
+1)*sizeof(CHAR16
);
1019 FileHandleSetPosition(Handle
, OriginalFilePosition
);
1021 DEBUG((DEBUG_WARN
, "The line was truncated in FileHandleReadLine"));
1023 return (EFI_BUFFER_TOO_SMALL
);
1025 while(Buffer
[StrLen(Buffer
)-1] == L
'\r') {
1026 Buffer
[StrLen(Buffer
)-1] = CHAR_NULL
;
1033 function to write a line of unicode text to a file.
1035 if Handle is NULL, ASSERT.
1036 if Buffer is NULL, do nothing. (return SUCCESS)
1038 @param[in] Handle FileHandle to write to
1039 @param[in] Buffer Buffer to write
1041 @retval EFI_SUCCESS the data was written.
1042 @retval other failure.
1048 FileHandleWriteLine(
1049 IN EFI_FILE_HANDLE Handle
,
1056 ASSERT(Handle
!= NULL
);
1058 if (Buffer
== NULL
) {
1059 return (EFI_SUCCESS
);
1062 Size
= StrSize(Buffer
) - sizeof(Buffer
[0]);
1063 Status
= FileHandleWrite(Handle
, &Size
, Buffer
);
1064 if (EFI_ERROR(Status
)) {
1067 Size
= StrSize(L
"\r\n") - sizeof(CHAR16
);
1068 return FileHandleWrite(Handle
, &Size
, L
"\r\n");
1072 function to take a formatted argument and print it to a file.
1074 @param[in] Handle the file handle for the file to write to
1075 @param[in] Format the format argument (see printlib for format specifier)
1076 @param[in] ... the variable arguments for the format
1078 @retval EFI_SUCCESS the operation was sucessful
1079 @return other a return value from FileHandleWriteLine
1081 @sa FileHandleWriteLine
1085 FileHandlePrintLine(
1086 IN EFI_FILE_HANDLE Handle
,
1087 IN CONST CHAR16
*Format
,
1096 // Get a buffer to print into
1098 Buffer
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
1099 ASSERT (Buffer
!= NULL
);
1102 // Print into our buffer
1104 VA_START (Marker
, Format
);
1105 UnicodeVSPrint (Buffer
, PcdGet16 (PcdShellPrintBufferSize
), Format
, Marker
);
1109 // Print buffer into file
1111 Status
= FileHandleWriteLine(Handle
, Buffer
);
1114 // Cleanup and return
1121 Function to determine if a FILE_HANDLE is at the end of the file.
1123 This will NOT work on directories.
1125 If Handle is NULL, then ASSERT.
1127 @param[in] Handle the file handle
1129 @retval TRUE the position is at the end of the file
1130 @retval FALSE the position is not at the end of the file
1135 IN EFI_FILE_HANDLE Handle
1138 EFI_FILE_INFO
*Info
;
1143 // ASSERT if Handle is NULL
1145 ASSERT(Handle
!= NULL
);
1147 FileHandleGetPosition(Handle
, &Pos
);
1148 Info
= FileHandleGetInfo (Handle
);
1149 ASSERT(Info
!= NULL
);
1150 FileHandleSetPosition(Handle
, Pos
);
1156 if (Pos
== Info
->FileSize
) {