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 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
use super::FileAttribute;
use crate::data_types::Align;
use crate::table::runtime::Time;
use crate::{CStr16, Char16, Guid, Identify};
use core::ffi::c_void;
use core::fmt::{self, Display, Formatter};
use core::{mem, ptr};
use ptr_meta::Pointee;
/// Common trait for data structures that can be used with
/// `File::set_info()` or `File::get_info()`.
///
/// The long-winded name is needed because "FileInfo" is already taken by UEFI.
pub trait FileProtocolInfo: Align + Identify + FromUefi {}
/// Trait for going from an UEFI-originated pointer to a Rust reference
///
/// This is trivial for `Sized` types, but requires some work when operating on
/// dynamic-sized types like `NamedFileProtocolInfo`, as the second member of
/// the fat pointer must be reconstructed using hidden UEFI-provided metadata.
pub trait FromUefi {
/// Turn an UEFI-provided pointer-to-base into a (possibly fat) Rust reference
///
/// # Safety
///
/// This function can lead to undefined behavior if the given pointer is not
/// pointing to a valid object of the specified type.
unsafe fn from_uefi<'ptr>(ptr: *mut c_void) -> &'ptr mut Self;
}
/// Internal trait for initializing one of the info types.
///
/// This is used with `FileInfo`, `FileSystemInfo`, and
/// `FileSystemVolumeLabel`, all of which are dynamically-sized structs
/// that have zero or more header fields followed by a variable-length
/// [Char16] name.
trait InfoInternal: Align + ptr_meta::Pointee<Metadata = usize> {
/// Offset in bytes of the start of the name slice at the end of
/// the struct.
fn name_offset() -> usize;
/// Get a mutable pointer to the name slice at the end of the
/// struct.
unsafe fn name_ptr(ptr: *mut u8) -> *mut Char16 {
let offset_of_str = Self::name_offset();
ptr.add(offset_of_str).cast::<Char16>()
}
/// Create a new info type in user-provided storage.
///
/// The structure will be created in-place within the provided
/// `storage` buffer. The alignment and size of the buffer is
/// checked, then the `init` function is called to fill in the
/// struct header (everything except for the name slice). The name
/// slice is then initialized, and at that point the struct is fully
/// initialized so it's safe to create a reference.
///
/// # Safety
///
/// The `init` function must initialize the entire struct except for
/// the name slice.
unsafe fn new_impl<'buf, F>(
storage: &'buf mut [u8],
name: &CStr16,
init: F,
) -> Result<&'buf mut Self, FileInfoCreationError>
where
F: FnOnce(*mut Self, u64),
{
// Calculate the final size of the struct.
let name_length_ucs2 = name.as_slice_with_nul().len();
let name_size = mem::size_of_val(name.as_slice_with_nul());
let info_size = Self::name_offset() + name_size;
let info_size = Self::round_up_to_alignment(info_size);
// Make sure that the storage is properly aligned
let storage = Self::align_buf(storage)
.ok_or(FileInfoCreationError::InsufficientStorage(info_size))?;
Self::assert_aligned(storage);
// Make sure that the storage is large enough for our needs
if storage.len() < info_size {
return Err(FileInfoCreationError::InsufficientStorage(info_size));
}
// Create a raw fat pointer using the `storage` as a base.
let info_ptr: *mut Self =
ptr_meta::from_raw_parts_mut(storage.as_mut_ptr().cast::<()>(), name_length_ucs2);
// Initialize the struct header.
init(info_ptr, info_size as u64);
// Create a pointer to the part of info where the name is
// stored. Note that `info_ptr` is used rather than `storage` to
// comply with Stacked Borrows.
let info_name_ptr = Self::name_ptr(info_ptr.cast::<u8>());
// Initialize the name slice.
ptr::copy(name.as_ptr(), info_name_ptr, name_length_ucs2);
// The struct is now valid and safe to dereference.
let info = &mut *info_ptr;
Ok(info)
}
}
impl<T> FromUefi for T
where
T: InfoInternal + ?Sized,
{
unsafe fn from_uefi<'ptr>(ptr: *mut c_void) -> &'ptr mut Self {
let name_ptr = Self::name_ptr(ptr.cast::<u8>());
let name = CStr16::from_ptr(name_ptr);
let name_len = name.as_slice_with_nul().len();
&mut *ptr_meta::from_raw_parts_mut(ptr.cast::<()>(), name_len)
}
}
/// Errors that can occur when creating a `FileProtocolInfo`
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum FileInfoCreationError {
/// The provided buffer was too small to hold the `FileInfo`. You need at
/// least the indicated buffer size (in bytes). Please remember that using
/// a misaligned buffer will cause a decrease of usable storage capacity.
InsufficientStorage(usize),
}
impl Display for FileInfoCreationError {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
match self {
Self::InsufficientStorage(bytes) => write!(
f,
"provided buffer was too small. need at least {} bytes",
bytes
),
}
}
}
#[cfg(feature = "unstable")]
impl core::error::Error for FileInfoCreationError {}
/// Generic file information
///
/// The following rules apply when using this struct with `set_info()`:
///
/// - On directories, the file size is determined by the contents of the
/// directory and cannot be changed by setting `file_size`. This member is
/// ignored by `set_info()`.
/// - The `physical_size` is determined by the `file_size` and cannot be
/// changed. This member is ignored by `set_info()`.
/// - The `FileAttribute::DIRECTORY` bit cannot be changed. It must match the
/// file’s actual type.
/// - A value of zero in create_time, last_access, or modification_time causes
/// the fields to be ignored (and not updated).
/// - It is forbidden to change the name of a file to the name of another
/// existing file in the same directory.
/// - If a file is read-only, the only allowed change is to remove the read-only
/// attribute. Other changes must be carried out in a separate transaction.
#[derive(Debug, Eq, PartialEq, Pointee)]
#[repr(C)]
pub struct FileInfo {
size: u64,
file_size: u64,
physical_size: u64,
create_time: Time,
last_access_time: Time,
modification_time: Time,
attribute: FileAttribute,
file_name: [Char16],
}
impl FileInfo {
/// Create a `FileInfo` structure
///
/// The structure will be created in-place within the provided storage
/// buffer. The buffer must be large enough to hold the data structure,
/// including a null-terminated UCS-2 `name` string.
///
/// The buffer must be correctly aligned. You can query the required
/// alignment using the `alignment()` method of the `Align` trait that this
/// struct implements.
#[allow(clippy::too_many_arguments)]
pub fn new<'buf>(
storage: &'buf mut [u8],
file_size: u64,
physical_size: u64,
create_time: Time,
last_access_time: Time,
modification_time: Time,
attribute: FileAttribute,
file_name: &CStr16,
) -> core::result::Result<&'buf mut Self, FileInfoCreationError> {
unsafe {
Self::new_impl(storage, file_name, |ptr, size| {
ptr::addr_of_mut!((*ptr).size).write(size);
ptr::addr_of_mut!((*ptr).file_size).write(file_size);
ptr::addr_of_mut!((*ptr).physical_size).write(physical_size);
ptr::addr_of_mut!((*ptr).create_time).write(create_time);
ptr::addr_of_mut!((*ptr).last_access_time).write(last_access_time);
ptr::addr_of_mut!((*ptr).modification_time).write(modification_time);
ptr::addr_of_mut!((*ptr).attribute).write(attribute);
})
}
}
/// File size (number of bytes stored in the file)
#[must_use]
pub const fn file_size(&self) -> u64 {
self.file_size
}
/// Physical space consumed by the file on the file system volume
#[must_use]
pub const fn physical_size(&self) -> u64 {
self.physical_size
}
/// Time when the file was created
#[must_use]
pub const fn create_time(&self) -> &Time {
&self.create_time
}
/// Time when the file was last accessed
#[must_use]
pub const fn last_access_time(&self) -> &Time {
&self.last_access_time
}
/// Time when the file's contents were last modified
#[must_use]
pub const fn modification_time(&self) -> &Time {
&self.modification_time
}
/// Attribute bits for the file
#[must_use]
pub const fn attribute(&self) -> FileAttribute {
self.attribute
}
/// Name of the file
#[must_use]
pub fn file_name(&self) -> &CStr16 {
unsafe { CStr16::from_ptr(self.file_name.as_ptr()) }
}
/// Returns if the file is a directory.
#[must_use]
pub fn is_directory(&self) -> bool {
self.attribute.contains(FileAttribute::DIRECTORY)
}
/// Returns if the file is a regular file.
#[must_use]
pub fn is_regular_file(&self) -> bool {
!self.is_directory()
}
}
impl Align for FileInfo {
fn alignment() -> usize {
8
}
}
unsafe impl Identify for FileInfo {
const GUID: Guid = uefi_raw::protocol::file_system::FileInfo::ID;
}
impl InfoInternal for FileInfo {
fn name_offset() -> usize {
80
}
}
impl FileProtocolInfo for FileInfo {}
/// System volume information
///
/// May only be obtained on the root directory's file handle.
///
/// Please note that only the system volume's volume label may be set using
/// this information structure. Consider using `FileSystemVolumeLabel` instead.
#[derive(Debug, Eq, PartialEq, Pointee)]
#[repr(C)]
pub struct FileSystemInfo {
size: u64,
read_only: bool,
volume_size: u64,
free_space: u64,
block_size: u32,
volume_label: [Char16],
}
impl FileSystemInfo {
/// Create a `FileSystemInfo` structure
///
/// The structure will be created in-place within the provided storage
/// buffer. The buffer must be large enough to hold the data structure,
/// including a null-terminated UCS-2 `name` string.
///
/// The buffer must be correctly aligned. You can query the required
/// alignment using the `alignment()` method of the `Align` trait that this
/// struct implements.
pub fn new<'buf>(
storage: &'buf mut [u8],
read_only: bool,
volume_size: u64,
free_space: u64,
block_size: u32,
volume_label: &CStr16,
) -> core::result::Result<&'buf mut Self, FileInfoCreationError> {
unsafe {
Self::new_impl(storage, volume_label, |ptr, size| {
ptr::addr_of_mut!((*ptr).size).write(size);
ptr::addr_of_mut!((*ptr).read_only).write(read_only);
ptr::addr_of_mut!((*ptr).volume_size).write(volume_size);
ptr::addr_of_mut!((*ptr).free_space).write(free_space);
ptr::addr_of_mut!((*ptr).block_size).write(block_size);
})
}
}
/// Truth that the volume only supports read access
#[must_use]
pub const fn read_only(&self) -> bool {
self.read_only
}
/// Number of bytes managed by the file system
#[must_use]
pub const fn volume_size(&self) -> u64 {
self.volume_size
}
/// Number of available bytes for use by the file system
#[must_use]
pub const fn free_space(&self) -> u64 {
self.free_space
}
/// Nominal block size by which files are typically grown
#[must_use]
pub const fn block_size(&self) -> u32 {
self.block_size
}
/// Volume label
#[must_use]
pub fn volume_label(&self) -> &CStr16 {
unsafe { CStr16::from_ptr(self.volume_label.as_ptr()) }
}
}
impl Align for FileSystemInfo {
fn alignment() -> usize {
8
}
}
unsafe impl Identify for FileSystemInfo {
const GUID: Guid = uefi_raw::protocol::file_system::FileSystemInfo::ID;
}
impl InfoInternal for FileSystemInfo {
fn name_offset() -> usize {
36
}
}
impl FileProtocolInfo for FileSystemInfo {}
/// System volume label
///
/// May only be obtained on the root directory's file handle.
#[derive(Debug, Eq, PartialEq, Pointee)]
#[repr(C)]
pub struct FileSystemVolumeLabel {
volume_label: [Char16],
}
impl FileSystemVolumeLabel {
/// Create a `FileSystemVolumeLabel` structure
///
/// The structure will be created in-place within the provided storage
/// buffer. The buffer must be large enough to hold the data structure,
/// including a null-terminated UCS-2 `name` string.
///
/// The buffer must be correctly aligned. You can query the required
/// alignment using the `alignment()` method of the `Align` trait that this
/// struct implements.
pub fn new<'buf>(
storage: &'buf mut [u8],
volume_label: &CStr16,
) -> core::result::Result<&'buf mut Self, FileInfoCreationError> {
unsafe { Self::new_impl(storage, volume_label, |_ptr, _size| {}) }
}
/// Volume label
#[must_use]
pub fn volume_label(&self) -> &CStr16 {
unsafe { CStr16::from_ptr(self.volume_label.as_ptr()) }
}
}
impl Align for FileSystemVolumeLabel {
fn alignment() -> usize {
2
}
}
unsafe impl Identify for FileSystemVolumeLabel {
const GUID: Guid = uefi_raw::protocol::file_system::FileSystemVolumeLabel::ID;
}
impl InfoInternal for FileSystemVolumeLabel {
fn name_offset() -> usize {
0
}
}
impl FileProtocolInfo for FileSystemVolumeLabel {}
#[cfg(test)]
mod tests {
use super::*;
use crate::table::runtime::{Daylight, Time, TimeParams};
use crate::CString16;
use alloc::vec;
fn validate_layout<T: InfoInternal + ?Sized>(info: &T, name: &[Char16]) {
// Check the hardcoded struct alignment.
assert_eq!(mem::align_of_val(info), T::alignment());
// Check the hardcoded name slice offset.
assert_eq!(
unsafe { (name.as_ptr() as *const u8).offset_from(info as *const _ as *const u8) },
T::name_offset() as isize
);
}
#[test]
fn test_file_info() {
let mut storage = vec![0; 128];
let file_size = 123;
let physical_size = 456;
let tp = TimeParams {
year: 1970,
month: 1,
day: 1,
hour: 0,
minute: 0,
second: 0,
nanosecond: 0,
time_zone: None,
daylight: Daylight::IN_DAYLIGHT,
};
let create_time = Time::new(tp).unwrap();
let last_access_time = Time::new(TimeParams { year: 1971, ..tp }).unwrap();
let modification_time = Time::new(TimeParams { year: 1972, ..tp }).unwrap();
let attribute = FileAttribute::READ_ONLY;
let name = CString16::try_from("test_name").unwrap();
let info = FileInfo::new(
&mut storage,
file_size,
physical_size,
create_time,
last_access_time,
modification_time,
attribute,
&name,
)
.unwrap();
validate_layout(info, &info.file_name);
// Header size: 80 bytes
// + Name size (including trailing null): 20 bytes
// = 100
// Round size up to match FileInfo alignment of 8: 104
assert_eq!(info.size, 104);
assert_eq!(info.size, mem::size_of_val(info) as u64);
assert_eq!(info.file_size(), file_size);
assert_eq!(info.physical_size(), physical_size);
assert_eq!(info.create_time(), &create_time);
assert_eq!(info.last_access_time(), &last_access_time);
assert_eq!(info.modification_time(), &modification_time);
assert_eq!(info.attribute(), attribute);
assert_eq!(info.file_name(), name);
}
#[test]
fn test_file_system_info() {
let mut storage = vec![0; 128];
let read_only = true;
let volume_size = 123;
let free_space = 456;
let block_size = 789;
let name = CString16::try_from("test_name2").unwrap();
let info = FileSystemInfo::new(
&mut storage,
read_only,
volume_size,
free_space,
block_size,
&name,
)
.unwrap();
validate_layout(info, &info.volume_label);
// Header size: 36 bytes
// + Name size (including trailing null): 22 bytes
// = 58
// Round size up to match FileSystemInfo alignment of 8: 64
assert_eq!(info.size, 64);
assert_eq!(info.size, mem::size_of_val(info) as u64);
assert_eq!(info.read_only, read_only);
assert_eq!(info.volume_size, volume_size);
assert_eq!(info.free_space, free_space);
assert_eq!(info.block_size, block_size);
assert_eq!(info.volume_label(), name);
}
#[test]
fn test_file_system_volume_label() {
let mut storage = vec![0; 128];
let name = CString16::try_from("test_name").unwrap();
let info = FileSystemVolumeLabel::new(&mut storage, &name).unwrap();
validate_layout(info, &info.volume_label);
assert_eq!(info.volume_label(), name);
}
}