aboutsummaryrefslogtreecommitdiffstats
path: root/vespalib/src/vespa/vespalib/util/small_vector.h
blob: 33faf80d88577d00722dcc1e5362b74ad0b38035 (plain) (blame)
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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include "alloc.h"
#include "traits.h"
#include "arrayref.h"
#include <cstring>
#include <cassert>
#include <iterator>

namespace vespalib {

namespace small_vector {

template <typename T>
constexpr size_t select_N() {
    if constexpr (sizeof(T) <= 16) {
        return (48 / sizeof(T));
    } else {
        static_assert(sizeof(T) <= 16,
                      "auto-selecting N is only supported for small objects (16 bytes or less)");
        return 1;
    }
}

template <typename T, typename... Args>
void create_at(T *ptr, Args &&...args) {
    // https://en.cppreference.com/w/cpp/memory/construct_at
    ::new (const_cast<void*>(static_cast<const volatile void*>(ptr))) T(std::forward<Args>(args)...);
}

template <typename T>
void move_objects(T *dst, T *src, uint32_t n) {
    if constexpr (std::is_trivially_copyable_v<T>) {
        // need to cast dst to void to avoid compiler warning caused by some trivially copyable objects not being copy assignable.
        memcpy(static_cast<void *>(dst), src, n * sizeof(T));
    } else {
        for (size_t i = 0; i < n; ++i) {
            create_at(dst + i, std::move(src[i]));
        }
    }
}

template <typename T>
void copy_objects(T *dst, const T *src, uint32_t n) {
    if constexpr (std::is_trivially_copyable_v<T>) {
        memcpy(dst, src, n * sizeof(T));
    } else {
        for (size_t i = 0; i < n; ++i) {
            create_at(dst + i, src[i]);
        }
    }
}

template <typename T, typename... Args>
void create_objects(T *dst, uint32_t n, Args &&...args) {
    for (size_t i = 0; i < n; ++i) {
        create_at(dst + i, std::forward<Args>(args)...);
    }
}

template <typename T>
void destroy_objects(T *src, uint32_t n) {
    if (!can_skip_destruction<T>) {
        std::destroy_n(src, n);
    }
}

template <typename T>
std::pair<T*,size_t> alloc_objects(size_t wanted) {
    size_t mem = roundUp2inN(wanted * sizeof(T));
    size_t entries = (mem / sizeof(T));
    mem = (entries * sizeof(T));
    T *ptr = static_cast<T*>(malloc(mem));
    assert(ptr != nullptr);
    return {ptr, entries};
}

} // namespace small_vector

/**
 * Simplified vector-like container that has space for some elements
 * inside the object itself. Intended use is to contain lists of
 * simple objects/values that are small in both size and number.
 **/
template <typename T, size_t N = small_vector::select_N<T>()>
class SmallVector
{
private:
    T *_data;
    uint32_t _size;
    uint32_t _capacity;
    alignas(T) char _space[sizeof(T) * N];
    constexpr T *local() noexcept { return reinterpret_cast<T*>(_space); }
    constexpr const T *local() const noexcept { return reinterpret_cast<const T*>(_space); }
    void expand(size_t wanted) {
        auto [new_data, new_capacity] = small_vector::alloc_objects<T>(wanted);
        small_vector::move_objects(new_data, _data, _size);
        small_vector::destroy_objects(_data, _size);
        auto old_data = _data;
        _data = new_data;
        _capacity = new_capacity;
        if (old_data != local()) {
            free(old_data);
        }
    }
    template <std::random_access_iterator InputIt>
    void init(InputIt first, InputIt last) {
        reserve(last - first);
        while (first != last) {
            small_vector::create_at((_data + _size++), *first++);
        }
    }
    template <std::input_iterator InputIt>
    void init(InputIt first, InputIt last) {
        while (first != last) {
            emplace_back(*first++);
        }
    }
public:
    constexpr SmallVector() noexcept : _data(local()), _size(0), _capacity(N) {
        static_assert(N > 0);
    }
    SmallVector(size_t n) : SmallVector() {
        reserve(n);
        small_vector::create_objects(_data, n);
        _size = n;
    }
    SmallVector(size_t n, const T &obj) : SmallVector() {
        reserve(n);
        small_vector::create_objects(_data, n, obj);
        _size = n;
    }
    SmallVector(std::initializer_list<T> list) : SmallVector() {
        reserve(list.size());
        for (const T &value: list) {
            small_vector::create_at((_data + _size++), value);
        }
    }
    template <std::input_iterator InputIt>
    SmallVector(InputIt first, InputIt last) : SmallVector()
    {
        init(first, last);
    }
    SmallVector(SmallVector &&rhs) : SmallVector() {
        reserve(rhs._size);
        small_vector::move_objects(_data, rhs._data, rhs._size);
        _size = rhs._size;
    }
    SmallVector(const SmallVector &rhs) : SmallVector() {
        reserve(rhs._size);
        small_vector::copy_objects(_data, rhs._data, rhs._size);
        _size = rhs._size;
    }
    SmallVector &operator=(SmallVector &&rhs) {
        assert(std::addressof(rhs) != this);
        clear();
        reserve(rhs._size);
        small_vector::move_objects(_data, rhs._data, rhs._size);
        _size = rhs._size;
        return *this;
    }
    SmallVector &operator=(const SmallVector &rhs) {
        assert(std::addressof(rhs) != this);
        clear();
        reserve(rhs._size);
        small_vector::copy_objects(_data, rhs._data, rhs._size);
        _size = rhs._size;
        return *this;
    }
    ~SmallVector() {
        small_vector::destroy_objects(_data, _size);
        if (_data != local()) {
            free(_data);
        }
    }
    operator ConstArrayRef<T> () const { return ConstArrayRef<T>(data(), size()); }
    bool empty() const noexcept { return (_size == 0); }
    uint32_t size() const noexcept { return _size; }
    uint32_t capacity() const noexcept { return _capacity; }
    bool is_local() const noexcept { return (_data == local()); }
    T *begin() noexcept { return _data; }
    T *end() noexcept { return (_data + _size); }
    const T *begin() const noexcept { return _data; }
    const T *end() const noexcept { return (_data + _size); }
    T &operator[](size_t idx) noexcept { return _data[idx]; }
    const T &operator[](size_t idx) const noexcept { return _data[idx]; }
    T *data() noexcept { return _data; }
    const T *data() const noexcept { return _data; }
    T &back() noexcept { return _data[_size - 1]; }
    const T &back() const noexcept { return _data[_size - 1]; }
    void clear() noexcept {
        small_vector::destroy_objects(_data, _size);
        _size = 0;
    }
    void reserve(size_t wanted) {
        if (__builtin_expect(wanted > _capacity, false)) {
            expand(wanted);
        }
    }
    template <typename... Args>
    void emplace_back(Args &&...args) {
        reserve(_size + 1);
        small_vector::create_at((_data + _size), std::forward<Args>(args)...);
        ++_size;
    }
    template <typename... Args>
    SmallVector &add(Args &&...args) {
        emplace_back(std::forward<Args>(args)...);
        return *this;
    }
    void push_back(const T &obj) { emplace_back(obj); }
    void push_back(T &&obj) { emplace_back(std::move(obj)); }
    void pop_back() { small_vector::destroy_objects(_data + --_size, 1); }
};

template <typename T, size_t N, size_t M>
bool operator==(const SmallVector<T,N> &a,
                const SmallVector<T,M> &b) noexcept
{
    if (a.size() != b.size()) {
        return false;
    }
    for (size_t i = 0; i < a.size(); ++i) {
        if (!(a[i] == b[i])) {
            return false;
        }
    }
    return true;
}

} // namespace