File: file.c

package info (click to toggle)
refit 0.12-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 2,280 kB
  • ctags: 2,663
  • sloc: ansic: 13,451; sh: 1,418; python: 631; objc: 319; makefile: 83; perl: 45
file content (443 lines) | stat: -rw-r--r-- 12,910 bytes parent folder | download | duplicates (2)
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
/*
 * fs_ext2/file.c
 * EFI interface functions for files
 *
 * Copyright (c) 2006 Christoph Pfisterer
 *
 * 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; either version 2
 * of the License, or (at your option) any later version.
 *
 * See LICENSE.txt for details about the copyright status of
 * the ext2 file system driver.
 */

#include "fs_ext2.h"

#define DEBUG_LEVEL 0

#define USE_DISPATCHERS 1


EFI_GUID  gEfiFileInfoGuid = EFI_FILE_INFO_ID;
EFI_GUID  gEfiFileSystemInfoGuid = EFI_FILE_SYSTEM_INFO_ID;
EFI_GUID  gEfiFileSystemVolumeLabelInfoIdGuid = EFI_FILE_SYSTEM_VOLUME_LABEL_INFO_ID;


//
// dispatching interface functions
//

#if USE_DISPATCHERS

EFI_STATUS EFIAPI Ext2HandleOpen(IN EFI_FILE *This,
                                 OUT EFI_FILE **NewHandle,
                                 IN CHAR16 *FileName,
                                 IN UINT64 OpenMode,
                                 IN UINT64 Attributes)
{
    EXT2_FILE_DATA      *File;
    
    File = EXT2_FILE_FROM_FILE_HANDLE(This);
    
    if (File->Kind == EXT2_FILE_KIND_FILE)
        return Ext2FileOpen(This, NewHandle, FileName, OpenMode, Attributes);
    else if (File->Kind == EXT2_FILE_KIND_DIR)
        return Ext2DirOpen(This, NewHandle, FileName, OpenMode, Attributes);
    return EFI_UNSUPPORTED;
}


EFI_STATUS EFIAPI Ext2HandleRead(IN EFI_FILE *This,
                                 IN OUT UINTN *BufferSize,
                                 OUT VOID *Buffer)
{
    EXT2_FILE_DATA      *File;
    
    File = EXT2_FILE_FROM_FILE_HANDLE(This);
    
    if (File->Kind == EXT2_FILE_KIND_FILE)
        return Ext2FileRead(This, BufferSize, Buffer);
    else if (File->Kind == EXT2_FILE_KIND_DIR)
        return Ext2DirRead(This, BufferSize, Buffer);
    return EFI_UNSUPPORTED;
}

EFI_STATUS EFIAPI Ext2HandleSetPosition(IN EFI_FILE *This,
                                        IN UINT64 Position)
{
    EXT2_FILE_DATA      *File;
    
    File = EXT2_FILE_FROM_FILE_HANDLE(This);
    
    if (File->Kind == EXT2_FILE_KIND_FILE)
        return Ext2FileSetPosition(This, Position);
    else if (File->Kind == EXT2_FILE_KIND_DIR)
        return Ext2DirSetPosition(This, Position);
    return EFI_UNSUPPORTED;
}

EFI_STATUS EFIAPI Ext2HandleGetPosition(IN EFI_FILE *This,
                                        OUT UINT64 *Position)
{
    EXT2_FILE_DATA      *File;
    
    File = EXT2_FILE_FROM_FILE_HANDLE(This);
    
    if (File->Kind == EXT2_FILE_KIND_FILE)
        return Ext2FileGetPosition(This, Position);
    else if (File->Kind == EXT2_FILE_KIND_DIR)
        return Ext2DirGetPosition(This, Position);
    return EFI_UNSUPPORTED;
}

#endif  // USE_DISPATCHERS


//
// wrap an open inode handle in a file object
//

