1 // Copyright 2023 The Pigweed Authors 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not 4 // use this file except in compliance with the License. You may obtain a copy of 5 // the License at 6 // 7 // https://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12 // License for the specific language governing permissions and limitations under 13 // the License. 14 #pragma once 15 16 #include <cstddef> 17 18 #include "pw_allocator/allocator.h" 19 #include "pw_allocator/capability.h" 20 21 namespace pw::allocator { 22 23 /// Memory allocator that uses `malloc` and `free`. 24 /// 25 /// TODO: b/301930507 - `aligned_alloc` is not portable. As a result, this 26 /// allocator has a maximum alignment of `std::align_max_t`. 27 class LibCAllocator final : public Allocator { 28 public: 29 static constexpr Capabilities kCapabilities = 0; 30 31 // TODO(b/326509341): Make the constructor private once downstream consumers 32 // are migrated. 33 friend LibCAllocator& GetLibCAllocator(); LibCAllocator()34 constexpr LibCAllocator() : Allocator(kCapabilities) {} 35 36 private: 37 /// @copydoc Allocator::Allocate 38 void* DoAllocate(Layout layout) override; 39 40 /// @copydoc Allocator::Deallocate 41 void DoDeallocate(void* ptr) override; 42 43 /// @copydoc Allocator::Deallocate DoDeallocate(void * ptr,Layout)44 void DoDeallocate(void* ptr, Layout) override { DoDeallocate(ptr); } 45 46 /// @copydoc Allocator::Reallocate 47 void* DoReallocate(void* ptr, Layout new_layout) override; 48 49 private: 50 static LibCAllocator kSingleton; 51 }; 52 53 /// Returns a reference to the LibCAllocator singleton. 54 LibCAllocator& GetLibCAllocator(); 55 56 } // namespace pw::allocator 57