xref: /aosp_15_r20/external/pigweed/pw_allocator/public/pw_allocator/allocator_as_pool.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2024 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 "pw_allocator/allocator.h"
17 #include "pw_allocator/layout.h"
18 #include "pw_allocator/pool.h"
19 #include "pw_status/status.h"
20 
21 namespace pw::allocator {
22 
23 /// Implementation of ``Pool`` that satisfies requests using an ``Allocator``.
24 class AllocatorAsPool : public Pool {
25  public:
26   /// Construct a ``Pool`` from an ``Allocator``.
27   ///
28   /// @param  allocator   The allocator used to create fixed-size allocations.
29   /// @param  layout      The size and alignment of the memory to be returned
30   ///                     from this pool.
31   AllocatorAsPool(Allocator& allocator, const Layout& layout);
32 
33  private:
34   /// @copydoc Pool::Allocate
35   void* DoAllocate() override;
36 
37   /// @copydoc Deallocator::Deallocate
38   void DoDeallocate(void* ptr) override;
39 
40   /// @copydoc Deallocator::GetInfo
41   Result<Layout> DoGetInfo(InfoType info_type, const void* ptr) const override;
42 
43   Allocator& allocator_;
44 };
45 
46 }  // namespace pw::allocator
47