monagement 0.0.3

TLSF Memory Management
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

<div align="center">
    <h1>MONAGEMENT</h1>
    <b><p>TLSF MEMORY ALLOCATOR</p></b>
    <p>⚙️ under development ⚙️</p>
    <b>
        <p>Version / 0.0.3</p>
    </b>
</div>

## About
`Monagement`, is a memory allocator project written in rust that is based on the `TLSF` (Two-Level Segregated Fit) concept.

## Main Architecture
### Two-Level Segregated Fit
uses a 2-level bitmap hierarchy in searching for empty blocks, thus reducing the need for linear scanning.
### Bitmap
use of bitmaps for fast search
### Coalescing
any adjacent free blocks will be automatically merged to reduce fragmentation.

## What's New?
see what's new in version 0.0.2: [version/0.0.2](./version.md)

## Changelog
[changelog.md](./changelog.md)

## Start
### Installation
Run the following Cargo command in your project directory:
```toml
cargo add monagement
```
Or add the following line to your Cargo.toml:
```toml
monagement = "0.0.2"
```

### Code
```rust
use monagement::{Monagement, MonagementInit};
use std::num::NonZeroU64;

fn main() {
    let allocator = Monagement::init(MonagementInit::default()).expect("Monagement Init Error");

    // allocate memory
    let allocate_a = allocator
        .allocate(NonZeroU64::new(12).unwrap())
        .expect("Memory Allocation A Error");
    let allocate_b = allocator
        .allocate(NonZeroU64::new(20).unwrap())
        .expect("Memory Allocation B Error");

    // free up memory
    allocate_a.free();
    // or
    drop(allocate_b);

    // get data link memory
    println!("{:#?}", allocator.borrow_core().get_linked_list());
}
```