aligned-bytes 0.1.0

A continuous fixed-length byte array with a specified alignment.
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
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

#![no_std]
#![deny(missing_debug_implementations)]
#![deny(missing_docs)]

//! A continuous fixed-length byte array with a specified alignment.
//!
//! # Example
//! ```
//! use aligned_bytes::AlignedBytes;
//! let mut bytes = AlignedBytes::new_zeroed(1024,8);
//! let buf: &mut [u8] = &mut *bytes;
//! ```

extern crate alloc;

use alloc::alloc::{self as alloc_api, Layout};
use core::ops::{Deref, DerefMut};
use core::ptr::NonNull;
use core::slice;

/// A continuous fixed-length byte array with a specified alignment.
#[derive(Debug)]
pub struct AlignedBytes {
    align: usize,
    bytes: NonNull<[u8]>,
}

impl AlignedBytes {
    /// Allocate a zero-initialized byte array with an exact alignment.
    pub fn new_zeroed(len: usize, align: usize) -> Self {
        let layout = match Layout::from_size_align(len, align) {
            Ok(layout) => layout,
            Err(_) => panic!("Invalid layout: size = {}, align = {}", len, align),
        };
        let bytes = unsafe {
            let ptr = alloc_api::alloc_zeroed(layout);
            if ptr.is_null() {
                alloc_api::handle_alloc_error(layout);
            }
            debug_assert!(
                (ptr as usize) % align == 0,
                "pointer = {:p} is not a multiple of alignment = {}",
                ptr,
                align
            );
            NonNull::new_unchecked(slice::from_raw_parts_mut(ptr, len))
        };
        Self { align, bytes }
    }

    /// Returns the alignment of the byte array.
    pub fn alignment(&self) -> usize {
        self.align
    }
}

impl Drop for AlignedBytes {
    fn drop(&mut self) {
        unsafe {
            let size = self.deref().len();
            let layout = Layout::from_size_align_unchecked(size, self.align);
            let ptr: *mut u8 = self.bytes.as_ptr().cast();
            alloc_api::dealloc(ptr, layout)
        }
    }
}

impl Deref for AlignedBytes {
    type Target = [u8];
    fn deref(&self) -> &Self::Target {
        unsafe { &*self.bytes.as_ptr() }
    }
}

impl DerefMut for AlignedBytes {
    fn deref_mut(&mut self) -> &mut Self::Target {
        unsafe { &mut *self.bytes.as_ptr() }
    }
}

impl AsRef<[u8]> for AlignedBytes {
    fn as_ref(&self) -> &[u8] {
        &*self
    }
}

impl AsMut<[u8]> for AlignedBytes {
    fn as_mut(&mut self) -> &mut [u8] {
        &mut *self
    }
}

#[cfg(test)]
mod tests {
    use super::AlignedBytes;

    #[test]
    fn check_alignment() {
        let align = 4096;
        let bytes = AlignedBytes::new_zeroed(8, align);
        assert_eq!(bytes.alignment(), align);
        assert!(bytes.as_ptr() as usize % align == 0);
    }

    #[should_panic(expected = "Invalid layout: size = 1, align = 0")]
    #[test]
    fn check_layout_zero_align() {
        AlignedBytes::new_zeroed(1, 0);
    }

    #[should_panic(expected = "Invalid layout: size = 1, align = 3")]
    #[test]
    fn check_layout_align_not_power_of_2() {
        AlignedBytes::new_zeroed(1, 3);
    }

    #[should_panic]
    #[test]
    fn check_layout_overflow() {
        let size = core::mem::size_of::<usize>() * 8;
        AlignedBytes::new_zeroed((1usize << (size - 1)) + 1, 1usize << (size - 1));
    }
}