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

realm / realm-core / 2131

13 Mar 2024 04:51AM UTC coverage: 91.785% (-0.05%) from 91.833%
2131

push

Evergreen

web-flow
Merge pull request #7402 from realm/tg/obj-perf

Make Obj trivial and add a separate ObjCollectionParent type

94394 of 174600 branches covered (54.06%)

496 of 559 new or added lines in 21 files covered. (88.73%)

224 existing lines in 28 files now uncovered.

242743 of 264469 relevant lines covered (91.79%)

5639637.18 hits per line

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

85.25
/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)
27
{
12,689,442✔
28
    m_arr = new (&m_storage) ArrayStringShort(a, true);
12,689,442✔
29
}
12,689,442✔
30

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

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

5,591,517✔
40
    ArrayParent* parent = m_arr->get_parent();
11,179,560✔
41
    size_t ndx_in_parent = m_arr->get_ndx_in_parent();
11,179,560✔
42

5,591,517✔
43
    bool long_strings = Array::get_hasrefs_from_header(header);
11,179,560✔
44
    if (!long_strings) {
11,179,560✔
45
        // Small strings
4,220,373✔
46
        bool is_small = Array::get_wtype_from_header(header) == Array::wtype_Multiply;
8,436,642✔
47
        if (is_small) {
8,436,642✔
48
            auto arr = new (&m_storage) ArrayStringShort(m_alloc, m_nullable);
4,730,925✔
49
            arr->init_from_mem(mem);
4,730,925✔
50
            m_type = Type::small_strings;
4,730,925✔
51
        }
4,730,925✔
52
        else {
3,705,717✔
53
            auto arr = new (&m_storage) Array(m_alloc);
3,705,717✔
54
            arr->init_from_mem(mem);
3,705,717✔
55
            m_string_enum_values = std::make_unique<ArrayString>(m_alloc);
3,705,717✔
56
            ArrayParent* p;
3,705,717✔
57
            REALM_ASSERT(m_spec != nullptr);
3,705,717✔
58
            REALM_ASSERT(m_col_ndx != realm::npos);
3,705,717✔
59
            ref_type r = m_spec->get_enumkeys_ref(m_col_ndx, p);
3,705,717✔
60
            m_string_enum_values->init_from_ref(r);
3,705,717✔
61
            m_string_enum_values->set_parent(p, m_col_ndx);
3,705,717✔
62
            m_type = Type::enum_strings;
3,705,717✔
63
        }
3,705,717✔
64
    }
8,436,642✔
65
    else {
2,742,918✔
66
        bool is_big = Array::get_context_flag_from_header(header);
2,742,918✔
67
        if (!is_big) {
2,742,918✔
68
            auto arr = new (&m_storage) ArraySmallBlobs(m_alloc);
673,344✔
69
            arr->init_from_mem(mem);
673,344✔
70
            m_type = Type::medium_strings;
673,344✔
71
        }
673,344✔
72
        else {
2,069,574✔
73
            auto arr = new (&m_storage) ArrayBigBlobs(m_alloc, m_nullable);
2,069,574✔
74
            arr->init_from_mem(mem);
2,069,574✔
75
            m_type = Type::big_strings;
2,069,574✔
76
        }
2,069,574✔
77
    }
2,742,918✔
78
    m_arr->set_parent(parent, ndx_in_parent);
11,179,560✔
79
}
11,179,560✔
80

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

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

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

104
size_t ArrayString::size() const
105
{
13,523,262✔
106
    switch (m_type) {
13,523,262✔
107
        case Type::small_strings:
4,722,645✔
108
            return static_cast<ArrayStringShort*>(m_arr)->size();
4,722,645✔
109
        case Type::medium_strings:
436,806✔
110
            return static_cast<ArraySmallBlobs*>(m_arr)->size();
436,806✔
111
        case Type::big_strings:
8,366,331✔
112
            return static_cast<ArrayBigBlobs*>(m_arr)->size();
8,366,331✔
113
        case Type::enum_strings:
252✔
114
            return static_cast<Array*>(m_arr)->size();
252✔
115
    }
×
116
    return {};
×
117
}
×
118

