• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

realm / realm-core / 2362

31 May 2024 02:19PM UTC coverage: 90.83% (-0.01%) from 90.843%
2362

push

Evergreen

web-flow
Output InRealmHistory when compacting (#7753)

This will ensure that the current history version is written, so that
an upgrade will not be required when opening the file.

101698 of 180092 branches covered (56.47%)

33 of 33 new or added lines in 2 files covered. (100.0%)

86 existing lines in 13 files now uncovered.

214721 of 236399 relevant lines covered (90.83%)

5895683.58 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.23
/src/realm/array_string.cpp
1
/*************************************************************************
2
 *
3
 * Copyright 2016 Realm Inc.
4
 *
5
 * Licensed under the Apache License, Version 2.0 (the "License");
6
 * you may not use this file except in compliance with the License.
7
 * You may obtain a copy of the License at
8
 *
9
 * http://www.apache.org/licenses/LICENSE-2.0
10
 *
11
 * Unless required by applicable law or agreed to in writing, software
12
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 * See the License for the specific language governing permissions and
15
 * limitations under the License.
16
 *
17
 **************************************************************************/
18

19
#include <realm/array_string.hpp>
20
#include <realm/spec.hpp>
21
#include <realm/mixed.hpp>
22

23
using namespace realm;
24

25
ArrayString::ArrayString(Allocator& a)
26
    : m_alloc(a)
6,577,827✔
27
{
13,384,737✔
28
    m_arr = new (&m_storage) ArrayStringShort(a, true);
13,384,737✔
29
}
13,384,737✔
30

31
void ArrayString::create()
32
{
261,012✔
33
    static_cast<ArrayStringShort*>(m_arr)->create();
261,012✔
34
}
261,012✔
35

36
void ArrayString::init_from_mem(MemRef mem) noexcept
37
{
11,803,368✔
38
    char* header = mem.get_addr();
11,803,368✔
39

40
    ArrayParent* parent = m_arr->get_parent();
11,803,368✔
41
    size_t ndx_in_parent = m_arr->get_ndx_in_parent();
11,803,368✔
42

43
    bool long_strings = Array::get_hasrefs_from_header(header);
11,803,368✔
44
    if (!long_strings) {
11,803,368✔
45
        // Small strings
46
        bool is_small = Array::get_wtype_from_header(header) == Array::wtype_Multiply;
9,017,271✔
47
        if (is_small) {
9,017,271✔
48
            auto arr = new (&m_storage) ArrayStringShort(m_alloc, m_nullable);
5,321,283✔
49
            arr->init_from_mem(mem);
5,321,283✔
50
            m_type = Type::small_strings;
5,321,283✔
51
        }
5,321,283✔
52
        else {
3,695,988✔
53
            auto arr = new (&m_storage) Array(m_alloc);
3,695,988✔
54
            arr->init_from_mem(mem);
3,695,988✔
55
            m_string_enum_values = std::make_unique<ArrayString>(m_alloc);
3,695,988✔
56
            ArrayParent* p;
3,695,988✔
57
            REALM_ASSERT(m_spec != nullptr);
3,695,988✔
58
            REALM_ASSERT(m_col_ndx != realm::npos);
3,695,988✔
59
            ref_type r = m_spec->get_enumkeys_ref(m_col_ndx, p);
3,695,988✔
60
            m_string_enum_values->init_from_ref(r);
3,695,988✔
61
            m_string_enum_values->set_parent(p, m_col_ndx);
3,695,988✔
62
            m_type = Type::enum_strings;
3,695,988✔
63
        }
3,695,988✔
64
    }
9,017,271✔
65
    else {
2,786,097✔
66
        bool is_big = Array::get_context_flag_from_header(header);
2,786,097✔
67
        if (!is_big) {
2,786,097✔
68
            auto arr = new (&m_storage) ArraySmallBlobs(m_alloc);
706,935✔
69
            arr->init_from_mem(mem);
706,935✔
70
            m_type = Type::medium_strings;
706,935✔
71
        }
706,935✔
72
        else {
2,079,162✔
73
            auto arr = new (&m_storage) ArrayBigBlobs(m_alloc, m_nullable);
2,079,162✔
74
            arr->init_from_mem(mem);
2,079,162✔
75
            m_type = Type::big_strings;
2,079,162✔
76
        }
2,079,162✔
77
    }
2,786,097✔
78
    m_arr->set_parent(parent, ndx_in_parent);
11,803,368✔
79
}
11,803,368✔
80

81
void ArrayString::init_from_parent()
82
{
5,437,095✔
83
    ref_type ref = m_arr->get_ref_from_parent();
5,437,095✔
84
    init_from_ref(ref);
5,437,095✔
85
}
5,437,095✔
86

87
void ArrayString::destroy() noexcept
88
{
1,020✔
89
    if (m_arr->is_attached()) {
1,020✔
90
        Array::destroy_deep(m_arr->get_ref(), m_alloc);
456✔
91
        detach();
456✔
92
    }
456✔
93
}
1,020✔
94

95
void ArrayString::detach() noexcept
96
{
490,710✔
97
    m_arr->detach();
490,710✔
98
    // Make sure the object is in a state like right after construction
99
    // Next call must be to create()
100
    m_arr = new (&m_storage) ArrayStringShort(m_alloc, true);
490,710✔
101
    m_type = Type::small_strings;
490,710✔
102
}
490,710✔
103

104
size_t ArrayString::size() const
105
{
13,727,484✔
106
    switch (m_type) {
13,727,484✔
107
        case Type::small_strings:
4,752,564✔
108
            return static_cast<ArrayStringShort*>(m_arr)->size();
4,752,564✔
109
        case Type::medium_strings:
459,756✔
110
            return static_cast<ArraySmallBlobs*>(m_arr)->size();
459,756✔
111
        case Type::big_strings:
8,520,033✔
112
            return static_cast<ArrayBigBlobs*>(m_arr)->size();
8,520,033✔
113
        case Type::enum_strings:
246✔
114
            return static_cast<Array*>(m_arr)->size();
246✔
115
    }
13,727,484✔
116
    return {};
×
117
}
13,727,484✔
118

119
void ArrayString::add(StringData value)
120
{
136,908✔
121
    switch (upgrade_leaf(value.size())) {
136,908✔
122
        case Type::small_strings:
80,817✔
123
            static_cast<ArrayStringShort*>(m_arr)->add(value);
80,817✔
124
            break;
80,817✔
125
        case Type::medium_strings:
28,197✔
126
            static_cast<ArraySmallBlobs*>(m_arr)->add_string(value);
28,197✔
127
            break;
28,197✔
128
        case Type::big_strings:
27,894✔
129
            static_cast<ArrayBigBlobs*>(m_arr)->add_string(value);
27,894✔
130
            break;
27,894✔
131
        case Type::enum_strings: {
✔
132
            auto a = static_cast<Array*>(m_arr);
×
133
            size_t ndx = a->size();
×
134
            a->add(0);
×
135
            set(ndx, value);
×
136
            break;
×
137
        }
×
138
    }
136,908✔
139
}
136,908✔
140

141
void ArrayString::set(size_t ndx, StringData value)
142
{
3,753,522✔
143
    switch (upgrade_leaf(value.size())) {
3,753,522✔
144
        case Type::small_strings:
494,907✔
145
            static_cast<ArrayStringShort*>(m_arr)->set(ndx, value);
494,907✔
146
            break;
494,907✔
147
        case Type::medium_strings:
249,570✔
148
            static_cast<ArraySmallBlobs*>(m_arr)->set_string(ndx, value);
249,570✔
149
            break;
249,570✔
150
        case Type::big_strings:
384,447✔
151
            static_cast<ArrayBigBlobs*>(m_arr)->set_string(ndx, value);
384,447✔
152
            break;
384,447✔
153
        case Type::enum_strings: {
2,625,573✔
154
            size_t sz = m_string_enum_values->size();
2,625,573✔
155
            size_t res = m_string_enum_values->find_first(value, 0, sz);
2,625,573✔
156
            if (res == realm::not_found) {
2,625,573✔
157
                m_string_enum_values->add(value);
9,783✔
158
                res = sz;
9,783✔
159
            }
9,783✔
160
            static_cast<Array*>(m_arr)->set(ndx, res);
2,625,573✔
161
            break;
2,625,573✔
162
        }
×
163
    }
3,753,522✔
164
}
3,753,522✔
165

166
void ArrayString::insert(size_t ndx, StringData value)
167
{
3,786,222✔
168
    switch (upgrade_leaf(value.size())) {
3,786,222✔
169
        case Type::small_strings:
1,373,760✔
170
            static_cast<ArrayStringShort*>(m_arr)->insert(ndx, value);
1,373,760✔
171
            break;
1,373,760✔
172
        case Type::medium_strings:
294,954✔
173
            static_cast<ArraySmallBlobs*>(m_arr)->insert_string(ndx, value);
294,954✔
174
            break;
294,954✔
175
        case Type::big_strings:
805,551✔
176
            static_cast<ArrayBigBlobs*>(m_arr)->insert_string(ndx, value);
805,551✔
177
            break;
805,551✔
178
        case Type::enum_strings: {
1,312,752✔
179
            static_cast<Array*>(m_arr)->insert(ndx, 0);
1,312,752✔
180
            set(ndx, value);
1,312,752✔
181
        }
1,312,752✔
182
    }
3,786,222✔
183
}
3,786,222✔
184

185
StringData ArrayString::get(size_t ndx) const
186
{
19,244,823✔
187
    switch (m_type) {
19,244,823✔
188
        case Type::small_strings:
9,625,557✔
189
            return static_cast<ArrayStringShort*>(m_arr)->get(ndx);
9,625,557✔
190
        case Type::medium_strings:
957,075✔
191
            return static_cast<ArraySmallBlobs*>(m_arr)->get_string(ndx);
957,075✔
192
        case Type::big_strings:
7,526,268✔
193
            return static_cast<ArrayBigBlobs*>(m_arr)->get_string(ndx);
7,526,268✔
194
        case Type::enum_strings: {
1,137,267✔
195
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
1,137,267✔
196
            return m_string_enum_values->get(index);
1,137,267✔
197
        }
×
198
    }
19,244,823✔
199
    return {};
×
200
}
19,244,823✔
201

202
StringData ArrayString::get_legacy(size_t ndx) const
203
{
×
204
    switch (m_type) {
×
205
        case Type::small_strings:
×
206
            return static_cast<ArrayStringShort*>(m_arr)->get(ndx);
×
207
        case Type::medium_strings:
×
208
            return static_cast<ArraySmallBlobs*>(m_arr)->get_string_legacy(ndx);
×
209
        case Type::big_strings:
×
210
            return static_cast<ArrayBigBlobs*>(m_arr)->get_string(ndx);
×
211
        case Type::enum_strings: {
×
212
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
×
213
            return m_string_enum_values->get(index);
×
214
        }
×
215
    }
×
216
    return {};
×
217
}
×
218

219
Mixed ArrayString::get_any(size_t ndx) const
220
{
132,972✔
221
    return Mixed(get(ndx));
132,972✔
222
}
132,972✔
223

224
bool ArrayString::is_null(size_t ndx) const
225
{
4,056,339✔
226
    switch (m_type) {
4,056,339✔
227
        case Type::small_strings:
769,791✔
228
            return static_cast<ArrayStringShort*>(m_arr)->is_null(ndx);
769,791✔
229
        case Type::medium_strings:
15,624✔
230
            return static_cast<ArraySmallBlobs*>(m_arr)->is_null(ndx);
15,624✔
231
        case Type::big_strings:
3,271,092✔
232
            return static_cast<ArrayBigBlobs*>(m_arr)->is_null(ndx);
3,271,092✔
233
        case Type::enum_strings: {
✔
234
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
×
235
            return m_string_enum_values->is_null(index);
×
236
        }
×
237
    }
4,056,339✔
238
    return {};
×
239
}
4,056,339✔
240

241
void ArrayString::erase(size_t ndx)
242
{
129,018✔
243
    switch (m_type) {
129,018✔
244
        case Type::small_strings:
36,951✔
245
            static_cast<ArrayStringShort*>(m_arr)->erase(ndx);
36,951✔
246
            break;
36,951✔
247
        case Type::medium_strings:
57,642✔
248
            static_cast<ArraySmallBlobs*>(m_arr)->erase(ndx);
57,642✔
249
            break;
57,642✔
250
        case Type::big_strings:
26,001✔
251
            static_cast<ArrayBigBlobs*>(m_arr)->erase(ndx);
26,001✔
252
            break;
26,001✔
253
        case Type::enum_strings:
8,424✔
254
            static_cast<Array*>(m_arr)->erase(ndx);
8,424✔
255
            break;
8,424✔
256
    }
129,018✔
257
}
129,018✔
258

259
void ArrayString::move(ArrayString& dst, size_t ndx)
260
{
66✔
261
    size_t sz = size();
66✔
262
    for (size_t i = ndx; i < sz; i++) {
20,730✔
263
        dst.add(get(i));
20,664✔
264
    }
20,664✔
265

266
    switch (m_type) {
66✔
267
        case Type::small_strings:
✔
268
            static_cast<ArrayStringShort*>(m_arr)->truncate(ndx);
×
269
            break;
×
270
        case Type::medium_strings:
60✔
271
            static_cast<ArraySmallBlobs*>(m_arr)->truncate(ndx);
60✔
272
            break;
60✔
273
        case Type::big_strings:
6✔
274
            static_cast<ArrayBigBlobs*>(m_arr)->truncate(ndx);
6✔
275
            break;
6✔
276
        case Type::enum_strings:
✔
277
            // this operation will never be called for enumerated columns
278
            REALM_UNREACHABLE();
279
            break;
×
280
    }
66✔
281
}
66✔
282

283
void ArrayString::clear()
284
{
354✔
285
    switch (m_type) {
354✔
286
        case Type::small_strings:
300✔
287
            static_cast<ArrayStringShort*>(m_arr)->clear();
300✔
288
            break;
300✔
289
        case Type::medium_strings:
6✔
290
            static_cast<ArraySmallBlobs*>(m_arr)->clear();
6✔
291
            break;
6✔
292
        case Type::big_strings:
48✔
293
            static_cast<ArrayBigBlobs*>(m_arr)->clear();
48✔
294
            break;
48✔
295
        case Type::enum_strings:
✔
296
            static_cast<Array*>(m_arr)->clear();
×
297
            break;
×
298
    }
354✔
299
}
354✔
300

301
size_t ArrayString::find_first(StringData value, size_t begin, size_t end) const noexcept
302
{
4,090,815✔
303
    switch (m_type) {
4,090,815✔
304
        case Type::small_strings:
3,107,406✔
305
            return static_cast<ArrayStringShort*>(m_arr)->find_first(value, begin, end);
3,107,406✔
306
        case Type::medium_strings: {
130,176✔
307
            BinaryData as_binary(value.data(), value.size());
130,176✔
308
            return static_cast<ArraySmallBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
130,176✔
309
            break;
×
310
        }
×
311
        case Type::big_strings: {
256,182✔
312
            BinaryData as_binary(value.data(), value.size());
256,182✔
313
            return static_cast<ArrayBigBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
256,182✔
314
            break;
×
315
        }
×
316
        case Type::enum_strings: {
597,144✔
317
            size_t sz = m_string_enum_values->size();
597,144✔
318
            size_t res = m_string_enum_values->find_first(value, 0, sz);
597,144✔
319
            if (res != realm::not_found) {
597,144✔
320
                return static_cast<Array*>(m_arr)->find_first(res, begin, end);
597,144✔
321
            }
597,144✔
UNCOV
322
            break;
×
323
        }
597,144✔
324
    }
4,090,815✔
325
    return not_found;
×
326
}
4,090,815✔
327

328
namespace {
329

330
template <class T>
331
inline StringData get_string(const T* arr, size_t ndx)
332
{
437,337✔
333
    return arr->get_string(ndx);
437,337✔
334
}
437,337✔
335

336
template <>
337
inline StringData get_string(const ArrayStringShort* arr, size_t ndx)
338
{
94,332✔
339
    return arr->get(ndx);
94,332✔
340
}
94,332✔
341

342
template <class T, class U>
343
size_t lower_bound_string(const T* arr, U value)
344
{
235,554✔
345
    size_t i = 0;
235,554✔
346
    size_t sz = arr->size();
235,554✔
347
    while (0 < sz) {
767,223✔
348
        size_t half = sz / 2;
531,669✔
349
        size_t mid = i + half;
531,669✔
350
        auto probe = get_string(arr, mid);
531,669✔
351
        if (probe < value) {
531,669✔
352
            i = mid + 1;
190,755✔
353
            sz -= half + 1;
190,755✔
354
        }
190,755✔
355
        else {
340,914✔
356
            sz = half;
340,914✔
357
        }
340,914✔
358
    }
531,669✔
359
    return i;
235,554✔
360
}
235,554✔
361
} // namespace
362

363
size_t ArrayString::lower_bound(StringData value)
364
{
235,554✔
365
    switch (m_type) {
235,554✔
366
        case Type::small_strings:
59,076✔
367
            return lower_bound_string(static_cast<ArrayStringShort*>(m_arr), value);
59,076✔
368
        case Type::medium_strings:
68,418✔
369
            return lower_bound_string(static_cast<ArraySmallBlobs*>(m_arr), value);
68,418✔
370
        case Type::big_strings:
108,060✔
371
            return lower_bound_string(static_cast<ArrayBigBlobs*>(m_arr), value);
108,060✔
372
        case Type::enum_strings:
✔
373
            break;
×
374
    }
235,554✔
375
    return realm::npos;
×
376
}
235,554✔
377

378
ArrayString::Type ArrayString::upgrade_leaf(size_t value_size)
379
{
7,674,264✔
380
    if (m_type == Type::big_strings)
7,674,264✔
381
        return Type::big_strings;
1,197,498✔
382

383
    if (m_type == Type::enum_strings)
6,476,766✔
384
        return Type::enum_strings;
3,938,214✔
385

386
    if (m_type == Type::medium_strings) {
2,538,552✔
387
        if (value_size <= medium_string_max_size)
532,923✔
388
            return Type::medium_strings;
532,392✔
389

390
        // Upgrade root leaf from medium to big strings
391
        auto string_medium = static_cast<ArraySmallBlobs*>(m_arr);
531✔
392
        ArrayBigBlobs big_blobs(m_alloc, true);
531✔
393
        big_blobs.create(); // Throws
531✔
394

395
        size_t n = string_medium->size();
531✔
396
        for (size_t i = 0; i < n; i++) {
10,077✔
397
            big_blobs.add_string(string_medium->get_string(i)); // Throws
9,546✔
398
        }
9,546✔
399
        auto parent = string_medium->get_parent();
531✔
400
        auto ndx_in_parent = string_medium->get_ndx_in_parent();
531✔
401
        string_medium->destroy();
531✔
402

403
        auto arr = new (&m_storage) ArrayBigBlobs(m_alloc, true);
531✔
404
        arr->init_from_mem(big_blobs.get_mem());
531✔
405
        arr->set_parent(parent, ndx_in_parent);
531✔
406
        arr->update_parent();
531✔
407

408
        m_type = Type::big_strings;
531✔
409
        return Type::big_strings;
531✔
410
    }
532,923✔
411

412
    // m_type == Type::small
413
    if (value_size <= small_string_max_size)
2,005,629✔
414
        return Type::small_strings;
1,949,040✔
415

416
    if (value_size <= medium_string_max_size) {
56,589✔
417
        // Upgrade root leaf from small to medium strings
418
        auto string_short = static_cast<ArrayStringShort*>(m_arr);
40,329✔
419
        ArraySmallBlobs string_long(m_alloc);
40,329✔
420
        string_long.create(); // Throws
40,329✔
421

422
        size_t n = string_short->size();
40,329✔
423
        for (size_t i = 0; i < n; i++) {
73,665✔
424
            string_long.add_string(string_short->get(i)); // Throws
33,336✔
425
        }
33,336✔
426
        auto parent = string_short->get_parent();
40,329✔
427
        auto ndx_in_parent = string_short->get_ndx_in_parent();
40,329✔
428
        string_short->destroy();
40,329✔
429

430
        auto arr = new (&m_storage) ArraySmallBlobs(m_alloc);
40,329✔
431
        arr->init_from_mem(string_long.get_mem());
40,329✔
432
        arr->set_parent(parent, ndx_in_parent);
40,329✔
433
        arr->update_parent();
40,329✔
434

435
        m_type = Type::medium_strings;
40,329✔
436
    }
40,329✔
437
    else {
16,260✔
438
        // Upgrade root leaf from small to big strings
439
        auto string_short = static_cast<ArrayStringShort*>(m_arr);
16,260✔
440
        ArrayBigBlobs big_blobs(m_alloc, true);
16,260✔
441
        big_blobs.create(); // Throws
16,260✔
442

443
        size_t n = string_short->size();
16,260✔
444
        for (size_t i = 0; i < n; i++) {
36,600✔
445
            big_blobs.add_string(string_short->get(i)); // Throws
20,340✔
446
        }
20,340✔
447
        auto parent = string_short->get_parent();
16,260✔
448
        auto ndx_in_parent = string_short->get_ndx_in_parent();
16,260✔
449
        string_short->destroy();
16,260✔
450

451
        auto arr = new (&m_storage) ArrayBigBlobs(m_alloc, true);
16,260✔
452
        arr->init_from_mem(big_blobs.get_mem());
16,260✔
453
        arr->set_parent(parent, ndx_in_parent);
16,260✔
454
        arr->update_parent();
16,260✔
455

456
        m_type = Type::big_strings;
16,260✔
457
    }
16,260✔
458

459
    return m_type;
56,589✔
460
}
2,005,629✔
461

462
void ArrayString::verify() const
463
{
205,866✔
464
#ifdef REALM_DEBUG
205,866✔
465
    switch (m_type) {
205,866✔
466
        case Type::small_strings:
199,386✔
467
            static_cast<ArrayStringShort*>(m_arr)->verify();
199,386✔
468
            break;
199,386✔
469
        case Type::medium_strings:
972✔
470
            static_cast<ArraySmallBlobs*>(m_arr)->verify();
972✔
471
            break;
972✔
472
        case Type::big_strings:
5,262✔
473
            static_cast<ArrayBigBlobs*>(m_arr)->verify();
5,262✔
474
            break;
5,262✔
475
        case Type::enum_strings:
246✔
476
            static_cast<Array*>(m_arr)->verify();
246✔
477
            break;
246✔
478
    }
205,866✔
479
#endif
205,866✔
480
}
205,866✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc