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
//! A crate for stack-allocated fixed-length multiqueues. A multiqueue is an array of a given number of queues, //! each able to be accessed independently. //! //! In term, this crate should include a feature that enables the user to specify what the multiqueue must do //! in the case the `pop` or `push` method cannot operate (e.g. empty or full individual queue.). //! For instance, one could wish the operation is, in such a case, applied to the following queue. //! //! This crate was motivated by the creation of a multiple-round-robin-based scheduler in a toy micro-kernel. //! Each queue holds all the threads within the same priority level. //! Attempting to create a new thread in an already full priority level would simply decrease its priority //! until a suitable non-full queue is found. //! //! Based on an original idea from [Pollux3737](https://github.com/Pollux3737). use std::mem::MaybeUninit; /// Errors that may be encountered during use of the [`MultiStackQueue`] /// /// * `QueueFull` - Returned by the `push` method when trying to append a value to a queue that is already full /// * `QueueEmpty` - Returned by the `pop` method when trying to pop a value from an empty queue /// * `QueueIndexOutOfBounds` - When trying to access a queue beyond the multiqueue /// * `UnknownError` - This should never happen. Used for development #[derive(Debug, Copy, Clone, Eq, PartialEq)] pub enum MSQError { QueueFull, QueueEmpty, QueueIndexOutOfBounds, UnknowmError, } /// An abstract structure containin multiple stack-allocated bounded queues. /// /// Each queue is stored as an `[Option<T>; N]` and the multiqueue stores //// the complete data in an `[[Option<T>; N]; M]. /// /// # Usage /// /// The generic definition is the following : /// /// ```ignore /// MultiStackQueue<T, const N: usize, const M: usize> /// ``` /// /// With : /// /// * `T` - type contained in the queues /// * `N` - length of each queue /// * `M` - number of queues /// /// # Example usecases /// /// * When writing a simple micro-kernel, the scheduler may need some sort of multiple Round-Robins. /// Having it allocated on the stack removes the need for a heap allocator, which can be useful /// when working on this kind of ressource-limited target. /// /// # Examples /// /// ``` /// use multi_stack_queue::MultiStackQueue; /// /// #[derive(Clone, Copy, Debug, PartialEq, Eq)] /// struct TestStruct { /// a: usize, /// b: bool, /// } /// /// let mut msq: MultiStackQueue<TestStruct, 16, 8> = MultiStackQueue::new(); /// let value = TestStruct { a: 42, b: false }; /// /// msq.push(7, value).unwrap(); /// /// assert_eq!(msq.pop(7).unwrap(), value); /// ``` /// pub struct MultiStackQueue<T, const N: usize, const M: usize> { data: [[Option<T>; N]; M], ins: [usize; M], outs: [usize; M], empty: [bool; M], } impl<T, const N: usize, const M: usize> MultiStackQueue<T, N, M> { /// Returns a new empty multiqueue. /// /// # Examples /// /// ``` /// use multi_stack_queue::MultiStackQueue; /// // Returns a fresh empty multiqueue containing 8 queues of `usize` with size 16 /// let a: MultiStackQueue<usize, 16, 8> = MultiStackQueue::new(); /// /// #[derive(Clone, Copy)] /// struct TestStruct { /// a: usize, /// b: bool /// } /// /// let random_data = TestStruct { a: 42, b: false }; /// /// let msq: MultiStackQueue<TestStruct, 4, 2> = MultiStackQueue::new(); /// ``` /// pub fn new() -> Self { let d: [[Option<T>; N]; M] = unsafe { MaybeUninit::uninit().assume_init() }; MultiStackQueue { data: d, ins: [0usize; M], outs: [0usize; M], empty: [true; M], } } /// Appends a value to the multiqueue. /// /// # Examples /// /// ``` /// use multi_stack_queue::MultiStackQueue; /// /// #[derive(Clone, Copy)] /// struct TestStruct { /// a: usize, /// b: bool /// } /// /// let random_data = TestStruct { a: 42, b: false }; /// /// let mut msq: MultiStackQueue<TestStruct, 4, 2> = MultiStackQueue::new(); /// /// msq.push(0, random_data).unwrap(); /// ``` /// pub fn push(&mut self, id: usize, value: T) -> Result<(), MSQError> { if id >= M { return Err(MSQError::QueueIndexOutOfBounds); } self.try_and_push(id, value) } // Inner `push` function fn try_and_push(&mut self, id: usize, value: T) -> Result<(), MSQError> { if self.ins[id] == self.outs[id] && !self.empty[id] { // Queue is full Err(MSQError::QueueFull) } else { self.data[id][self.ins[id]] = Some(value); self.ins[id] = (self.ins[id] + 1) % N; self.empty[id] = false; Ok(()) } } /// Pops a value from the multiqueue. /// /// # Examples /// /// ``` /// use multi_stack_queue::MultiStackQueue; /// /// #[derive(Clone, Copy)] /// struct TestStruct { /// a: usize, /// b: bool /// } /// /// let random_data = TestStruct { a: 42, b: false }; /// /// let mut msq: MultiStackQueue<TestStruct, 4, 2> = MultiStackQueue::new(); /// /// msq.push(0, random_data).unwrap(); /// msq.pop(0).unwrap(); /// ``` /// pub fn pop(&mut self, id: usize) -> Result<T, MSQError> { if id >= M { return Err(MSQError::QueueIndexOutOfBounds); } self.try_and_pop(id) } /// Inner `pop` function fn try_and_pop(&mut self, id: usize) -> Result<T, MSQError> { if self.empty[id] { Err(MSQError::QueueEmpty) } else { // TODO The unwrap is not ideal let res = self.data[id][self.outs[id]].take().unwrap(); self.outs[id] = (self.outs[id] + 1) % N; if self.outs[id] == self.ins[id] { self.empty[id] = true; } Ok(res) } } /// Returns whether a particular queue is full /// # Examples /// /// ``` /// use multi_stack_queue::MultiStackQueue; /// /// let mut msq: MultiStackQueue<usize, 4, 2> = MultiStackQueue::new(); /// /// assert!(!msq.is_full(0)); /// for _ in 0..4 { /// msq.push(0, 0); /// } /// assert!(msq.is_full(0)); /// ``` /// pub fn is_full(&self, id: usize) -> bool { !self.empty[id] && self.ins[id] == self.outs[id] } /// Returns whether a particular queue is empty /// # Examples /// /// ``` /// use multi_stack_queue::MultiStackQueue; /// /// let mut msq: MultiStackQueue<usize, 4, 2> = MultiStackQueue::new(); /// /// assert!(msq.is_empty(0)); /// msq.push(0, 0); /// assert!(!msq.is_empty(0)); /// ``` /// pub fn is_empty(&self, id: usize) -> bool { self.empty[id] } } #[cfg(test)] mod tests { use crate::MultiStackQueue; /// Simple test structure #[derive(Clone, Copy, Debug, PartialEq, Eq)] struct TestStruct { a: usize, b: bool, } /// Testing the creation of a MSQ #[test] fn creation() { let a: MultiStackQueue<TestStruct, 16, 32> = MultiStackQueue::new(); } /// Testing one `push` operation #[test] fn push_once() { let mut a: MultiStackQueue<TestStruct, 16, 32> = MultiStackQueue::new(); let val = TestStruct { a: 42, b: true }; a.push(12, val).unwrap(); } /// Testing one push-pop cycle #[test] fn push_and_pop_once() { let mut a: MultiStackQueue<TestStruct, 16, 32> = MultiStackQueue::new(); let val = TestStruct { a: 42, b: true }; a.push(12, val).unwrap(); assert_eq!(a.pop(12).unwrap(), val); assert!(a.is_empty(12)); } /// Testing push-pop-pop #[test] #[should_panic] fn push_and_pop_twice() { let mut a: MultiStackQueue<TestStruct, 16, 32> = MultiStackQueue::new(); let val = TestStruct { a: 42, b: true }; a.push(12, val).unwrap(); a.pop(12).unwrap(); a.pop(12).unwrap(); } /// testing a single pop operation #[test] #[should_panic] fn pop_empty() { let mut a: MultiStackQueue<TestStruct, 16, 32> = MultiStackQueue::new(); a.pop(12).unwrap(); } /// Testing the filling of a queue #[test] fn fill() { let mut a: MultiStackQueue<TestStruct, 16, 32> = MultiStackQueue::new(); let val = TestStruct { a: 42, b: true }; for _ in 0..16 { a.push(12, val).unwrap(); } } /// Testing the overflow of a queue #[test] #[should_panic] fn fill_overflow() { let mut a: MultiStackQueue<TestStruct, 16, 32> = MultiStackQueue::new(); let val = TestStruct { a: 42, b: true }; for _ in 0..=16 { a.push(12, val).unwrap(); } } /// Testing that the queue works as intended #[test] fn fifo() { let mut a: MultiStackQueue<usize, 16, 32> = MultiStackQueue::new(); a.push(0, 1).unwrap(); a.push(0, 2).unwrap(); assert_eq!(a.pop(0).unwrap(), 1); assert_eq!(a.pop(0).unwrap(), 2); } }