https://github.com/rcore-os/buddy_system_allocator

A buddy system allocator in pure Rust.
https://github.com/rcore-os/buddy_system_allocator

allocator bare-metal-programming buddy-system rust

Last synced: 1 day ago
JSON representation

A buddy system allocator in pure Rust.

• Host: GitHub
• URL: https://github.com/rcore-os/buddy_system_allocator
• Owner: rcore-os
• License: mit
• Created: 2019-03-17T17:54:28.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-21T16:45:13.000Z (3 months ago)
• Last Synced: 2024-12-14T20:02:31.866Z (9 days ago)
• Topics: allocator, bare-metal-programming, buddy-system, rust
• Language: Rust
• Size: 81.1 KB
• Stars: 94
• Watchers: 7
• Forks: 25
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# buddy_system_allocator

[![Crates.io version][crate-img]][crate]

[![docs.rs][docs-img]][docs]

An (almost) drop-in replacement for [phil-opp/linked-list-allocator](https://github.com/phil-opp/linked-list-allocator). But it uses buddy system instead.

## Usage

To use buddy_system_allocator for global allocator:

```rust

use buddy_system_allocator::LockedHeap;

#[global_allocator]

static HEAP_ALLOCATOR: LockedHeap = LockedHeap::<33>::empty();

```

To init the allocator:

```rust

unsafe {

    HEAP_ALLOCATOR.lock().init(heap_start, heap_size);

    // or

    HEAP_ALLOCATOR.lock().add_to_heap(heap_start, heap_end);

}

```

You can also use `FrameAllocator` and `LockedHeapWithRescue`, see their documentation for usage.

## Features

- **`alloc`** (default): Provide `FrameAllocator` and `LockedFrameAllocator`, which depend on a

  global allocator.

- **`use_spin`** (default): Provide a `LockedHeap` type that implements the [`GlobalAlloc`] trait by

  using a spinlock.

[`GlobalAlloc`]: https://doc.rust-lang.org/nightly/core/alloc/trait.GlobalAlloc.html

## License

Some code comes from phil-opp's linked-list-allocator.

Licensed under MIT License. Thanks phill-opp's linked-list-allocator for inspirations and interface.

[crate-img]: https://img.shields.io/crates/v/buddy_system_allocator.svg

[crate]: https://crates.io/crates/buddy_system_allocator

[docs-img]: https://docs.rs/buddy_system_allocator/badge.svg

[docs]: https://docs.rs/buddy_system_allocator