pw_allocator/public/pw_allocator/libc_allocator.h

// Copyright 2023 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once

#include <cstddef>

#include "pw_allocator/allocator.h"
#include "pw_allocator/capability.h"

namespace pw::allocator {

/// Memory allocator that uses `malloc` and `free`.
///
/// TODO: b/301930507 - `aligned_alloc` is not portable. As a result, this
/// allocator has a maximum alignment of `std::align_max_t`.
class LibCAllocator final : public Allocator {
 public:
  static constexpr Capabilities kCapabilities = 0;

  // TODO(b/326509341): Make the constructor private once downstream consumers
  // are migrated.
  friend LibCAllocator& GetLibCAllocator();
  constexpr LibCAllocator() : Allocator(kCapabilities) {}

 private:
  /// @copydoc Allocator::Allocate
  void* DoAllocate(Layout layout) override;

  /// @copydoc Allocator::Deallocate
  void DoDeallocate(void* ptr) override;

  /// @copydoc Allocator::Deallocate
  void DoDeallocate(void* ptr, Layout) override { DoDeallocate(ptr); }

  /// @copydoc Allocator::Reallocate
  void* DoReallocate(void* ptr, Layout new_layout) override;

 private:
  static LibCAllocator kSingleton;
};

/// Returns a reference to the LibCAllocator singleton.
LibCAllocator& GetLibCAllocator();

}  // namespace pw::allocator