EFI_STATUS Ext2FileFromInodeHandle(IN EXT2_INODE_HANDLE *InodeHandle,
                                   OUT EFI_FILE **NewFileHandle)
{
    EFI_STATUS          Status;
    EXT2_FILE_DATA      *File;
    
    // allocate file structure
    File = AllocateZeroPool(sizeof(EXT2_FILE_DATA));
    File->Signature = EXT2_FILE_DATA_SIGNATURE;
    
    // move the inode handle (the new object takes ownership)
    CopyMem(&File->InodeHandle, InodeHandle, sizeof(EXT2_INODE_HANDLE));
    
    // check the type
    if (S_ISREG(File->InodeHandle.Inode->RawInode->i_mode)) {
        // regular file
        File->Kind = EXT2_FILE_KIND_FILE;
        File->FileHandle.Revision    = EFI_FILE_HANDLE_REVISION;
        File->FileHandle.Open        = Ext2FileOpen;
        File->FileHandle.Close       = Ext2FileClose;
        File->FileHandle.Delete      = Ext2FileDelete;
        File->FileHandle.Read        = Ext2FileRead;
        File->FileHandle.Write       = Ext2FileWrite;
        File->FileHandle.GetPosition = Ext2FileGetPosition;
        File->FileHandle.SetPosition = Ext2FileSetPosition;
        File->FileHandle.GetInfo     = Ext2FileGetInfo;
        File->FileHandle.SetInfo     = Ext2FileSetInfo;
        File->FileHandle.Flush       = Ext2FileFlush;
        Status = EFI_SUCCESS;
        
    } else if (S_ISDIR(File->InodeHandle.Inode->RawInode->i_mode)) {
        // directory
        File->Kind = EXT2_FILE_KIND_DIR;
        File->FileHandle.Revision    = EFI_FILE_HANDLE_REVISION;
        File->FileHandle.Open        = Ext2DirOpen;
        File->FileHandle.Close       = Ext2FileClose;
        File->FileHandle.Delete      = Ext2FileDelete;
        File->FileHandle.Read        = Ext2DirRead;
        File->FileHandle.Write       = Ext2FileWrite;
        File->FileHandle.GetPosition = Ext2DirGetPosition;
        File->FileHandle.SetPosition = Ext2DirSetPosition;
        File->FileHandle.GetInfo     = Ext2FileGetInfo;
        File->FileHandle.SetInfo     = Ext2FileSetInfo;
        File->FileHandle.Flush       = Ext2FileFlush;
        Status = EFI_SUCCESS;
        
    } else if (S_ISLNK(File->InodeHandle.Inode->RawInode->i_mode)) {
        // symbolic link
        Status = EFI_UNSUPPORTED;
        // TODO: read the target, look it up, recurse
        
    } else {
        // some kind of special file
        Status = EFI_UNSUPPORTED;
    }
    
    if (EFI_ERROR(Status)) {
        Ext2InodeHandleClose(&File->InodeHandle);
        FreePool(File);
        return Status;
    }
    
#if USE_DISPATCHERS
    File->FileHandle.Open        = Ext2HandleOpen;
    File->FileHandle.Read        = Ext2HandleRead;
    File->FileHandle.GetPosition = Ext2HandleGetPosition;
    File->FileHandle.SetPosition = Ext2HandleSetPosition;
#endif
    
    *NewFileHandle = &File->FileHandle;
    return EFI_SUCCESS;
}


//
// EFI_FILE Open for files
//

EFI_STATUS EFIAPI Ext2FileOpen(IN EFI_FILE *This,
                               OUT EFI_FILE **NewHandle,
                               IN CHAR16 *FileName,
                               IN UINT64 OpenMode,
                               IN UINT64 Attributes)
{
    // only supported for directories...
    return EFI_UNSUPPORTED;
}

//
// EFI_FILE Close for files
//

EFI_STATUS EFIAPI Ext2FileClose(IN EFI_FILE *This)
{
    EXT2_FILE_DATA      *File;
    
#if DEBUG_LEVEL
    Print(L"Ext2FileClose\n");
#endif
    
    File = EXT2_FILE_FROM_FILE_HANDLE(This);
    
    Ext2InodeHandleClose(&File->InodeHandle);
    FreePool(File);
    
    return EFI_SUCCESS;
}

