sread.c revision 1.1.1.1.10.2
1 1.1.1.1.10.2 tls /* $NetBSD: sread.c,v 1.1.1.1.10.2 2014/08/20 00:04:24 tls Exp $ */ 2 1.1.1.1.10.2 tls 3 1.1.1.1.10.2 tls /*++ 4 1.1.1.1.10.2 tls 5 1.1.1.1.10.2 tls Copyright (c) 1998 Intel Corporation 6 1.1.1.1.10.2 tls 7 1.1.1.1.10.2 tls Module Name: 8 1.1.1.1.10.2 tls 9 1.1.1.1.10.2 tls sread.c 10 1.1.1.1.10.2 tls 11 1.1.1.1.10.2 tls Abstract: 12 1.1.1.1.10.2 tls 13 1.1.1.1.10.2 tls Simple read file access 14 1.1.1.1.10.2 tls 15 1.1.1.1.10.2 tls 16 1.1.1.1.10.2 tls 17 1.1.1.1.10.2 tls Revision History 18 1.1.1.1.10.2 tls 19 1.1.1.1.10.2 tls --*/ 20 1.1.1.1.10.2 tls 21 1.1.1.1.10.2 tls #include "lib.h" 22 1.1.1.1.10.2 tls 23 1.1.1.1.10.2 tls #define SIMPLE_READ_SIGNATURE EFI_SIGNATURE_32('s','r','d','r') 24 1.1.1.1.10.2 tls typedef struct _SIMPLE_READ_FILE { 25 1.1.1.1.10.2 tls UINTN Signature; 26 1.1.1.1.10.2 tls BOOLEAN FreeBuffer; 27 1.1.1.1.10.2 tls VOID *Source; 28 1.1.1.1.10.2 tls UINTN SourceSize; 29 1.1.1.1.10.2 tls EFI_FILE_HANDLE FileHandle; 30 1.1.1.1.10.2 tls } SIMPLE_READ_HANDLE; 31 1.1.1.1.10.2 tls 32 1.1.1.1.10.2 tls 33 1.1.1.1.10.2 tls 34 1.1.1.1.10.2 tls EFI_STATUS 35 1.1.1.1.10.2 tls OpenSimpleReadFile ( 36 1.1.1.1.10.2 tls IN BOOLEAN BootPolicy, 37 1.1.1.1.10.2 tls IN VOID *SourceBuffer OPTIONAL, 38 1.1.1.1.10.2 tls IN UINTN SourceSize, 39 1.1.1.1.10.2 tls IN OUT EFI_DEVICE_PATH **FilePath, 40 1.1.1.1.10.2 tls OUT EFI_HANDLE *DeviceHandle, 41 1.1.1.1.10.2 tls OUT SIMPLE_READ_FILE *SimpleReadHandle 42 1.1.1.1.10.2 tls ) 43 1.1.1.1.10.2 tls /*++ 44 1.1.1.1.10.2 tls 45 1.1.1.1.10.2 tls Routine Description: 46 1.1.1.1.10.2 tls 47 1.1.1.1.10.2 tls Opens a file for (simple) reading. The simple read abstraction 48 1.1.1.1.10.2 tls will access the file either from a memory copy, from a file 49 1.1.1.1.10.2 tls system interface, or from the load file interface. 50 1.1.1.1.10.2 tls 51 1.1.1.1.10.2 tls Arguments: 52 1.1.1.1.10.2 tls 53 1.1.1.1.10.2 tls Returns: 54 1.1.1.1.10.2 tls 55 1.1.1.1.10.2 tls A handle to access the file 56 1.1.1.1.10.2 tls 57 1.1.1.1.10.2 tls --*/ 58 1.1.1.1.10.2 tls { 59 1.1.1.1.10.2 tls SIMPLE_READ_HANDLE *FHand; 60 1.1.1.1.10.2 tls EFI_DEVICE_PATH *UserFilePath; 61 1.1.1.1.10.2 tls EFI_DEVICE_PATH *TempFilePath; 62 1.1.1.1.10.2 tls EFI_DEVICE_PATH *TempFilePathPtr; 63 1.1.1.1.10.2 tls FILEPATH_DEVICE_PATH *FilePathNode; 64 1.1.1.1.10.2 tls EFI_FILE_HANDLE FileHandle, LastHandle; 65 1.1.1.1.10.2 tls EFI_STATUS Status; 66 1.1.1.1.10.2 tls EFI_LOAD_FILE_INTERFACE *LoadFile; 67 1.1.1.1.10.2 tls 68 1.1.1.1.10.2 tls FHand = NULL; 69 1.1.1.1.10.2 tls UserFilePath = *FilePath; 70 1.1.1.1.10.2 tls 71 1.1.1.1.10.2 tls // 72 1.1.1.1.10.2 tls // Allocate a new simple read handle structure 73 1.1.1.1.10.2 tls // 74 1.1.1.1.10.2 tls 75 1.1.1.1.10.2 tls FHand = AllocateZeroPool (sizeof(SIMPLE_READ_HANDLE)); 76 1.1.1.1.10.2 tls if (!FHand) { 77 1.1.1.1.10.2 tls Status = EFI_OUT_OF_RESOURCES; 78 1.1.1.1.10.2 tls goto Done; 79 1.1.1.1.10.2 tls } 80 1.1.1.1.10.2 tls 81 1.1.1.1.10.2 tls *SimpleReadHandle = (SIMPLE_READ_FILE) FHand; 82 1.1.1.1.10.2 tls FHand->Signature = SIMPLE_READ_SIGNATURE; 83 1.1.1.1.10.2 tls 84 1.1.1.1.10.2 tls // 85 1.1.1.1.10.2 tls // If the caller passed a copy of the file, then just use it 86 1.1.1.1.10.2 tls // 87 1.1.1.1.10.2 tls 88 1.1.1.1.10.2 tls if (SourceBuffer) { 89 1.1.1.1.10.2 tls FHand->Source = SourceBuffer; 90 1.1.1.1.10.2 tls FHand->SourceSize = SourceSize; 91 1.1.1.1.10.2 tls *DeviceHandle = NULL; 92 1.1.1.1.10.2 tls Status = EFI_SUCCESS; 93 1.1.1.1.10.2 tls goto Done; 94 1.1.1.1.10.2 tls } 95 1.1.1.1.10.2 tls 96 1.1.1.1.10.2 tls // 97 1.1.1.1.10.2 tls // Attempt to access the file via a file system interface 98 1.1.1.1.10.2 tls // 99 1.1.1.1.10.2 tls 100 1.1.1.1.10.2 tls FileHandle = NULL; 101 1.1.1.1.10.2 tls Status = uefi_call_wrapper(BS->LocateDevicePath, 3, &FileSystemProtocol, FilePath, DeviceHandle); 102 1.1.1.1.10.2 tls if (!EFI_ERROR(Status)) { 103 1.1.1.1.10.2 tls FileHandle = LibOpenRoot (*DeviceHandle); 104 1.1.1.1.10.2 tls } 105 1.1.1.1.10.2 tls 106 1.1.1.1.10.2 tls Status = FileHandle ? EFI_SUCCESS : EFI_UNSUPPORTED; 107 1.1.1.1.10.2 tls 108 1.1.1.1.10.2 tls // 109 1.1.1.1.10.2 tls // To access as a filesystem, the filepath should only 110 1.1.1.1.10.2 tls // contain filepath components. Follow the filepath nodes 111 1.1.1.1.10.2 tls // and find the target file 112 1.1.1.1.10.2 tls // 113 1.1.1.1.10.2 tls 114 1.1.1.1.10.2 tls FilePathNode = (FILEPATH_DEVICE_PATH *) *FilePath; 115 1.1.1.1.10.2 tls while (!IsDevicePathEnd(&FilePathNode->Header)) { 116 1.1.1.1.10.2 tls 117 1.1.1.1.10.2 tls // 118 1.1.1.1.10.2 tls // For filesystem access each node should be a filepath component 119 1.1.1.1.10.2 tls // 120 1.1.1.1.10.2 tls 121 1.1.1.1.10.2 tls if (DevicePathType(&FilePathNode->Header) != MEDIA_DEVICE_PATH || 122 1.1.1.1.10.2 tls DevicePathSubType(&FilePathNode->Header) != MEDIA_FILEPATH_DP) { 123 1.1.1.1.10.2 tls Status = EFI_UNSUPPORTED; 124 1.1.1.1.10.2 tls } 125 1.1.1.1.10.2 tls 126 1.1.1.1.10.2 tls // 127 1.1.1.1.10.2 tls // If there's been an error, stop 128 1.1.1.1.10.2 tls // 129 1.1.1.1.10.2 tls 130 1.1.1.1.10.2 tls if (EFI_ERROR(Status)) { 131 1.1.1.1.10.2 tls break; 132 1.1.1.1.10.2 tls } 133 1.1.1.1.10.2 tls 134 1.1.1.1.10.2 tls // 135 1.1.1.1.10.2 tls // Open this file path node 136 1.1.1.1.10.2 tls // 137 1.1.1.1.10.2 tls 138 1.1.1.1.10.2 tls LastHandle = FileHandle; 139 1.1.1.1.10.2 tls FileHandle = NULL; 140 1.1.1.1.10.2 tls 141 1.1.1.1.10.2 tls Status = uefi_call_wrapper( 142 1.1.1.1.10.2 tls LastHandle->Open, 143 1.1.1.1.10.2 tls 5, 144 1.1.1.1.10.2 tls LastHandle, 145 1.1.1.1.10.2 tls &FileHandle, 146 1.1.1.1.10.2 tls FilePathNode->PathName, 147 1.1.1.1.10.2 tls EFI_FILE_MODE_READ, 148 1.1.1.1.10.2 tls 0 149 1.1.1.1.10.2 tls ); 150 1.1.1.1.10.2 tls 151 1.1.1.1.10.2 tls // 152 1.1.1.1.10.2 tls // Close the last node 153 1.1.1.1.10.2 tls // 154 1.1.1.1.10.2 tls 155 1.1.1.1.10.2 tls uefi_call_wrapper(LastHandle->Close, 1, LastHandle); 156 1.1.1.1.10.2 tls 157 1.1.1.1.10.2 tls // 158 1.1.1.1.10.2 tls // Get the next node 159 1.1.1.1.10.2 tls // 160 1.1.1.1.10.2 tls 161 1.1.1.1.10.2 tls FilePathNode = (FILEPATH_DEVICE_PATH *) NextDevicePathNode(&FilePathNode->Header); 162 1.1.1.1.10.2 tls } 163 1.1.1.1.10.2 tls 164 1.1.1.1.10.2 tls // 165 1.1.1.1.10.2 tls // If success, return the FHand 166 1.1.1.1.10.2 tls // 167 1.1.1.1.10.2 tls 168 1.1.1.1.10.2 tls if (!EFI_ERROR(Status)) { 169 1.1.1.1.10.2 tls ASSERT(FileHandle); 170 1.1.1.1.10.2 tls FHand->FileHandle = FileHandle; 171 1.1.1.1.10.2 tls goto Done; 172 1.1.1.1.10.2 tls } 173 1.1.1.1.10.2 tls 174 1.1.1.1.10.2 tls // 175 1.1.1.1.10.2 tls // Cleanup from filesystem access 176 1.1.1.1.10.2 tls // 177 1.1.1.1.10.2 tls 178 1.1.1.1.10.2 tls if (FileHandle) { 179 1.1.1.1.10.2 tls uefi_call_wrapper(FileHandle->Close, 1, FileHandle); 180 1.1.1.1.10.2 tls FileHandle = NULL; 181 1.1.1.1.10.2 tls *FilePath = UserFilePath; 182 1.1.1.1.10.2 tls } 183 1.1.1.1.10.2 tls 184 1.1.1.1.10.2 tls // 185 1.1.1.1.10.2 tls // If the error is something other then unsupported, return it 186 1.1.1.1.10.2 tls // 187 1.1.1.1.10.2 tls 188 1.1.1.1.10.2 tls if (Status != EFI_UNSUPPORTED) { 189 1.1.1.1.10.2 tls goto Done; 190 1.1.1.1.10.2 tls } 191 1.1.1.1.10.2 tls 192 1.1.1.1.10.2 tls // 193 1.1.1.1.10.2 tls // Attempt to access the file via the load file protocol 194 1.1.1.1.10.2 tls // 195 1.1.1.1.10.2 tls 196 1.1.1.1.10.2 tls Status = LibDevicePathToInterface (&LoadFileProtocol, *FilePath, (VOID*)&LoadFile); 197 1.1.1.1.10.2 tls if (!EFI_ERROR(Status)) { 198 1.1.1.1.10.2 tls 199 1.1.1.1.10.2 tls TempFilePath = DuplicateDevicePath (*FilePath); 200 1.1.1.1.10.2 tls 201 1.1.1.1.10.2 tls TempFilePathPtr = TempFilePath; 202 1.1.1.1.10.2 tls 203 1.1.1.1.10.2 tls Status = uefi_call_wrapper(BS->LocateDevicePath, 3, &LoadFileProtocol, &TempFilePath, DeviceHandle); 204 1.1.1.1.10.2 tls 205 1.1.1.1.10.2 tls FreePool (TempFilePathPtr); 206 1.1.1.1.10.2 tls 207 1.1.1.1.10.2 tls // 208 1.1.1.1.10.2 tls // Determine the size of buffer needed to hold the file 209 1.1.1.1.10.2 tls // 210 1.1.1.1.10.2 tls 211 1.1.1.1.10.2 tls SourceSize = 0; 212 1.1.1.1.10.2 tls Status = uefi_call_wrapper( 213 1.1.1.1.10.2 tls LoadFile->LoadFile, 214 1.1.1.1.10.2 tls 5, 215 1.1.1.1.10.2 tls LoadFile, 216 1.1.1.1.10.2 tls *FilePath, 217 1.1.1.1.10.2 tls BootPolicy, 218 1.1.1.1.10.2 tls &SourceSize, 219 1.1.1.1.10.2 tls NULL 220 1.1.1.1.10.2 tls ); 221 1.1.1.1.10.2 tls 222 1.1.1.1.10.2 tls // 223 1.1.1.1.10.2 tls // We expect a buffer too small error to inform us 224 1.1.1.1.10.2 tls // of the buffer size needed 225 1.1.1.1.10.2 tls // 226 1.1.1.1.10.2 tls 227 1.1.1.1.10.2 tls if (Status == EFI_BUFFER_TOO_SMALL) { 228 1.1.1.1.10.2 tls SourceBuffer = AllocatePool (SourceSize); 229 1.1.1.1.10.2 tls 230 1.1.1.1.10.2 tls if (SourceBuffer) { 231 1.1.1.1.10.2 tls FHand->FreeBuffer = TRUE; 232 1.1.1.1.10.2 tls FHand->Source = SourceBuffer; 233 1.1.1.1.10.2 tls FHand->SourceSize = SourceSize; 234 1.1.1.1.10.2 tls 235 1.1.1.1.10.2 tls Status = uefi_call_wrapper( 236 1.1.1.1.10.2 tls LoadFile->LoadFile, 237 1.1.1.1.10.2 tls 5, 238 1.1.1.1.10.2 tls LoadFile, 239 1.1.1.1.10.2 tls *FilePath, 240 1.1.1.1.10.2 tls BootPolicy, 241 1.1.1.1.10.2 tls &SourceSize, 242 1.1.1.1.10.2 tls SourceBuffer 243 1.1.1.1.10.2 tls ); 244 1.1.1.1.10.2 tls } 245 1.1.1.1.10.2 tls } 246 1.1.1.1.10.2 tls 247 1.1.1.1.10.2 tls // 248 1.1.1.1.10.2 tls // If success, return FHand 249 1.1.1.1.10.2 tls // 250 1.1.1.1.10.2 tls 251 1.1.1.1.10.2 tls if (!EFI_ERROR(Status) || Status == EFI_ALREADY_STARTED) { 252 1.1.1.1.10.2 tls goto Done; 253 1.1.1.1.10.2 tls } 254 1.1.1.1.10.2 tls } 255 1.1.1.1.10.2 tls 256 1.1.1.1.10.2 tls // 257 1.1.1.1.10.2 tls // Nothing else to try 258 1.1.1.1.10.2 tls // 259 1.1.1.1.10.2 tls 260 1.1.1.1.10.2 tls DEBUG ((D_LOAD|D_WARN, "OpenSimpleReadFile: Device did not support a known load protocol\n")); 261 1.1.1.1.10.2 tls Status = EFI_UNSUPPORTED; 262 1.1.1.1.10.2 tls 263 1.1.1.1.10.2 tls Done: 264 1.1.1.1.10.2 tls 265 1.1.1.1.10.2 tls // 266 1.1.1.1.10.2 tls // If the file was not accessed, clean up 267 1.1.1.1.10.2 tls // 268 1.1.1.1.10.2 tls if (EFI_ERROR(Status) && (Status != EFI_ALREADY_STARTED)) { 269 1.1.1.1.10.2 tls if (FHand) { 270 1.1.1.1.10.2 tls if (FHand->FreeBuffer) { 271 1.1.1.1.10.2 tls FreePool (FHand->Source); 272 1.1.1.1.10.2 tls } 273 1.1.1.1.10.2 tls 274 1.1.1.1.10.2 tls FreePool (FHand); 275 1.1.1.1.10.2 tls } 276 1.1.1.1.10.2 tls } 277 1.1.1.1.10.2 tls 278 1.1.1.1.10.2 tls return Status; 279 1.1.1.1.10.2 tls } 280 1.1.1.1.10.2 tls 281 1.1.1.1.10.2 tls EFI_STATUS 282 1.1.1.1.10.2 tls ReadSimpleReadFile ( 283 1.1.1.1.10.2 tls IN SIMPLE_READ_FILE UserHandle, 284 1.1.1.1.10.2 tls IN UINTN Offset, 285 1.1.1.1.10.2 tls IN OUT UINTN *ReadSize, 286 1.1.1.1.10.2 tls OUT VOID *Buffer 287 1.1.1.1.10.2 tls ) 288 1.1.1.1.10.2 tls { 289 1.1.1.1.10.2 tls UINTN EndPos; 290 1.1.1.1.10.2 tls SIMPLE_READ_HANDLE *FHand; 291 1.1.1.1.10.2 tls EFI_STATUS Status; 292 1.1.1.1.10.2 tls 293 1.1.1.1.10.2 tls FHand = UserHandle; 294 1.1.1.1.10.2 tls ASSERT (FHand->Signature == SIMPLE_READ_SIGNATURE); 295 1.1.1.1.10.2 tls if (FHand->Source) { 296 1.1.1.1.10.2 tls 297 1.1.1.1.10.2 tls // 298 1.1.1.1.10.2 tls // Move data from our local copy of the file 299 1.1.1.1.10.2 tls // 300 1.1.1.1.10.2 tls 301 1.1.1.1.10.2 tls EndPos = Offset + *ReadSize; 302 1.1.1.1.10.2 tls if (EndPos > FHand->SourceSize) { 303 1.1.1.1.10.2 tls *ReadSize = FHand->SourceSize - Offset; 304 1.1.1.1.10.2 tls if (Offset >= FHand->SourceSize) { 305 1.1.1.1.10.2 tls *ReadSize = 0; 306 1.1.1.1.10.2 tls } 307 1.1.1.1.10.2 tls } 308 1.1.1.1.10.2 tls 309 1.1.1.1.10.2 tls CopyMem (Buffer, (CHAR8 *) FHand->Source + Offset, *ReadSize); 310 1.1.1.1.10.2 tls Status = EFI_SUCCESS; 311 1.1.1.1.10.2 tls 312 1.1.1.1.10.2 tls } else { 313 1.1.1.1.10.2 tls 314 1.1.1.1.10.2 tls // 315 1.1.1.1.10.2 tls // Read data from the file 316 1.1.1.1.10.2 tls // 317 1.1.1.1.10.2 tls 318 1.1.1.1.10.2 tls Status = uefi_call_wrapper(FHand->FileHandle->SetPosition, 2, FHand->FileHandle, Offset); 319 1.1.1.1.10.2 tls 320 1.1.1.1.10.2 tls if (!EFI_ERROR(Status)) { 321 1.1.1.1.10.2 tls Status = uefi_call_wrapper(FHand->FileHandle->Read, 3, FHand->FileHandle, ReadSize, Buffer); 322 1.1.1.1.10.2 tls } 323 1.1.1.1.10.2 tls } 324 1.1.1.1.10.2 tls 325 1.1.1.1.10.2 tls return Status; 326 1.1.1.1.10.2 tls } 327 1.1.1.1.10.2 tls 328 1.1.1.1.10.2 tls 329 1.1.1.1.10.2 tls VOID 330 1.1.1.1.10.2 tls CloseSimpleReadFile ( 331 1.1.1.1.10.2 tls IN SIMPLE_READ_FILE UserHandle 332 1.1.1.1.10.2 tls ) 333 1.1.1.1.10.2 tls { 334 1.1.1.1.10.2 tls SIMPLE_READ_HANDLE *FHand; 335 1.1.1.1.10.2 tls 336 1.1.1.1.10.2 tls FHand = UserHandle; 337 1.1.1.1.10.2 tls ASSERT (FHand->Signature == SIMPLE_READ_SIGNATURE); 338 1.1.1.1.10.2 tls 339 1.1.1.1.10.2 tls // 340 1.1.1.1.10.2 tls // Free any file handle we opened 341 1.1.1.1.10.2 tls // 342 1.1.1.1.10.2 tls 343 1.1.1.1.10.2 tls if (FHand->FileHandle) { 344 1.1.1.1.10.2 tls uefi_call_wrapper(FHand->FileHandle->Close, 1, FHand->FileHandle); 345 1.1.1.1.10.2 tls } 346 1.1.1.1.10.2 tls 347 1.1.1.1.10.2 tls // 348 1.1.1.1.10.2 tls // If we allocated the Source buffer, free it 349 1.1.1.1.10.2 tls // 350 1.1.1.1.10.2 tls 351 1.1.1.1.10.2 tls if (FHand->FreeBuffer) { 352 1.1.1.1.10.2 tls FreePool (FHand->Source); 353 1.1.1.1.10.2 tls } 354 1.1.1.1.10.2 tls 355 1.1.1.1.10.2 tls // 356 1.1.1.1.10.2 tls // Done with this simple read file handle 357 1.1.1.1.10.2 tls // 358 1.1.1.1.10.2 tls 359 1.1.1.1.10.2 tls FreePool (FHand); 360 1.1.1.1.10.2 tls } 361
Indexes created Fri Oct 03 02:09:57 GMT 2025