119
void ArrayString::add(StringData value)
120
{
136,314✔
121
    switch (upgrade_leaf(value.size())) {
136,314✔
122
        case Type::small_strings:
80,502✔
123
            static_cast<ArrayStringShort*>(m_arr)->add(value);
80,502✔
124
            break;
80,502✔
125
        case Type::medium_strings:
27,969✔
126
            static_cast<ArraySmallBlobs*>(m_arr)->add_string(value);
27,969✔
127
            break;
27,969✔
128
        case Type::big_strings:
27,843✔
129
            static_cast<ArrayBigBlobs*>(m_arr)->add_string(value);
27,843✔
130
            break;
27,843✔
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,314✔
139
}
136,314✔
140

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

166
void ArrayString::insert(size_t ndx, StringData value)
167
{
3,435,066✔
168
    switch (upgrade_leaf(value.size())) {
3,435,066✔
169
        case Type::small_strings:
1,035,432✔
170
            static_cast<ArrayStringShort*>(m_arr)->insert(ndx, value);
1,035,432✔
171
            break;
1,035,432✔
172
        case Type::medium_strings:
282,510✔
173
            static_cast<ArraySmallBlobs*>(m_arr)->insert_string(ndx, value);
282,510✔
174
            break;
282,510✔
175
        case Type::big_strings:
805,728✔
176
            static_cast<ArrayBigBlobs*>(m_arr)->insert_string(ndx, value);
805,728✔
177
            break;
805,728✔
178
        case Type::enum_strings: {
1,312,890✔
179
            static_cast<Array*>(m_arr)->insert(ndx, 0);
1,312,890✔
180
            set(ndx, value);
1,312,890✔
181
        }
1,312,890✔
182
    }
3,435,066✔
183
}
3,435,066✔
184

185
StringData ArrayString::get(size_t ndx) const
186
{
18,943,488✔
187
    switch (m_type) {
18,943,488✔
188
        case Type::small_strings:
9,585,315✔
189
            return static_cast<ArrayStringShort*>(m_arr)->get(ndx);
9,585,315✔
190
        case Type::medium_strings:
834,171✔
191
            return static_cast<ArraySmallBlobs*>(m_arr)->get_string(ndx);
834,171✔
192
        case Type::big_strings:
7,382,274✔
193
            return static_cast<ArrayBigBlobs*>(m_arr)->get_string(ndx);
7,382,274✔
194
        case Type::enum_strings: {
1,148,118✔
195
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
1,148,118✔
196
            return m_string_enum_values->get(index);
1,148,118✔
197
        }
×
198
    }
×
199
    return {};
×
200
}
×
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
{
133,008✔
221
    return Mixed(get(ndx));
133,008✔
222
}
133,008✔
223

224
bool ArrayString::is_null(size_t ndx) const
225
{
3,645,483✔
226
    switch (m_type) {
3,645,483✔
227
        case Type::small_strings:
571,821✔
228
            return static_cast<ArrayStringShort*>(m_arr)->is_null(ndx);
571,821✔
229
        case Type::medium_strings:
17,718✔
230
            return static_cast<ArraySmallBlobs*>(m_arr)->is_null(ndx);
17,718✔
231
        case Type::big_strings:
3,055,950✔
232
            return static_cast<ArrayBigBlobs*>(m_arr)->is_null(ndx);
3,055,950✔
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
    }
×
238
    return {};
×
239
}
×
240

241
void ArrayString::erase(size_t ndx)
242
{
129,822✔
243
    switch (m_type) {
129,822✔
244
        case Type::small_strings:
37,176✔
245
            static_cast<ArrayStringShort*>(m_arr)->erase(ndx);
37,176✔
246
            break;
37,176✔
247
        case Type::medium_strings:
57,858✔
248
            static_cast<ArraySmallBlobs*>(m_arr)->erase(ndx);
57,858✔
249
            break;
57,858✔
250
        case Type::big_strings:
26,427✔
251
            static_cast<ArrayBigBlobs*>(m_arr)->erase(ndx);
26,427✔
252
            break;
26,427✔
253
        case Type::enum_strings:
8,364✔
254
            static_cast<Array*>(m_arr)->erase(ndx);
8,364✔
255
            break;
8,364✔
256
    }
129,822✔
257
}
129,822✔
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

33✔
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,070,766✔
303
    switch (m_type) {
4,070,766✔
304
        case Type::small_strings:
3,115,197✔
305
            return static_cast<ArrayStringShort*>(m_arr)->find_first(value, begin, end);
3,115,197✔
306
        case Type::medium_strings: {
104,964✔
307
            BinaryData as_binary(value.data(), value.size());
104,964✔
308
            return static_cast<ArraySmallBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
104,964✔
309
            break;
×
310
        }
×
311
        case Type::big_strings: {
255,597✔
312
            BinaryData as_binary(value.data(), value.size());
255,597✔
313
            return static_cast<ArrayBigBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
255,597✔
314
            break;
×
315
        }
×
316
        case Type::enum_strings: {
595,950✔
317
            size_t sz = m_string_enum_values->size();
595,950✔
318
            size_t res = m_string_enum_values->find_first(value, 0, sz);
595,950✔
319
            if (res != realm::not_found) {
595,950✔
320
                return static_cast<Array*>(m_arr)->find_first(res, begin, end);
595,950✔
321
            }
595,950✔
UNCOV
322
            break;
×
UNCOV
323
        }
×
324
    }
×
325
    return not_found;
×
326
}
×
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
{
93,696✔
339
    return arr->get(ndx);
93,696✔
340
}
93,696✔
341

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

