lamzfs 0.1.0

no_std read-only ZFS reader for UEFI bootloaders (single/mirror/raidz1, unencrypted bpool)
Documentation 
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

// SPDX-License-Identifier: MIT
// Adapted from rzfs @ea41cf0b5b29 (dual GPL-2.0 OR MIT; MIT elected); see NOTICE.

/** ZFS sector shift.
 *
 * Power of two of a ZFS sector.
 */
pub const SECTOR_SHIFT: u32 = 9;

////////////////////////////////////////////////////////////////////////////////

/** Is the value a multiple of a sector size.
 *
 * ZFS uses sectors of size 512.
 */
pub trait IsMultipleOfSectorSize {
    /** Is the value a multiple of a sector size.
     *
     * ZFS uses sectors of size 512.
     *
     * # Examples
     *
     * ```
     * use rzfs::phys::IsMultipleOfSectorSize;
     *
     * let value: u16 = 512;
     * assert_eq!(value.is_multiple_of_sector_size(), true);
     *
     * let value: u32 = 513;
     * assert_eq!(value.is_multiple_of_sector_size(), false);
     *
     * let value: u64 = 1024;
     * assert_eq!(value.is_multiple_of_sector_size(), true);
     *
     * let value: usize = 1025;
     * assert_eq!(value.is_multiple_of_sector_size(), false);
     * ```
     */
    fn is_multiple_of_sector_size(&self) -> bool;
}

impl IsMultipleOfSectorSize for u16 {
    fn is_multiple_of_sector_size(&self) -> bool {
        (self & ((1 << SECTOR_SHIFT) - 1)) == 0
    }
}

impl IsMultipleOfSectorSize for u32 {
    fn is_multiple_of_sector_size(&self) -> bool {
        (self & ((1 << SECTOR_SHIFT) - 1)) == 0
    }
}

impl IsMultipleOfSectorSize for u64 {
    fn is_multiple_of_sector_size(&self) -> bool {
        (self & ((1 << SECTOR_SHIFT) - 1)) == 0
    }
}

impl IsMultipleOfSectorSize for usize {
    fn is_multiple_of_sector_size(&self) -> bool {
        (self & ((1 << SECTOR_SHIFT) - 1)) == 0
    }
}

////////////////////////////////////////////////////////////////////////////////

/** Is the value a multiple of a sector size.
 *
 * ZFS uses sectors of size 512.
 *
 * # Examples
 *
 * ```
 * use rzfs::phys::{is_multiple_of_sector_size, IsMultipleOfSectorSize};
 *
 * let value: u16 = 512;
 * assert_eq!(is_multiple_of_sector_size(value), true);
 *
 * let value: u32 = 513;
 * assert_eq!(is_multiple_of_sector_size(value), false);
 *
 * let value: u64 = 1024;
 * assert_eq!(is_multiple_of_sector_size(value), true);
 *
 * let value: usize = 1025;
 * assert_eq!(is_multiple_of_sector_size(value), false);
 * ```
 */
pub fn is_multiple_of_sector_size<F: IsMultipleOfSectorSize>(value: F) -> bool {
    IsMultipleOfSectorSize::is_multiple_of_sector_size(&value)
}

////////////////////////////////////////////////////////////////////////////////