//
// EFI_FILE Delete for files and directories
//

EFI_STATUS EFIAPI Ext2FileDelete(IN EFI_FILE *This)
{
    EFI_STATUS Status;
    
    Status = This->Close(This);  // use the appropriate close method
    if (Status == EFI_SUCCESS) {
        // this driver is read-only
        Status = EFI_WARN_DELETE_FAILURE;
    }
    
    return Status;
}

//
// EFI_FILE Read for files
//

EFI_STATUS EFIAPI Ext2FileRead(IN EFI_FILE *This,
                               IN OUT UINTN *BufferSize,
                               OUT VOID *Buffer)
{
    EFI_STATUS          Status;
    EXT2_FILE_DATA      *File;
    
#if DEBUG_LEVEL
    Print(L"Ext2FileRead %d bytes\n", *BufferSize);
#endif
    
    File = EXT2_FILE_FROM_FILE_HANDLE(This);
    
    Status = Ext2InodeHandleRead(&File->InodeHandle, BufferSize, Buffer);
    
    return Status;
}

//
// EFI_FILE Write for files and directories
//

EFI_STATUS EFIAPI Ext2FileWrite(IN EFI_FILE *This,
                                IN OUT UINTN *BufferSize,
                                IN VOID *Buffer)
{
    // this driver is read-only
    return EFI_WRITE_PROTECTED;
}

//
// EFI_FILE SetPosition for files
//

EFI_STATUS EFIAPI Ext2FileSetPosition(IN EFI_FILE *This,
                                      IN UINT64 Position)
{
    EXT2_FILE_DATA      *File;
    
    File = EXT2_FILE_FROM_FILE_HANDLE(This);
    
    if (Position == 0xFFFFFFFFFFFFFFFFULL)
        File->InodeHandle.CurrentPosition = File->InodeHandle.Inode->FileSize;
    else
        File->InodeHandle.CurrentPosition = Position;
    
    return EFI_SUCCESS;
}

//
// EFI_FILE GetPosition for files
//

EFI_STATUS EFIAPI Ext2FileGetPosition(IN EFI_FILE *This,
                                      OUT UINT64 *Position)
{
    EXT2_FILE_DATA      *File;
    
    File = EXT2_FILE_FROM_FILE_HANDLE(This);
    
    *Position = File->InodeHandle.CurrentPosition;
    
    return EFI_SUCCESS;
}

//
// EFI_FILE GetInfo for files and directories
//

