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
mod dir;
mod info;
mod regular;
use crate::prelude::*;
use crate::{CStr16, Char16, Guid, Result, Status};
#[cfg(feature = "exts")]
use alloc_api::{alloc::Layout, boxed::Box};
use bitflags::bitflags;
use core::ffi::c_void;
use core::mem;
use core::ptr;
pub use self::info::{
FileInfo, FileProtocolInfo, FileSystemInfo, FileSystemVolumeLabel, FromUefi,
NamedFileProtocolInfo,
};
pub use self::{dir::Directory, regular::RegularFile};
pub trait File: Sized {
#[doc(hidden)]
fn handle(&mut self) -> &mut FileHandle;
fn open(
&mut self,
filename: &str,
open_mode: FileMode,
attributes: FileAttribute,
) -> Result<FileHandle> {
const BUF_SIZE: usize = 255;
if filename.len() > BUF_SIZE {
Err(Status::INVALID_PARAMETER.into())
} else {
let mut buf = [0u16; BUF_SIZE + 1];
let mut ptr = ptr::null_mut();
let len = ucs2::encode(filename, &mut buf)?;
let filename = unsafe { CStr16::from_u16_with_nul_unchecked(&buf[..=len]) };
unsafe {
(self.imp().open)(
self.imp(),
&mut ptr,
filename.as_ptr(),
open_mode,
attributes,
)
}
.into_with_val(|| unsafe { FileHandle::new(ptr) })
}
}
fn close(self) {}
fn delete(mut self) -> Result {
let result = (self.imp().delete)(self.imp()).into();
mem::forget(self);
result
}
fn get_info<'buf, Info: FileProtocolInfo + ?Sized>(
&mut self,
buffer: &'buf mut [u8],
) -> Result<&'buf mut Info, Option<usize>> {
let mut buffer_size = buffer.len();
Info::assert_aligned(buffer);
unsafe {
(self.imp().get_info)(
self.imp(),
&Info::GUID,
&mut buffer_size,
buffer.as_mut_ptr(),
)
}
.into_with(
|| unsafe { Info::from_uefi(buffer.as_ptr() as *mut c_void) },
|s| {
if s == Status::BUFFER_TOO_SMALL {
Some(buffer_size)
} else {
None
}
},
)
}
fn set_info<Info: FileProtocolInfo + ?Sized>(&mut self, info: &Info) -> Result {
let info_ptr = info as *const Info as *const c_void;
let info_size = mem::size_of_val(&info);
unsafe { (self.imp().set_info)(self.imp(), &Info::GUID, info_size, info_ptr).into() }
}
fn flush(&mut self) -> Result {
(self.imp().flush)(self.imp()).into()
}
#[cfg(feature = "exts")]
fn get_boxed_info<Info: FileProtocolInfo + ?Sized>(&mut self) -> Result<Box<Info>> {
let size = match self
.get_info::<Info>(&mut [])
.expect_error("zero sized get_info unexpectedly succeeded")
.split()
{
(s, None) => return Err(s.into()),
(_, Some(size)) => size,
};
let layout = Layout::from_size_align(size, Info::alignment())
.unwrap()
.pad_to_align();
let mut buffer = crate::exts::allocate_buffer(layout);
let buffer_start = buffer.as_ptr();
let info = self
.get_info(&mut buffer)
.discard_errdata()?
.map(|info_ref| {
assert_eq!(mem::size_of_val(info_ref), layout.size());
assert_eq!(info_ref as *const Info as *const u8, buffer_start);
unsafe { Box::from_raw(info_ref as *mut _) }
});
mem::forget(buffer);
Ok(info)
}
}
trait FileInternal: File {
fn imp(&mut self) -> &mut FileImpl {
unsafe { &mut *self.handle().0 }
}
}
impl<T: File> FileInternal for T {}
#[repr(transparent)]
pub struct FileHandle(*mut FileImpl);
impl FileHandle {
pub(super) unsafe fn new(ptr: *mut FileImpl) -> Self {
Self(ptr)
}
pub fn into_type(mut self) -> Result<FileType> {
use FileType::*;
let mut pos = 0;
match (self.imp().get_position)(self.imp(), &mut pos) {
Status::SUCCESS => unsafe { Ok(Regular(RegularFile::new(self)).into()) },
Status::UNSUPPORTED => unsafe { Ok(Dir(Directory::new(self)).into()) },
s => Err(s.into()),
}
}
}
impl File for FileHandle {
#[inline]
fn handle(&mut self) -> &mut FileHandle {
self
}
}
impl Drop for FileHandle {
fn drop(&mut self) {
let result: Result = (self.imp().close)(self.imp()).into();
result.expect_success("Failed to close file");
}
}
#[repr(C)]
pub(super) struct FileImpl {
revision: u64,
open: unsafe extern "efiapi" fn(
this: &mut FileImpl,
new_handle: &mut *mut FileImpl,
filename: *const Char16,
open_mode: FileMode,
attributes: FileAttribute,
) -> Status,
close: extern "efiapi" fn(this: &mut FileImpl) -> Status,
delete: extern "efiapi" fn(this: &mut FileImpl) -> Status,
read: unsafe extern "efiapi" fn(
this: &mut FileImpl,
buffer_size: &mut usize,
buffer: *mut u8,
) -> Status,
write: unsafe extern "efiapi" fn(
this: &mut FileImpl,
buffer_size: &mut usize,
buffer: *const u8,
) -> Status,
get_position: extern "efiapi" fn(this: &mut FileImpl, position: &mut u64) -> Status,
set_position: extern "efiapi" fn(this: &mut FileImpl, position: u64) -> Status,
get_info: unsafe extern "efiapi" fn(
this: &mut FileImpl,
information_type: &Guid,
buffer_size: &mut usize,
buffer: *mut u8,
) -> Status,
set_info: unsafe extern "efiapi" fn(
this: &mut FileImpl,
information_type: &Guid,
buffer_size: usize,
buffer: *const c_void,
) -> Status,
flush: extern "efiapi" fn(this: &mut FileImpl) -> Status,
}
pub enum FileType {
Regular(RegularFile),
Dir(Directory),
}
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[repr(u64)]
pub enum FileMode {
Read = 1,
ReadWrite = 2 | 1,
CreateReadWrite = (1 << 63) | 2 | 1,
}
bitflags! {
pub struct FileAttribute: u64 {
const READ_ONLY = 1;
const HIDDEN = 1 << 1;
const SYSTEM = 1 << 2;
const DIRECTORY = 1 << 4;
const ARCHIVE = 1 << 5;
const VALID_ATTR = 0x37;
}
}