summaryrefslogtreecommitdiff
path: root/include/fud_allocator.hpp
blob: a9fbd6769ea53e6c27ef7df68100480dbe4045d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
 * libfud
 * Copyright 2024 Dominick Allen
 *
 * 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
 *
 *     http://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.
 */

#ifndef FUD_ALLOCATOR_HPP
#define FUD_ALLOCATOR_HPP

#include "fud_result.hpp"
#include "fud_status.hpp"

#include <cstddef>
#include <limits>

namespace fud {

class Allocator {
  public:
    virtual ~Allocator() = default;

    virtual Result<void*, FudStatus> allocate(size_t bytes, size_t alignment = alignof(std::max_align_t)) = 0;

    virtual FudStatus deallocate(void* pointer, size_t bytes) = 0;

    virtual bool isEqual(const Allocator& rhs) const = 0;
};

constexpr bool operator==(const Allocator& lhs, const Allocator& rhs) {
    return &lhs == &rhs;
}

class FudAllocator : public Allocator {
  public:
    virtual ~FudAllocator() override = default;

    virtual Result<void*, FudStatus> allocate(size_t bytes, size_t alignment = alignof(std::max_align_t)) override;

    virtual FudStatus deallocate(void* pointer, size_t bytes) override;

    virtual bool isEqual(const Allocator& rhs) const override;
};

extern FudAllocator globalFudAllocator;

/** \brief The default allocation function for globalFudAllocator. */
extern void* fudAlloc(size_t size);

/** \brief The default deallocation function for globalFudAllocator. */
extern void fudFree(void* ptr);

} // namespace fud

#endif