EFI_STATUS EFIAPI Ext2FileGetInfo(IN EFI_FILE *This,
                                  IN EFI_GUID *InformationType,
                                  IN OUT UINTN *BufferSize,
                                  OUT VOID *Buffer)
{
    EFI_STATUS          Status;
    EXT2_FILE_DATA      *File;
    EXT2_VOLUME_DATA    *Volume;
    EFI_FILE_INFO       *FileInfo;
    EFI_FILE_SYSTEM_INFO *FSInfo;
    CHAR8               *NamePtr;
    CHAR16              *DestNamePtr;
    UINTN               i, RequiredSize;
    
    File = EXT2_FILE_FROM_FILE_HANDLE(This);
    Volume = File->InodeHandle.Inode->Volume;
    
    if (CompareGuid(InformationType, &gEfiFileInfoGuid) == 0) {
#if DEBUG_LEVEL
        Print(L"Ext2FileGetInfo: FILE_INFO\n");
#endif
        
        RequiredSize = SIZE_OF_EFI_FILE_INFO + StrSize(File->InodeHandle.Inode->Name);
        
        // check buffer size
        if (*BufferSize < RequiredSize) {
            *BufferSize = RequiredSize;
            return EFI_BUFFER_TOO_SMALL;
        }
        
        // fill structure
        FileInfo = (EFI_FILE_INFO *)Buffer;
        FileInfo->Size = RequiredSize;
        Ext2InodeFillFileInfo(File->InodeHandle.Inode, FileInfo);
        StrCpy(FileInfo->FileName, File->InodeHandle.Inode->Name);
        
        // prepare for return
        *BufferSize = RequiredSize;
        Status = EFI_SUCCESS;
        
#if DEBUG_LEVEL
        Print(L"...returning '%s'\n", FileInfo->FileName);
#endif
        
    } else if (CompareGuid(InformationType, &gEfiFileSystemInfoGuid) == 0) {
#if DEBUG_LEVEL
        Print(L"Ext2FileGetInfo: FILE_SYSTEM_INFO\n");
#endif
        
        // TODO: store volume label in volume structure, readily converted
        // get volume label size, derive structure size
        NamePtr = (CHAR8 *)(Volume->SuperBlock) + 120;
        for (i = 0; i < 16; i++)
            if (NamePtr[i] == 0)
                break;
        RequiredSize = SIZE_OF_EFI_FILE_SYSTEM_INFO + (i + 1) * sizeof(CHAR16);
        
        // check buffer size
        if (*BufferSize < RequiredSize) {
            *BufferSize = RequiredSize;
            return EFI_BUFFER_TOO_SMALL;
        }
        
        // fill structure
        FSInfo = (EFI_FILE_SYSTEM_INFO *)Buffer;
        FSInfo->Size        = RequiredSize;
        FSInfo->ReadOnly    = TRUE;
        FSInfo->VolumeSize  = (UINT64)Volume->SuperBlock->s_blocks_count * Volume->BlockSize;
        FSInfo->FreeSpace   = (UINT64)Volume->SuperBlock->s_free_blocks_count * Volume->BlockSize;
        FSInfo->BlockSize   = Volume->BlockSize;
        
        // copy volume label
        DestNamePtr = FSInfo->VolumeLabel;
        for (i = 0; i < 16; i++) {
            if (NamePtr[i] == 0)
                break;
            DestNamePtr[i] = NamePtr[i];
        }
        DestNamePtr[i] = 0;
        
        // prepare for return
        *BufferSize = RequiredSize;
        Status = EFI_SUCCESS;
        
    } else if (CompareGuid(InformationType, &gEfiFileSystemVolumeLabelInfoIdGuid) == 0) {
#if DEBUG_LEVEL
        Print(L"Ext2FileGetInfo: FILE_SYSTEM_VOLUME_LABEL\n");
#endif
        
        // get volume label size, derive structure size
        NamePtr = (CHAR8 *)(Volume->SuperBlock) + 120;
        for (i = 0; i < 16; i++)
            if (NamePtr[i] == 0)
                break;
        RequiredSize = SIZE_OF_EFI_FILE_SYSTEM_VOLUME_LABEL_INFO + (i + 1) * sizeof(CHAR16);
        
        // check buffer size
        if (*BufferSize < RequiredSize) {
            *BufferSize = RequiredSize;
            return EFI_BUFFER_TOO_SMALL;
        }
        
        // copy volume label
        DestNamePtr = ((EFI_FILE_SYSTEM_VOLUME_LABEL_INFO *)Buffer)->VolumeLabel;
        for (i = 0; i < 16; i++) {
            if (NamePtr[i] == 0)
                break;
            DestNamePtr[i] = NamePtr[i];
        }
        DestNamePtr[i] = 0;
        
        // prepare for return
        *BufferSize = RequiredSize;
        Status = EFI_SUCCESS;
        
    } else {
        Status = EFI_UNSUPPORTED;
    }
    
    return Status;
}

//
// EFI_FILE SetInfo for files and directories
//

EFI_STATUS EFIAPI Ext2FileSetInfo(IN EFI_FILE *This,
                                  IN EFI_GUID *InformationType,
                                  IN UINTN BufferSize,
                                  IN VOID *Buffer)
{
    // this driver is read-only
    return EFI_WRITE_PROTECTED;
}

//
// EFI_FILE Flush for files and directories
//

EFI_STATUS EFIAPI Ext2FileFlush(IN EFI_FILE *This)
{
    // this driver is read-only
    return EFI_WRITE_PROTECTED;
}