malloc.h

// Copyright 2024 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 <cstdint>
 
#include "pw_allocator/allocator.h"
#include "pw_bytes/span.h"
#include "pw_malloc/config.h"
#include "pw_preprocessor/util.h"
 
namespace pw::malloc {
 
void InitSystemAllocator(ByteSpan heap);
 
void InitSystemAllocator(void* heap_low_addr, void* heap_high_addr);
 
template <typename AllocatorType>
void InitSystemAllocator(ByteSpan heap);
 
}  // namespace pw::malloc
 
#if __cplusplus
PW_EXTERN_C_START
#endif
 
void pw_MallocInit(uint8_t* heap_low_addr, uint8_t* heap_high_addr);
 
#if __cplusplus
PW_EXTERN_C_END
#endif
 
namespace pw::malloc {
 
Allocator* GetSystemAllocator();
 
const PW_MALLOC_METRICS_TYPE& GetSystemMetrics();
 
// Tmplate method implementations.
 
template <typename AllocatorType>
void InitSystemAllocator(ByteSpan heap) {
  static bool initialized = false;
  PW_ASSERT(!initialized);
  auto* allocator = static_cast<AllocatorType*>(GetSystemAllocator());
  allocator->Init(heap);
  initialized = true;
}
 
}  // namespace pw::malloc