multiboot2

Crates.iomultiboot2
lib.rsmultiboot2
version0.23.1
sourcesrc
created_at2016-09-14 13:19:55.191038
updated_at2024-10-22 06:04:49.489255
descriptionConvenient and safe parsing of Multiboot2 Boot Information (MBI) structures and the contained information tags. Usable in `no_std` environments, such as a kernel. An optional builder feature also allows the construction of the corresponding structures.
homepagehttps://github.com/rust-osdev/multiboot2/tree/main/multiboot2
repositoryhttps://github.com/rust-osdev/multiboot2
max_upload_size
id6489
size234,590
multiboot2 (github:rust-osdev:multiboot2)

documentation

https://docs.rs/multiboot2

README

multiboot2

crates.io docs

Convenient and safe parsing of Multiboot2 Boot Information (MBI) structures and the contained information tags. Usable in no_std environments, such as a kernel. An optional builder feature also allows the construction of the corresponding structures.

It follows the Multiboot 2.0 specification at https://www.gnu.org/software/grub/manual/multiboot2/multiboot.html and the ELF 64 specification at http://www.uclibc.org/docs/elf-64-gen.pdf.

Design

For every Multiboot2 structure, there is an ABI-compatible rusty type. This enables a zero-copying parsing design while also enabling the creation of these structures via convenient constructors on the corresponding types.

Features and no_std Compatibility

This library is always no_std without alloc. However, the default builder- feature requires the alloc-crate and an #[global_allocator] to be available. You need the builder only if you want to construct new boot information structures at runtime. For parsing, this is not relevant, and you can deactivate the default features.

Background: The Multiboot 2 Information Structure

The Multiboot information structure looks like this:

Field Type
total size u32
reserved u32
tags variable
end tag = (0, 8) (u32, u32)

There are many different types of tags, but they all have the same beginning:

Field Type
type u32
size u32
other fields variable

MSRV

The MSRV is 1.75.0 stable.

License & Contribution

See main README file.

Commit count: 678

cargo fmt