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
|
//! # FIFO Queue
//!
//! Provides the FIFO queue structure for allocations
use crate::sync::NullLock;
use crate::sync::interface::Mutex;
use crate::vprintln;
use core::fmt;
use core::fmt::{Debug,Formatter};
/// # Initialize Queue
/// - Name: Symbol name
/// - Size: Number of elements
/// - Default: Default value
/// - Type: Data Type
#[macro_export]
macro_rules! init_queue {
($name:tt,$size:tt,$default:tt,$type:ty) => {
init_queue!{@gen [$name,$size,$default,$type,concat!("# ", stringify!($type), " Queue Allocator")]}
};
(@gen [$name:tt,$size:tt,$default:tt,$type:ty,$doc:expr]) => {
#[doc = $doc]
#[link_section = ".data.alloc"]
pub static $name: QueueAllocator<'static, $type, {$size+2}> = QueueAllocator::<$type, {$size+2}>{inner: NullLock::new([QueueItem::new($default); {$size+2}])};
};
}
#[derive(Copy,Clone)]
/// # Queue Item
///
/// Encapsulates a data element and a pointer to
/// the next `Queue` item
pub struct QueueItem<'a, T: Sized> {
/// # Data
///
/// The encapsulated data
data: T,
/// # Pointer to the next item
///
/// Stores either `None` or points
/// to the next item.
next: Option<*mut QueueItem<'a, T>>,
}
impl<T> QueueItem<'_,T> {
/// # Constructor
pub const fn new(data: T) -> Self {
Self {
data: data,
next: None,
}
}
/// # Get the inner data
///
/// Returns a borrow of the underlying data.
pub fn inner(&mut self) -> &mut T {
&mut self.data
}
/// # Get pointer to inner data
pub fn ptr(&mut self) -> *mut u8 {
self.inner() as *mut T as *mut u8
}
}
/// # Sharing Thread Safety for QueueItem
unsafe impl<T> Send for QueueItem<'_,T> {}
impl<T: Debug> Debug for QueueItem<'_,T> {
/// # Debug formatter for `QueueItem`
///
/// Output the encapsulated data
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
#[cfg(feature="verbose")]
return write!(f, "{:?} {:x} {:?}", self.data, self as *const QueueItem<'_,T> as usize, self.next);
#[cfg(not(feature="verbose"))]
return write!(f, "{:?}", self.data);
}
}
/// # Queue Allocator
///
/// Structure to store a pool of allocated data structures.
pub struct QueueAllocator<'a, T: Sized, const COUNT: usize> {
/// # Synchronized Pool of items
///
/// Stores synchronization wrapper around the data pool
pub inner: NullLock<[QueueItem<'a, T>;COUNT]>,
}
/// # Sharing Thread Safety for QueueAllocator
unsafe impl<T,const COUNT: usize> Send for QueueAllocator<'_,T,COUNT> {}
impl<'a, T: Sized,const COUNT: usize> QueueAllocator<'a, T, COUNT> {
/// # Initialization of Fixed-Size Pool
///
/// Establishes the header and footer of the queue
/// as the first and second elements respectively.
/// All of the internal elements point to the next
/// one and the final element points to `None`
pub fn init(&self) {
vprintln!("QA: Initializing Queue Allocator!");
self.inner.lock(|queue| {
vprintln!("QA: Clearing internal references...");
for idx in 2..COUNT {
if idx != COUNT-1 {
queue[idx].next = Some(&mut queue[idx+1] as *mut QueueItem<'a, T>);
} else {
queue[idx].next = None;
}
}
vprintln!("QA: Initializing head and tail...");
queue[0].next = Some(&mut queue[2] as *mut QueueItem<'a, T>);
queue[1].next = Some(&mut queue[COUNT-1] as *mut QueueItem<'a, T>);
});
vprintln!("QA: Initialized Queue Allocator!");
}
/// # Allocate Data
///
/// If there is a data chunk available,
/// return it, otherwise return `None`
#[allow(dead_code)]
pub fn alloc(&self) -> Option<&mut QueueItem<'a,T>> {
vprintln!("QA: Allocating chunk!");
return self.inner.lock(|pool| {
if let Some(entry) = pool[0].next {
vprintln!("QA: Found chunk!");
pool[0].next = unsafe { (*entry).next };
unsafe {
(*entry).next = None;
}
match pool[0].next {
None => {
pool[1].next = None
}
_ => {}
}
vprintln!("QA: \x1b[92mAllocated {:x}\x1b[0m", unsafe{(*entry).ptr() as usize});
return Some(unsafe{&mut *entry as &mut QueueItem<'a,T>});
} else {
vprintln!("QA: No chunks available!");
return None;
}
});
}
/// # Free
///
/// Add the item to the end of the queue.
/// If there were no items, set it as the head.
#[allow(dead_code)]
pub fn free(&self, freed_item: &mut QueueItem<'a,T>) {
vprintln!("QA: Deallocating chunk!");
self.inner.lock(|pool| {
freed_item.next = None;
match pool[1].next {
None => {
pool[0].next = Some(freed_item as *mut QueueItem<'a,T>);
}
Some(entry) => {
unsafe {
(*entry).next = Some(freed_item as *mut QueueItem<'a,T>);
}
}
}
pool[1].next = Some(freed_item as *mut QueueItem<'a,T>);
vprintln!("QA: \x1b[91mDeallocated {:x}\x1b[0m", freed_item.ptr() as usize);
});
}
}
impl<T: Debug,const COUNT: usize> Debug for QueueAllocator<'_,T,COUNT> {
/// # Debug Formatted Output
///
/// Output each data point in the array with
/// its debug formatter.
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
self.inner.lock(|queue| {
#[cfg(feature="verbose")]
return write!(f, "{:?}", queue);
#[cfg(not(feature="verbose"))]
return write!(f, "{:?}", queue);
})
}
}
|
