xref: /aosp_15_r20/external/pigweed/pw_allocator/public/pw_allocator/bucket_block_allocator.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 <cstddef>
17 #include <cstdint>
18 
19 #include "pw_allocator/bucket_allocator.h"
20 #include "pw_allocator/config.h"
21 
22 namespace pw::allocator {
23 
24 /// Legacy alias for `BucketAllocator`.
25 ///
26 /// Consumers should migrate away from using this type and use `BucketAllocator`
27 /// instead.
28 ///
29 /// The first template parameter was formerly an `OffsetType` that was passed to
30 /// the `BlockAllocator`. Since the free blocks' usable space is interpreted as
31 /// intrusive items, they must have a pointer-compatible alignment. As a result,
32 /// the first template parameter is ignored.
33 template <typename OffsetType = uintptr_t,
34           size_t kMinBucketChunkSize = 32,
35           size_t kNumBuckets = 5>
36 using BucketBlockAllocator PW_ALLOCATOR_DEPRECATED =
37     BucketAllocator<BucketBlock<OffsetType>, kMinBucketChunkSize, kNumBuckets>;
38 
39 }  // namespace pw::allocator
40