aboutsummaryrefslogtreecommitdiffstats
path: root/include/jau/counting_allocator.hpp
blob: 169cce66ea1bf3624b1dc11b86a883fea566a10f (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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/*
 * Author: Sven Gothel <sgothel@jausoft.com>
 * Copyright (c) 2020 Gothel Software e.K.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef COUNTING_ALLOCATOR_HPP
#define COUNTING_ALLOCATOR_HPP

#include <cinttypes>
#include <memory>

#include <jau/basic_types.hpp>
// #include <jau/ordered_atomic.hpp>

namespace jau {

/**
 * Performance counter std::allocator specialization.
 * <p>
 * This class shall be compliant with <i>C++ named requirements for Allocator</i>.
 * </p>
 * <p>
 * Not overriding deprecated (C++17) and removed (C++20)
 * methods: address(), max_size(), construct() and destroy().
 * </p>
 */
template <class T>
struct counting_allocator : public std::allocator<T>
{
  public:
    template <class U> struct rebind {typedef counting_allocator<U> other;};

    // typedefs' for C++ named requirements: Allocator
    typedef T  value_type;

    // std::size_t id;
    bool old_stats;
    std::size_t memory_usage;
    std::size_t alloc_count;
    std::size_t dealloc_count;
    ssize_t alloc_balance;

  private:
    // inline static relaxed_atomic_size_t next_id = 1;

    /**
     * vector<value_type>::get_allocator() returns a copy of the allocator instance,
     * where we desire to access the copied statistics.
     * <p>
     * However, vector<value_type>(const vector<value_type>&) also copies the allocator instance,
     * but here the copied statistics shall be flushed since the elements are
     * copied into the new vector<value_type> instance using the new allocator.<br>
     * Without flushing the stats, we would see a size + size allocator stats,
     * the former size from the copied allocator and the latter from the
     * copied elements into the new vector<value_type> instance.
     * </p>
     */
    constexpr void flush_stats() noexcept {
        if( old_stats ) {
            old_stats = false;
            memory_usage = 0;
            alloc_count = 0;
            dealloc_count = 0;
            alloc_balance = 0;
        }
    }

  public:
    std::string toString(const nsize_t mem_width=0, const nsize_t count_width=0) {
        return "CAlloc["/*+std::to_string(id)+", "*/+to_decstring(memory_usage, ',', mem_width)+" bytes, alloc[balance "+
                to_decstring(alloc_balance, ',', count_width)+" = "+
                to_decstring(alloc_count, ',', count_width)+" - "+to_decstring(dealloc_count, ',', count_width)+"]]";
    }

    counting_allocator() noexcept
    : std::allocator<value_type>(),
      // id(next_id++),
      old_stats(false),
      memory_usage(0), alloc_count(0), dealloc_count(0), alloc_balance(0)
      { } // C++11

#if __cplusplus > 201703L
    constexpr counting_allocator(const counting_allocator& other) noexcept
    : std::allocator<value_type>(other),
      // id(next_id++),
      old_stats(true),
      memory_usage(other.memory_usage),
      alloc_count(other.alloc_count), dealloc_count(other.dealloc_count),
      alloc_balance(other.alloc_balance)
      {} // C++20
#else
    counting_allocator(const counting_allocator& other) noexcept
    : std::allocator<value_type>(other),
      // id(next_id++),
      old_stats(true),
      memory_usage(other.memory_usage),
      alloc_count(other.alloc_count), dealloc_count(other.dealloc_count),
      alloc_balance(other.alloc_balance)
      { }
#endif

#if __cplusplus > 201703L
    template <typename U>
    constexpr counting_allocator(const counting_allocator<U>& other) noexcept
    : std::allocator<value_type>(other),
      // id(next_id++),
      old_stats(true),
      memory_usage(other.memory_usage),
      alloc_count(other.alloc_count), dealloc_count(other.dealloc_count),
      alloc_balance(other.alloc_balance)
      {} // C++20
#else
    template <typename U>
    counting_allocator(const counting_allocator<U>& other) noexcept
    : std::allocator<value_type>(other),
      // id(next_id++),
      old_stats(true),
      memory_usage(other.memory_usage),
      alloc_count(other.alloc_count), dealloc_count(other.dealloc_count),
      alloc_balance(other.alloc_balance)
      { }
#endif

#if __cplusplus > 201703L
    constexpr ~counting_allocator() {} // C++20
#else
    ~counting_allocator() = default;
#endif

#if __cplusplus <= 201703L
    value_type* allocate(std::size_t n, const void * hint) { // C++17 deprecated; C++20 removed
        flush_stats();
        memory_usage += n * sizeof(value_type);
        alloc_count++;
        alloc_balance++;
        return std::allocator<value_type>::allocate(n, hint);
    }
#endif

#if __cplusplus > 201703L
    [[nodiscard]] constexpr value_type* allocate(std::size_t n) { // C++20
        flush_stats();
        memory_usage += n * sizeof(value_type);
        alloc_count++;
        alloc_balance++;
        return std::allocator<value_type>::allocate(n);
    }
#else
    value_type* allocate(std::size_t n) { // C++17
        flush_stats();
        memory_usage += n * sizeof(value_type);
        alloc_count++;
        alloc_balance++;
        return std::allocator<value_type>::allocate(n);
    }
#endif

#if __cplusplus > 201703L
    constexpr void deallocate(value_type* p, std::size_t n ) {
        flush_stats();
        memory_usage -= n * sizeof(value_type);
        dealloc_count++;
        alloc_balance--;
        std::allocator<value_type>::deallocate(p, n);
    }
#else
    void deallocate(value_type* p, std::size_t n ) {
        flush_stats();
        memory_usage -= n * sizeof(value_type);
        dealloc_count++;
        alloc_balance--;
        std::allocator<value_type>::deallocate(p, n);
    }
#endif
};

#if __cplusplus > 201703L
template <class T1, class T2>
    constexpr bool operator==(const counting_allocator<T1>& lhs, const counting_allocator<T2>& rhs) noexcept {
#if 0
        if( &lhs == &rhs ) {
            return true;
        }
        return lhs.memory_usage == rhs.memory_usage;
#else
        (void)lhs;
        (void)rhs;
        return true;
#endif
    }
#else
    template <class T1, class T2>
    bool operator==(const counting_allocator<T1>& lhs, const counting_allocator<T2>& rhs) noexcept {
#if 0
        if( &lhs == &rhs ) {
            return true;
        }
        return lhs.memory_usage == rhs.memory_usage;
#else
        (void)lhs;
        (void)rhs;
        return true;
#endif
    }
    template <class T1, class T2>
    bool operator!=(const counting_allocator<T1>& lhs, const counting_allocator<T2>& rhs) noexcept {
        return !(lhs==rhs);
    }
#endif

} /* namespace jau */

#endif // COUNTING_ALLOCATOR_HPP