-
Notifications
You must be signed in to change notification settings - Fork 156
/
file.rs
192 lines (176 loc) · 7.08 KB
/
file.rs
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
use bitflags::bitflags;
use crate::{Result, Status};
use ucs2;
/// A file represents an abstraction of some contiguous block of data residing on a volume.
///
/// Files have names, and a fixed size.
pub struct File<'a> {
inner: &'a mut FileImpl,
}
impl<'a> File<'a> {
pub(super) fn new(ptr: usize) -> Self {
let ptr = ptr as *mut FileImpl;
let inner = unsafe { &mut *ptr };
File { inner }
}
/// Try to open a file relative to this file/directory.
///
/// # Arguments
/// * `filename` Path of file to open, relative to this File
/// * `open_mode` The mode to open the file with. Valid
/// combinations are READ, READ | WRITE and READ | WRITE | CREATE
/// * `attributes` Only valid when FILE_MODE_CREATE is used as a mode
///
/// # Errors
/// * `uefi::Status::INVALID_PARAMETER` The filename exceeds the maximum length of 255 chars
/// * `uefi::Status::NOT_FOUND` Could not find file
/// * `uefi::Status::NO_MEDIA` The device has no media
/// * `uefi::Status::MEDIA_CHANGED` The device has a different medium in it
/// * `uefi::Status::DEVICE_ERROR` The device reported an error
/// * `uefi::Status::VOLUME_CORRUPTED` The filesystem structures are corrupted
/// * `uefi::Status::WRITE_PROTECTED` Write/Create attempted on readonly file
/// * `uefi::Status::ACCESS_DENIED` The service denied access to the file
/// * `uefi::Status::OUT_OF_RESOURCES` Not enough resources to open file
/// * `uefi::Status::VOLUME_FULL` The volume is full
pub fn open(
&mut self,
filename: &str,
open_mode: FileMode,
attributes: FileAttribute,
) -> Result<File> {
const BUF_SIZE: usize = 255;
if filename.len() > BUF_SIZE {
Err(Status::INVALID_PARAMETER)
} else {
let mut buf = [0u16; BUF_SIZE + 1];
let mut ptr = 0usize;
ucs2::encode(filename, &mut buf)?;
(self.inner.open)(self.inner, &mut ptr, buf.as_ptr(), open_mode, attributes).into_with(
|| File {
inner: unsafe { &mut *(ptr as *mut FileImpl) },
},
)
}
}
/// Close this file handle
///
/// This MUST be called when you are done with the file
pub fn close(self) -> Result<()> {
(self.inner.close)(self.inner).into()
}
/// Closes and deletes this file
///
/// # Errors
/// * `uefi::Status::WARN_DELETE_FAILURE` The file was closed, but deletion failed
pub fn delete(self) -> Result<()> {
(self.inner.delete)(self.inner).into()
}
/// Read data from file
///
/// Try to read as much as possible into `buffer`. Returns the number of bytes read
///
/// # Arguments
/// * `buffer` The target buffer of the read operation
///
/// # Errors
/// * `uefi::Status::NO_MEDIA` The device has no media
/// * `uefi::Status::DEVICE_ERROR` The device reported an error
/// * `uefi::Status::VOLUME_CORRUPTED` The filesystem structures are corrupted
pub fn read(&mut self, buffer: &mut [u8]) -> Result<usize> {
let mut buffer_size = buffer.len();
(self.inner.read)(self.inner, &mut buffer_size, buffer.as_mut_ptr())
.into_with(|| buffer_size)
}
/// Write data to file
///
/// Write `buffer` to file, increment the file pointer and return number of bytes written
///
/// # Arguments
/// * `buffer` Buffer to write to file
///
/// # Errors
/// * `uefi::Status::NO_MEDIA` The device has no media
/// * `uefi::Status::DEVICE_ERROR` The device reported an error
/// * `uefi::Status::VOLUME_CORRUPTED` The filesystem structures are corrupted
/// * `uefi::Status::WRITE_PROTECTED` Attempt to write to readonly file
/// * `uefi::Status::ACCESS_DENIED` The file was opened read only.
/// * `uefi::Status::VOLUME_FULL` The volume is full
pub fn write(&mut self, buffer: &[u8]) -> Result<usize> {
let mut buffer_size = buffer.len();
(self.inner.write)(self.inner, &mut buffer_size, buffer.as_ptr()).into_with(|| buffer_size)
}
/// Get the file's current position
///
/// # Errors
/// * `uefi::Status::DEVICE_ERROR` An attempt was made to get the position of a deleted file
pub fn get_position(&mut self) -> Result<u64> {
let mut pos = 0u64;
(self.inner.get_position)(self.inner, &mut pos).into_with(|| pos)
}
/// Sets the file's current position
///
/// Set the position of this file handle to the absolute position specified by `position`.
/// Seeking is not permitted outside the bounds of the file, except in the case
/// of 0xFFFFFFFFFFFFFFFF, in which case the position is set to the end of the file
///
/// # Arguments
/// * `position` The new absolution position of the file handle
///
/// # Errors
/// * `uefi::Status::DEVICE_ERROR` An attempt was made to set the position of a deleted file
pub fn set_position(&mut self, position: u64) -> Result<()> {
(self.inner.set_position)(self.inner, position).into()
}
/// Flushes all modified data associated with the file handle to the device
///
/// # Errors
/// * `uefi::Status::NO_MEDIA` The device has no media
/// * `uefi::Status::DEVICE_ERROR` The device reported an error
/// * `uefi::Status::VOLUME_CORRUPTED` The filesystem structures are corrupted
/// * `uefi::Status::WRITE_PROTECTED` The file or medium is write protected
/// * `uefi::Status::ACCESS_DENIED` The file was opened read only
/// * `uefi::Status::VOLUME_FULL` The volume is full
pub fn flush(&mut self) -> Result<()> {
(self.inner.flush)(self.inner).into()
}
}
/// The function pointer table for the File protocol.
#[repr(C)]
struct FileImpl {
revision: u64,
open: extern "win64" fn(
this: &mut FileImpl,
new_handle: &mut usize,
filename: *const u16,
open_mode: FileMode,
attributes: FileAttribute,
) -> Status,
close: extern "win64" fn(this: &mut FileImpl) -> Status,
delete: extern "win64" fn(this: &mut FileImpl) -> Status,
read:
extern "win64" fn(this: &mut FileImpl, buffer_size: &mut usize, buffer: *mut u8) -> Status,
write: extern "win64" fn(this: &mut FileImpl, buffer_size: &mut usize, buffer: *const u8)
-> Status,
get_position: extern "win64" fn(this: &mut FileImpl, position: &mut u64) -> Status,
set_position: extern "win64" fn(this: &mut FileImpl, position: u64) -> Status,
get_info: usize,
set_info: usize,
flush: extern "win64" fn(this: &mut FileImpl) -> Status,
}
bitflags! {
pub struct FileMode: u64 {
const READ = 1;
const WRITE = 1 << 1;
const CREATE = 1 << 63;
}
}
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;
}
}