Moved the bitmap data structure into a structures module

Signed-off-by: SlyMarbo <[email protected]>

Author: SlyMarbo

kernel/src/lib.rs

@@ -29,8 +29,6 @@
 
 extern crate alloc;
 
-use alloc::vec;
-use alloc::vec::Vec;
 use bootloader::BootInfo;
 use core::panic::PanicInfo;
 use lazy_static::lazy_static;
@@ -43,6 +41,7 @@ pub mod interrupts;
 pub mod memory;
 pub mod pci;
 pub mod serial;
+pub mod structures;
 pub mod task;
 pub mod time;
 
@@ -99,146 +98,6 @@ impl<A> Locked<A> {
     }
 }
 
-/// Bitmap is a simple bitmap implementation.
-///
-#[derive(Debug, PartialEq)]
-pub struct Bitmap {
-    num: usize,
-    bits: Vec<u64>,
-}
-
-impl Bitmap {
-    /// new_set returns a new bitmap with all
-    /// bits set to true.
-    ///
-    pub fn new_set(num: usize) -> Self {
-        // Make sure we only set the bits we
-        // have.
-        let mut bitmap = Bitmap::new_unset(num);
-        for i in 0..num {
-            bitmap.set(i);
-        }
-
-        bitmap
-    }
-
-    /// new_unset returns a new bitmap with all
-    /// bits set to false.
-    ///
-    pub fn new_unset(num: usize) -> Self {
-        Bitmap {
-            num,
-            bits: vec![0u64; (num + 63) / 64],
-        }
-    }
-
-    // get returns whether bit n is set.
-    //
-    // get will panic if n exceeds the bitmap's
-    // size in bits.
-    //
-    pub fn get(&self, n: usize) -> bool {
-        if n >= self.num {
-            panic!("cannot call get({}) on Bitmap of size {}", n, self.num);
-        }
-
-        let i = n / 64;
-        let j = n % 64;
-        let mask = 1u64 << (j as u64);
-
-        self.bits[i] & mask == mask
-    }
-
-    // set sets bit n to true.
-    //
-    // set will panic if n exceeds the bitmap's
-    // size in bits.
-    //
-    pub fn set(&mut self, n: usize) {
-        if n >= self.num {
-            panic!("cannot call set({}) on Bitmap of size {}", n, self.num);
-        }
-
-        let i = n / 64;
-        let j = n % 64;
-        let mask = 1u64 << (j as u64);
-
-        self.bits[i] |= mask;
-    }
-
-    // unset sets bit n to false.
-    //
-    // unset will panic if n exceeds the bitmap's
-    // size in bits.
-    //
-    pub fn unset(&mut self, n: usize) {
-        if n >= self.num {
-            panic!("cannot call unset({}) on Bitmap of size {}", n, self.num);
-        }
-
-        let i = n / 64;
-        let j = n % 64;
-        let mask = 1u64 << (j as u64);
-
-        self.bits[i] &= !mask;
-    }
-
-    // next_set returns the smallest n, such that
-    // bit n is set (true), or None if all bits
-    // are false.
-    //
-    pub fn next_set(&self) -> Option<usize> {
-        for (i, values) in self.bits.iter().enumerate() {
-            for j in 0..64 {
-                let mask = 1u64 << (j as u64);
-                if values & mask == mask {
-                    return Some(i * 64 + j);
-                }
-            }
-        }
-
-        None
-    }
-
-    // next_n_set returns the smallest i, such that
-    // bits i to i+n-1 are set (true), or None if
-    // no such i can be found..
-    //
-    pub fn next_n_set(&self, n: usize) -> Option<usize> {
-        let mut mask = 0u64;
-        for i in 0..n {
-            mask |= 1 << i;
-        }
-
-        for (i, values) in self.bits.iter().enumerate() {
-            for j in 0..64 - n {
-                if values & mask << j == mask << j {
-                    return Some(i * 64 + j);
-                }
-            }
-        }
-
-        None
-    }
-
-    // next_unset returns the smallest n, such that
-    // bit n is unset (false), or None if all bits
-    // are true.
-    //
-    pub fn next_unset(&self) -> Option<usize> {
-        for (i, values) in self.bits.iter().enumerate() {
-            for j in 0..64 {
-                let mask = 1u64 << (j as u64);
-                if values & mask == 0 {
-                    return Some(i * 64 + j);
-                }
-            }
-        }
-
-        None
-    }
-}
-
 // Test helpers.
 
 /// Testable represents a test function.
@@ -337,68 +196,3 @@ fn test_kernel_main(boot_info: &'static BootInfo) -> ! {
 fn panic(info: &PanicInfo) -> ! {
     test_panic_handler(info)
 }
-
-#[test_case]
-fn bitmap() {
-    let mut bitmap = Bitmap::new_unset(7);
-    for i in 0..7 {
-        // Check it's false by default.
-        assert_eq!(bitmap.get(i), false);
-        assert_eq!(bitmap.next_set(), None);
-
-        // Check set.
-        bitmap.set(i);
-        assert_eq!(bitmap.get(i), true);
-        assert_eq!(bitmap.next_set(), Some(i));
-
-        // Check unset.
-        bitmap.unset(i);
-        assert_eq!(bitmap.get(i), false);
-    }
-
-    bitmap = Bitmap::new_unset(67);
-    for i in 0..67 {
-        // Check it's false by default.
-        assert_eq!(bitmap.get(i), false);
-        assert_eq!(bitmap.next_set(), None);
-
-        // Check set.
-        bitmap.set(i);
-        assert_eq!(bitmap.get(i), true);
-        assert_eq!(bitmap.next_set(), Some(i));
-
-        // Check unset.
-        bitmap.unset(i);
-        assert_eq!(bitmap.get(i), false);
-    }
-
-    bitmap = Bitmap::new_set(7);
-    for i in 0..7 {
-        // Check it's true by default.
-        assert_eq!(bitmap.get(i), true);
-
-        // Check unset.
-        bitmap.unset(i);
-        assert_eq!(bitmap.get(i), false);
-        assert_eq!(bitmap.next_unset(), Some(i));
-
-        // Check set.
-        bitmap.set(i);
-        assert_eq!(bitmap.get(i), true);
-    }
-
-    bitmap = Bitmap::new_set(67);
-    for i in 0..67 {
-        // Check it's true by default.
-        assert_eq!(bitmap.get(i), true);
-
-        // Check unset.
-        bitmap.unset(i);
-        assert_eq!(bitmap.get(i), false);
-        assert_eq!(bitmap.next_unset(), Some(i));
-
-        // Check set.
-        bitmap.set(i);
-        assert_eq!(bitmap.get(i), true);
-    }
-}

kernel/src/memory/pmm/bitmap.rs

@@ -2,7 +2,8 @@
 //! to allocate and deallocate physical memory frames.
 
 use crate::memory::pmm::boot_info::BootInfoFrameAllocator;
-use crate::{println, Bitmap};
+use crate::println;
+use crate::structures::bitmap::Bitmap;
 use alloc::vec::Vec;
 use bootloader::bootinfo::{MemoryRegion, MemoryRegionType};
 use core::slice::Iter;