363
size_t ArrayString::lower_bound(StringData value)
364
{
234,690✔
365
    switch (m_type) {
234,690✔
366
        case Type::small_strings:
58,434✔
367
            return lower_bound_string(static_cast<ArrayStringShort*>(m_arr), value);
58,434✔
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
    }
×
375
    return realm::npos;
×
376
}
×
377

378
ArrayString::Type ArrayString::upgrade_leaf(size_t value_size)
379
{
7,301,172✔
380
    if (m_type == Type::big_strings)
7,301,172✔
381
        return Type::big_strings;
1,191,018✔
382

2,996,310✔
383
    if (m_type == Type::enum_strings)
6,110,154✔
384
        return Type::enum_strings;
3,938,349✔
385

1,027,350✔
386
    if (m_type == Type::medium_strings) {
2,171,805✔
387
        if (value_size <= medium_string_max_size)
527,733✔
388
            return Type::medium_strings;
527,208✔
389

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

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

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

273✔
408
        m_type = Type::big_strings;
525✔
409
        return Type::big_strings;
525✔
410
    }
525✔
411

763,284✔
412
    // m_type == Type::small
763,284✔
413
    if (value_size <= small_string_max_size)
1,644,072✔
414
        return Type::small_strings;
1,616,274✔
415

14,742✔
416
    if (value_size <= medium_string_max_size) {
27,798✔
417
        // Upgrade root leaf from small to medium strings
8,394✔
418
        auto string_short = static_cast<ArrayStringShort*>(m_arr);
17,064✔
419
        ArraySmallBlobs string_long(m_alloc);
17,064✔
420
        string_long.create(); // Throws
17,064✔
421

8,394✔
422
        size_t n = string_short->size();
17,064✔
423
        for (size_t i = 0; i < n; i++) {
38,451✔
424
            string_long.add_string(string_short->get(i)); // Throws
21,387✔
425
        }
21,387✔
426
        auto parent = string_short->get_parent();
17,064✔
427
        auto ndx_in_parent = string_short->get_ndx_in_parent();
17,064✔
428
        string_short->destroy();
17,064✔
429

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

8,394✔
435
        m_type = Type::medium_strings;
17,064✔
436
    }
17,064✔
437
    else {
10,734✔
438
        // Upgrade root leaf from small to big strings
6,348✔
439
        auto string_short = static_cast<ArrayStringShort*>(m_arr);
10,734✔
440
        ArrayBigBlobs big_blobs(m_alloc, true);
10,734✔
441
        big_blobs.create(); // Throws
10,734✔
442

6,348✔
443
        size_t n = string_short->size();
10,734✔
444
        for (size_t i = 0; i < n; i++) {
30,723✔
445
            big_blobs.add_string(string_short->get(i)); // Throws
19,989✔
446
        }
19,989✔
447
        auto parent = string_short->get_parent();
10,734✔
448
        auto ndx_in_parent = string_short->get_ndx_in_parent();
10,734✔
449
        string_short->destroy();
10,734✔
450

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

6,348✔
456
        m_type = Type::big_strings;
10,734✔
457
    }
10,734✔
458

14,742✔
459
    return m_type;
27,798✔
460
}
27,798✔
461

462
void ArrayString::verify() const
463
{
218,598✔
464
#ifdef REALM_DEBUG
218,598✔
465
    switch (m_type) {
218,598✔
466
        case Type::small_strings:
212,205✔
467
            static_cast<ArrayStringShort*>(m_arr)->verify();
212,205✔
468
            break;
212,205✔
469
        case Type::medium_strings:
636✔
470
            static_cast<ArraySmallBlobs*>(m_arr)->verify();
636✔
471
            break;
636✔
472
        case Type::big_strings:
5,511✔
473
            static_cast<ArrayBigBlobs*>(m_arr)->verify();
5,511✔
474
            break;
5,511✔
475
        case Type::enum_strings:
252✔
476
            static_cast<Array*>(m_arr)->verify();
252✔
477
            break;
252✔
478
    }
218,598✔
479
#endif
218,598✔
480
}
218,598✔
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