galloc/lib.rs
1// This file is part of Gear.
2
3// Copyright (C) 2021-2025 Gear Technologies Inc.
4// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
5
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the GNU General Public License as published by
8// the Free Software Foundation, either version 3 of the License, or
9// (at your option) any later version.
10
11// This program is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this program. If not, see <https://www.gnu.org/licenses/>.
18
19//! Gear Allocator.
20//!
21//! Lightweight memory allocator for Gear programs. Based on `dlmalloc` optimized fork.
22
23#![no_std]
24#![warn(missing_docs)]
25#![doc(html_logo_url = "https://gear-tech.io/logo.png")]
26#![doc(html_favicon_url = "https://gear-tech.io/favicon.ico")]
27#![cfg_attr(docsrs, feature(doc_cfg))]
28
29/// Global allocator instance.
30// until https://github.com/alexcrichton/dlmalloc-rs/pull/26 is merged
31#[cfg(not(windows))]
32#[global_allocator]
33pub static ALLOC: dlmalloc::GlobalDlmalloc = dlmalloc::GlobalDlmalloc;
34
35/// Prelude imports.
36pub mod prelude;