-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
MMKV_IO.cpp
executable file
·1860 lines (1697 loc) · 64.7 KB
/
MMKV_IO.cpp
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Tencent is pleased to support the open source community by making
* MMKV available.
*
* Copyright (C) 2020 THL A29 Limited, a Tencent company.
* All rights reserved.
*
* Licensed under the BSD 3-Clause License (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of
* the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*
* 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.
*/
#include "MMKV_IO.h"
#include "CodedInputData.h"
#include "CodedOutputData.h"
#include "InterProcessLock.h"
#include "MMBuffer.h"
#include "MMKVLog.h"
#include "MMKVMetaInfo.hpp"
#include "MemoryFile.h"
#include "MiniPBCoder.h"
#include "PBUtility.h"
#include "ScopedLock.hpp"
#include "ThreadLock.h"
#include "aes/AESCrypt.h"
#include "aes/openssl/openssl_aes.h"
#include "aes/openssl/openssl_md5.h"
#include "crc32/Checksum.h"
#include <algorithm>
#include <cassert>
#include <cstring>
#include <ctime>
#ifdef MMKV_IOS
# include "MMKV_OSX.h"
#endif
#ifdef MMKV_APPLE
# if __has_feature(objc_arc)
# error This file must be compiled with MRC. Use -fno-objc-arc flag.
# endif
#endif // MMKV_APPLE
#ifndef MMKV_WIN32
# include <unistd.h>
#endif
using namespace std;
using namespace mmkv;
using KVHolderRet_t = std::pair<bool, KeyValueHolder>;
extern ThreadLock *g_instanceLock;
extern unordered_map<string, MMKV *> *g_instanceDic;
MMKV_NAMESPACE_BEGIN
void MMKV::loadFromFile() {
loadMetaInfoAndCheck();
#ifndef MMKV_DISABLE_CRYPT
if (m_crypter) {
if (m_metaInfo->m_version >= MMKVVersionRandomIV) {
m_crypter->resetIV(m_metaInfo->m_vector, sizeof(m_metaInfo->m_vector));
}
}
#endif
if (!m_file->isFileValid()) {
m_file->reloadFromFile(m_expectedCapacity);
}
if (!m_file->isFileValid()) {
MMKVError("file [%s] not valid", m_path.c_str());
} else {
// error checking
bool loadFromFile = false, needFullWriteback = false;
checkDataValid(loadFromFile, needFullWriteback);
MMKVInfo("loading [%s] with %zu actual size, file size %zu, InterProcess %d, meta info "
"version:%u",
m_mmapID.c_str(), m_actualSize, m_file->getFileSize(), m_isInterProcess, m_metaInfo->m_version);
auto ptr = (uint8_t *) m_file->getMemory();
// loading
if (loadFromFile && m_actualSize > 0) {
MMKVInfo("loading [%s] with crc %u sequence %u version %u", m_mmapID.c_str(), m_metaInfo->m_crcDigest,
m_metaInfo->m_sequence, m_metaInfo->m_version);
MMBuffer inputBuffer(ptr + Fixed32Size, m_actualSize, MMBufferNoCopy);
if (m_crypter) {
clearDictionary(m_dicCrypt);
} else {
clearDictionary(m_dic);
}
if (needFullWriteback) {
#ifndef MMKV_DISABLE_CRYPT
if (m_crypter) {
MiniPBCoder::greedyDecodeMap(*m_dicCrypt, inputBuffer, m_crypter);
} else
#endif
{
MiniPBCoder::greedyDecodeMap(*m_dic, inputBuffer);
}
} else {
#ifndef MMKV_DISABLE_CRYPT
if (m_crypter) {
MiniPBCoder::decodeMap(*m_dicCrypt, inputBuffer, m_crypter);
} else
#endif
{
MiniPBCoder::decodeMap(*m_dic, inputBuffer);
}
}
m_output = new CodedOutputData(ptr + Fixed32Size, m_file->getFileSize() - Fixed32Size);
m_output->seek(m_actualSize);
if (needFullWriteback) {
fullWriteback();
}
} else {
// file not valid or empty, discard everything
SCOPED_LOCK(m_exclusiveProcessLock);
m_output = new CodedOutputData(ptr + Fixed32Size, m_file->getFileSize() - Fixed32Size);
if (m_actualSize > 0) {
writeActualSize(0, 0, nullptr, IncreaseSequence);
sync(MMKV_SYNC);
} else {
writeActualSize(0, 0, nullptr, KeepSequence);
}
}
auto count = m_crypter ? m_dicCrypt->size() : m_dic->size();
MMKVInfo("loaded [%s] with %zu key-values", m_mmapID.c_str(), count);
}
m_needLoadFromFile = false;
}
// read from last m_position
void MMKV::partialLoadFromFile() {
if (!m_file->isFileValid()) {
return;
}
m_metaInfo->read(m_metaFile->getMemory());
size_t oldActualSize = m_actualSize;
m_actualSize = readActualSize();
auto fileSize = m_file->getFileSize();
MMKVDebug("loading [%s] with file size %zu, oldActualSize %zu, newActualSize %zu", m_mmapID.c_str(), fileSize,
oldActualSize, m_actualSize);
if (m_actualSize > 0) {
if (m_actualSize < fileSize && m_actualSize + Fixed32Size <= fileSize) {
if (m_actualSize > oldActualSize) {
auto position = oldActualSize;
size_t addedSize = m_actualSize - position;
auto basePtr = (uint8_t *) m_file->getMemory() + Fixed32Size;
// incremental update crc digest
m_crcDigest = (uint32_t) CRC32(m_crcDigest, basePtr + position, (z_size_t) addedSize);
if (m_crcDigest == m_metaInfo->m_crcDigest) {
MMBuffer inputBuffer(basePtr, m_actualSize, MMBufferNoCopy);
#ifndef MMKV_DISABLE_CRYPT
if (m_crypter) {
MiniPBCoder::greedyDecodeMap(*m_dicCrypt, inputBuffer, m_crypter, position);
} else
#endif
{
MiniPBCoder::greedyDecodeMap(*m_dic, inputBuffer, position);
}
m_output->seek(addedSize);
m_hasFullWriteback = false;
[[maybe_unused]] auto count = m_crypter ? m_dicCrypt->size() : m_dic->size();
MMKVDebug("partial loaded [%s] with %zu values", m_mmapID.c_str(), count);
return;
} else {
MMKVError("m_crcDigest[%u] != m_metaInfo->m_crcDigest[%u]", m_crcDigest, m_metaInfo->m_crcDigest);
}
}
}
}
// something is wrong, do a full load
clearMemoryCache();
loadFromFile();
}
void MMKV::loadMetaInfoAndCheck() {
if (!m_metaFile->isFileValid()) {
m_metaFile->reloadFromFile();
}
if (!m_metaFile->isFileValid()) {
MMKVError("file [%s] not valid", m_metaFile->getPath().c_str());
return;
}
m_metaInfo->read(m_metaFile->getMemory());
// the meta file is in specious status
if (m_metaInfo->m_version >= MMKVVersionHolder) {
MMKVWarning("meta file [%s] in specious state, version %u, flags 0x%llx", m_mmapID.c_str(),
m_metaInfo->m_version, m_metaInfo->m_flags);
// MMKVVersionActualSize is the last version we don't check meta file
m_metaInfo->m_version = MMKVVersionActualSize;
m_metaInfo->m_flags = 0;
m_metaInfo->write(m_metaFile->getMemory());
}
if (m_metaInfo->m_version >= MMKVVersionFlag) {
m_enableKeyExpire = m_metaInfo->hasFlag(MMKVMetaInfo::EnableKeyExipre);
if (m_enableKeyExpire && m_enableCompareBeforeSet) {
MMKVError("enableCompareBeforeSet will be invalid when Expiration is on");
m_enableCompareBeforeSet = false;
}
MMKVInfo("meta file [%s] has flag [%llu]", m_mmapID.c_str(), m_metaInfo->m_flags);
} else {
if (m_metaInfo->m_flags != 0) {
m_metaInfo->m_flags = 0;
m_metaInfo->write(m_metaFile->getMemory());
}
}
}
void MMKV::checkDataValid(bool &loadFromFile, bool &needFullWriteback) {
// try auto recover from last confirmed location
auto fileSize = m_file->getFileSize();
auto checkLastConfirmedInfo = [&] {
if (m_metaInfo->m_version >= MMKVVersionActualSize) {
// downgrade & upgrade support
uint32_t oldStyleActualSize = 0;
memcpy(&oldStyleActualSize, m_file->getMemory(), Fixed32Size);
if (oldStyleActualSize != m_actualSize) {
MMKVWarning("oldStyleActualSize %u not equal to meta actual size %lu", oldStyleActualSize,
m_actualSize);
if (oldStyleActualSize < fileSize && (oldStyleActualSize + Fixed32Size) <= fileSize) {
if (checkFileCRCValid(oldStyleActualSize, m_metaInfo->m_crcDigest)) {
MMKVInfo("looks like [%s] been downgrade & upgrade again", m_mmapID.c_str());
loadFromFile = true;
writeActualSize(oldStyleActualSize, m_metaInfo->m_crcDigest, nullptr, KeepSequence);
return;
}
} else {
MMKVWarning("oldStyleActualSize %u greater than file size %lu", oldStyleActualSize, fileSize);
}
}
auto lastActualSize = m_metaInfo->m_lastConfirmedMetaInfo.lastActualSize;
if (lastActualSize < fileSize && (lastActualSize + Fixed32Size) <= fileSize) {
auto lastCRCDigest = m_metaInfo->m_lastConfirmedMetaInfo.lastCRCDigest;
if (checkFileCRCValid(lastActualSize, lastCRCDigest)) {
loadFromFile = true;
writeActualSize(lastActualSize, lastCRCDigest, nullptr, KeepSequence);
} else {
MMKVError("check [%s] error: lastActualSize %u, lastActualCRC %u", m_mmapID.c_str(), lastActualSize,
lastCRCDigest);
}
} else {
MMKVError("check [%s] error: lastActualSize %u, file size is %u", m_mmapID.c_str(), lastActualSize,
fileSize);
}
}
};
m_actualSize = readActualSize();
if (m_actualSize < fileSize && (m_actualSize + Fixed32Size) <= fileSize) {
if (checkFileCRCValid(m_actualSize, m_metaInfo->m_crcDigest)) {
loadFromFile = true;
} else {
checkLastConfirmedInfo();
if (!loadFromFile) {
auto strategic = onMMKVCRCCheckFail(m_mmapID);
if (strategic == OnErrorRecover) {
loadFromFile = true;
needFullWriteback = true;
}
MMKVInfo("recover strategic for [%s] is %d", m_mmapID.c_str(), strategic);
}
}
} else {
MMKVError("check [%s] error: %zu size in total, file size is %zu", m_mmapID.c_str(), m_actualSize, fileSize);
checkLastConfirmedInfo();
if (!loadFromFile) {
auto strategic = onMMKVFileLengthError(m_mmapID);
if (strategic == OnErrorRecover) {
// make sure we don't over read the file
m_actualSize = fileSize - Fixed32Size;
loadFromFile = true;
needFullWriteback = true;
}
MMKVInfo("recover strategic for [%s] is %d", m_mmapID.c_str(), strategic);
}
}
}
void MMKV::checkLoadData() {
if (m_needLoadFromFile) {
SCOPED_LOCK(m_sharedProcessLock);
m_needLoadFromFile = false;
loadFromFile();
return;
}
if (!m_isInterProcess) {
return;
}
if (!m_metaFile->isFileValid()) {
return;
}
SCOPED_LOCK(m_sharedProcessLock);
MMKVMetaInfo metaInfo;
metaInfo.read(m_metaFile->getMemory());
if (m_metaInfo->m_sequence != metaInfo.m_sequence) {
MMKVInfo("[%s] oldSeq %u, newSeq %u", m_mmapID.c_str(), m_metaInfo->m_sequence, metaInfo.m_sequence);
SCOPED_LOCK(m_sharedProcessLock);
clearMemoryCache();
loadFromFile();
notifyContentChanged();
} else if (m_metaInfo->m_crcDigest != metaInfo.m_crcDigest) {
MMKVDebug("[%s] oldCrc %u, newCrc %u, new actualSize %u", m_mmapID.c_str(), m_metaInfo->m_crcDigest,
metaInfo.m_crcDigest, metaInfo.m_actualSize);
SCOPED_LOCK(m_sharedProcessLock);
size_t fileSize = m_file->getActualFileSize();
if (m_file->getFileSize() != fileSize) {
MMKVInfo("file size has changed [%s] from %zu to %zu", m_mmapID.c_str(), m_file->getFileSize(), fileSize);
clearMemoryCache();
loadFromFile();
} else {
partialLoadFromFile();
}
notifyContentChanged();
}
}
constexpr uint32_t ItemSizeHolder = 0x00ffffff;
constexpr uint32_t ItemSizeHolderSize = 4;
static pair<MMBuffer, size_t> prepareEncode(const MMKVMap &dic) {
// make some room for placeholder
size_t totalSize = ItemSizeHolderSize;
for (auto &itr : dic) {
auto &kvHolder = itr.second;
totalSize += kvHolder.computedKVSize + kvHolder.valueSize;
}
return make_pair(MMBuffer(), totalSize);
}
#ifndef MMKV_DISABLE_CRYPT
static pair<MMBuffer, size_t> prepareEncode(const MMKVMapCrypt &dic) {
MMKVVector vec;
size_t totalSize = 0;
// make some room for placeholder
uint32_t smallestOffet = 5 + 1; // 5 is the largest size needed to encode varint32
for (auto &itr : dic) {
auto &kvHolder = itr.second;
if (kvHolder.type == KeyValueHolderType_Offset) {
totalSize += kvHolder.pbKeyValueSize + kvHolder.keySize + kvHolder.valueSize;
smallestOffet = min(smallestOffet, kvHolder.offset);
} else {
vec.emplace_back(itr.first, kvHolder.toMMBuffer(nullptr, nullptr));
}
}
if (smallestOffet > 5) {
smallestOffet = ItemSizeHolderSize;
}
totalSize += smallestOffet;
if (vec.empty()) {
return make_pair(MMBuffer(), totalSize);
}
auto buffer = MiniPBCoder::encodeDataWithObject(vec);
// skip the pb size of buffer
auto sizeOfMap = CodedInputData(buffer.getPtr(), buffer.length()).readUInt32();
totalSize += sizeOfMap;
return make_pair(std::move(buffer), totalSize);
}
#endif
static pair<MMBuffer, size_t> prepareEncode(MMKVVector &&vec) {
// make some room for placeholder
size_t totalSize = ItemSizeHolderSize;
auto buffer = MiniPBCoder::encodeDataWithObject(vec);
// skip the pb size of buffer
auto sizeOfMap = CodedInputData(buffer.getPtr(), buffer.length()).readUInt32();
totalSize += sizeOfMap;
return make_pair(std::move(buffer), totalSize);
}
// since we use append mode, when -[setData: forKey:] many times, space may not be enough
// try a full rewrite to make space
bool MMKV::ensureMemorySize(size_t newSize) {
if (!isFileValid()) {
MMKVWarning("[%s] file not valid", m_mmapID.c_str());
return false;
}
if (newSize >= m_output->spaceLeft() || (m_crypter ? m_dicCrypt->empty() : m_dic->empty())) {
// remove expired keys
if (m_enableKeyExpire) {
filterExpiredKeys();
}
// try a full rewrite to make space
auto preparedData = m_crypter ? prepareEncode(*m_dicCrypt) : prepareEncode(*m_dic);
// dic.empty() means inserting key-value for the first time, no need to call msync()
return expandAndWriteBack(newSize, std::move(preparedData), m_crypter ? !m_dicCrypt->empty() : !m_dic->empty());
}
return true;
}
// try a full rewrite to make space
bool MMKV::expandAndWriteBack(size_t newSize, std::pair<mmkv::MMBuffer, size_t> preparedData, bool needSync) {
auto fileSize = m_file->getFileSize();
auto sizeOfDic = preparedData.second;
size_t lenNeeded = sizeOfDic + Fixed32Size + newSize;
size_t nowDicCount = m_crypter ? m_dicCrypt->size() : m_dic->size();
size_t laterDicCount = std::max<size_t>(1, nowDicCount + 1);
// or use <cmath> ceil()
size_t avgItemSize = (lenNeeded + laterDicCount - 1) / laterDicCount;
size_t futureUsage = avgItemSize * std::max<size_t>(8, laterDicCount / 2);
// 1. no space for a full rewrite, double it
// 2. or space is not large enough for future usage, double it to avoid frequently full rewrite
if (lenNeeded >= fileSize || (needSync && (lenNeeded + futureUsage) >= fileSize)) {
size_t oldSize = fileSize;
do {
fileSize *= 2;
} while (lenNeeded + futureUsage >= fileSize);
MMKVInfo("extending [%s] file size from %zu to %zu, incoming size:%zu, future usage:%zu", m_mmapID.c_str(),
oldSize, fileSize, newSize, futureUsage);
// if we can't extend size, rollback to old state
// this is a good place to mock enlarging file failure
if (!m_file->truncate(fileSize)) {
return false;
}
// check if we fail to make more space
if (!isFileValid()) {
MMKVWarning("[%s] file not valid", m_mmapID.c_str());
return false;
}
}
return doFullWriteBack(std::move(preparedData), nullptr, needSync);
}
size_t MMKV::readActualSize() {
MMKV_ASSERT(m_file->getMemory());
MMKV_ASSERT(m_metaFile->isFileValid());
uint32_t actualSize = 0;
memcpy(&actualSize, m_file->getMemory(), Fixed32Size);
if (m_metaInfo->m_version >= MMKVVersionActualSize) {
if (m_metaInfo->m_actualSize != actualSize) {
MMKVWarning("[%s] actual size %u, meta actual size %u", m_mmapID.c_str(), actualSize,
m_metaInfo->m_actualSize);
}
return m_metaInfo->m_actualSize;
} else {
return actualSize;
}
}
void MMKV::oldStyleWriteActualSize(size_t actualSize) {
MMKV_ASSERT(m_file->getMemory());
m_actualSize = actualSize;
#ifdef MMKV_IOS
auto ret = guardForBackgroundWriting(m_file->getMemory(), Fixed32Size);
if (!ret.first) {
return;
}
#endif
memcpy(m_file->getMemory(), &actualSize, Fixed32Size);
}
bool MMKV::writeActualSize(size_t size, uint32_t crcDigest, const void *iv, bool increaseSequence) {
// backward compatibility
oldStyleWriteActualSize(size);
if (!m_metaFile->isFileValid()) {
return false;
}
bool needsFullWrite = false;
m_actualSize = size;
m_metaInfo->m_actualSize = static_cast<uint32_t>(size);
m_crcDigest = crcDigest;
m_metaInfo->m_crcDigest = crcDigest;
if (m_metaInfo->m_version < MMKVVersionSequence) {
m_metaInfo->m_version = MMKVVersionSequence;
needsFullWrite = true;
}
#ifndef MMKV_DISABLE_CRYPT
if (unlikely(iv)) {
memcpy(m_metaInfo->m_vector, iv, sizeof(m_metaInfo->m_vector));
if (m_metaInfo->m_version < MMKVVersionRandomIV) {
m_metaInfo->m_version = MMKVVersionRandomIV;
}
needsFullWrite = true;
}
#endif
if (unlikely(increaseSequence)) {
m_metaInfo->m_sequence++;
m_metaInfo->m_lastConfirmedMetaInfo.lastActualSize = static_cast<uint32_t>(size);
m_metaInfo->m_lastConfirmedMetaInfo.lastCRCDigest = crcDigest;
if (m_metaInfo->m_version < MMKVVersionActualSize) {
m_metaInfo->m_version = MMKVVersionActualSize;
}
needsFullWrite = true;
MMKVInfo("[%s] increase sequence to %u, crc %u, actualSize %u", m_mmapID.c_str(), m_metaInfo->m_sequence,
m_metaInfo->m_crcDigest, m_metaInfo->m_actualSize);
}
if (m_metaInfo->m_version < MMKVVersionFlag) {
m_metaInfo->m_flags = 0;
m_metaInfo->m_version = MMKVVersionFlag;
needsFullWrite = true;
}
#ifdef MMKV_IOS
auto ret = guardForBackgroundWriting(m_metaFile->getMemory(), sizeof(MMKVMetaInfo));
if (!ret.first) {
return false;
}
#endif
if (unlikely(needsFullWrite)) {
m_metaInfo->write(m_metaFile->getMemory());
} else {
m_metaInfo->writeCRCAndActualSizeOnly(m_metaFile->getMemory());
}
return true;
}
MMBuffer MMKV::getRawDataForKey(MMKVKey_t key) {
checkLoadData();
#ifndef MMKV_DISABLE_CRYPT
if (m_crypter) {
auto itr = m_dicCrypt->find(key);
if (itr != m_dicCrypt->end()) {
auto basePtr = (uint8_t *) (m_file->getMemory()) + Fixed32Size;
return itr->second.toMMBuffer(basePtr, m_crypter);
}
} else
#endif
{
auto itr = m_dic->find(key);
if (itr != m_dic->end()) {
auto basePtr = (uint8_t *) (m_file->getMemory()) + Fixed32Size;
return itr->second.toMMBuffer(basePtr);
}
}
MMBuffer nan;
return nan;
}
mmkv::MMBuffer MMKV::getDataForKey(MMKVKey_t key) {
if (unlikely(m_enableKeyExpire)) {
return getDataWithoutMTimeForKey(key);
}
return getRawDataForKey(key);
}
#ifndef MMKV_DISABLE_CRYPT
// for Apple watch simulator
# if defined(TARGET_OS_SIMULATOR) && defined(TARGET_CPU_X86)
static AESCryptStatus t_status;
# else
thread_local AESCryptStatus t_status;
# endif
#endif // MMKV_DISABLE_CRYPT
bool MMKV::setDataForKey(MMBuffer &&data, MMKVKey_t key, bool isDataHolder) {
if ((!isDataHolder && data.length() == 0) || isKeyEmpty(key)) {
return false;
}
SCOPED_LOCK(m_lock);
SCOPED_LOCK(m_exclusiveProcessLock);
checkLoadData();
#ifndef MMKV_DISABLE_CRYPT
if (m_crypter) {
if (isDataHolder) {
auto sizeNeededForData = pbRawVarint32Size((uint32_t) data.length()) + data.length();
if (!KeyValueHolderCrypt::isValueStoredAsOffset(sizeNeededForData)) {
data = MiniPBCoder::encodeDataWithObject(data);
isDataHolder = false;
}
}
auto itr = m_dicCrypt->find(key);
if (itr != m_dicCrypt->end()) {
bool onlyOneKey = !m_isInterProcess && m_dicCrypt->size() == 1;
# ifdef MMKV_APPLE
KVHolderRet_t ret;
if (onlyOneKey) {
ret = overrideDataWithKey(data, key, itr->second, isDataHolder);
} else {
ret = appendDataWithKey(data, key, itr->second, isDataHolder);
}
# else
KVHolderRet_t ret;
if (onlyOneKey) {
ret = overrideDataWithKey(data, key, isDataHolder);
} else {
ret = appendDataWithKey(data, key, isDataHolder);
}
# endif
if (!ret.first) {
return false;
}
KeyValueHolderCrypt kvHolder;
if (KeyValueHolderCrypt::isValueStoredAsOffset(ret.second.valueSize)) {
kvHolder = KeyValueHolderCrypt(ret.second.keySize, ret.second.valueSize, ret.second.offset);
memcpy(&kvHolder.cryptStatus, &t_status, sizeof(t_status));
} else {
kvHolder = KeyValueHolderCrypt(std::move(data));
}
if (likely(!m_enableKeyExpire)) {
itr->second = std::move(kvHolder);
} else {
itr = m_dicCrypt->find(key);
if (itr != m_dicCrypt->end()) {
itr->second = std::move(kvHolder);
} else {
// in case filterExpiredKeys() is triggered
m_dicCrypt->emplace(key, std::move(kvHolder));
mmkv_retain_key(key);
}
}
} else {
bool needOverride = !m_isInterProcess && m_dicCrypt->empty() && m_actualSize > 0;
KVHolderRet_t ret;
if (needOverride) {
ret = overrideDataWithKey(data, key, isDataHolder);
} else {
ret = appendDataWithKey(data, key, isDataHolder);
}
if (!ret.first) {
return false;
}
if (KeyValueHolderCrypt::isValueStoredAsOffset(ret.second.valueSize)) {
auto r = m_dicCrypt->emplace(
key, KeyValueHolderCrypt(ret.second.keySize, ret.second.valueSize, ret.second.offset));
if (r.second) {
memcpy(&(r.first->second.cryptStatus), &t_status, sizeof(t_status));
}
} else {
m_dicCrypt->emplace(key, KeyValueHolderCrypt(std::move(data)));
}
mmkv_retain_key(key);
}
} else
#endif // MMKV_DISABLE_CRYPT
{
auto itr = m_dic->find(key);
if (itr != m_dic->end()) {
// compare data before appending to file
if (isCompareBeforeSetEnabled()) {
auto basePtr = (uint8_t *) (m_file->getMemory()) + Fixed32Size;
MMBuffer oldValueData = itr->second.toMMBuffer(basePtr);
if (isDataHolder) {
CodedInputData inputData(oldValueData.getPtr(), oldValueData.length());
try {
// read extra holder header bytes and to real MMBuffer
oldValueData = CodedInputData::readRealData(oldValueData);
if (oldValueData == data) {
// MMKVInfo("[key] %s, set the same data", key.c_str());
return true;
}
} catch (std::exception &exception) {
MMKVError("compareBeforeSet exception: %s", exception.what());
} catch (...) {
MMKVError("compareBeforeSet fail");
}
} else {
if (oldValueData == data) {
// MMKVInfo("[key] %s, set the same data", key.c_str());
return true;
}
}
}
bool onlyOneKey = !m_isInterProcess && m_dic->size() == 1;
if (likely(!m_enableKeyExpire)) {
KVHolderRet_t ret;
if (onlyOneKey) {
ret = overrideDataWithKey(data, itr->second, isDataHolder);
} else {
ret = appendDataWithKey(data, itr->second, isDataHolder);
}
if (!ret.first) {
return false;
}
itr->second = std::move(ret.second);
} else {
KVHolderRet_t ret;
if (onlyOneKey) {
ret = overrideDataWithKey(data, key, isDataHolder);
} else {
ret = appendDataWithKey(data, key, isDataHolder);
}
if (!ret.first) {
return false;
}
itr = m_dic->find(key);
if (itr != m_dic->end()) {
itr->second = std::move(ret.second);
} else {
// in case filterExpiredKeys() is triggered
m_dic->emplace(key, std::move(ret.second));
mmkv_retain_key(key);
}
}
} else {
bool needOverride = !m_isInterProcess && m_dic->empty() && m_actualSize > 0;
KVHolderRet_t ret;
if (needOverride) {
ret = overrideDataWithKey(data, key, isDataHolder);
} else {
ret = appendDataWithKey(data, key, isDataHolder);
}
if (!ret.first) {
return false;
}
m_dic->emplace(key, std::move(ret.second));
mmkv_retain_key(key);
}
}
m_hasFullWriteback = false;
return true;
}
bool MMKV::removeDataForKey(MMKVKey_t key) {
if (isKeyEmpty(key)) {
return false;
}
#ifndef MMKV_DISABLE_CRYPT
if (m_crypter) {
auto itr = m_dicCrypt->find(key);
if (itr != m_dicCrypt->end()) {
m_hasFullWriteback = false;
static MMBuffer nan;
# ifdef MMKV_APPLE
auto ret = appendDataWithKey(nan, key, itr->second);
if (ret.first) {
if (unlikely(m_enableKeyExpire)) {
// filterExpiredKeys() may invalid itr
itr = m_dicCrypt->find(key);
if (itr == m_dicCrypt->end()) {
return true;
}
}
auto oldKey = itr->first;
m_dicCrypt->erase(itr);
[oldKey release];
}
# else
auto ret = appendDataWithKey(nan, key);
if (ret.first) {
if (unlikely(m_enableKeyExpire)) {
m_dicCrypt->erase(key);
} else {
m_dicCrypt->erase(itr);
}
}
# endif
return ret.first;
}
} else
#endif // MMKV_DISABLE_CRYPT
{
auto itr = m_dic->find(key);
if (itr != m_dic->end()) {
m_hasFullWriteback = false;
static MMBuffer nan;
auto ret = likely(!m_enableKeyExpire) ? appendDataWithKey(nan, itr->second) : appendDataWithKey(nan, key);
if (ret.first) {
#ifdef MMKV_APPLE
if (unlikely(m_enableKeyExpire)) {
// filterExpiredKeys() may invalid itr
itr = m_dic->find(key);
if (itr == m_dic->end()) {
return true;
}
}
auto oldKey = itr->first;
m_dic->erase(itr);
[oldKey release];
#else
if (unlikely(m_enableKeyExpire)) {
// filterExpiredKeys() may invalid itr
m_dic->erase(key);
} else {
m_dic->erase(itr);
}
#endif
}
return ret.first;
}
}
return false;
}
KVHolderRet_t
MMKV::doAppendDataWithKey(const MMBuffer &data, const MMBuffer &keyData, bool isDataHolder, uint32_t originKeyLength) {
auto isKeyEncoded = (originKeyLength < keyData.length());
auto keyLength = static_cast<uint32_t>(keyData.length());
auto valueLength = static_cast<uint32_t>(data.length());
if (isDataHolder) {
valueLength += pbRawVarint32Size(valueLength);
}
// size needed to encode the key
size_t size = isKeyEncoded ? keyLength : (keyLength + pbRawVarint32Size(keyLength));
// size needed to encode the value
size += valueLength + pbRawVarint32Size(valueLength);
SCOPED_LOCK(m_exclusiveProcessLock);
bool hasEnoughSize = ensureMemorySize(size);
if (!hasEnoughSize || !isFileValid()) {
return make_pair(false, KeyValueHolder());
}
#ifdef MMKV_IOS
auto ret = guardForBackgroundWriting(m_output->curWritePointer(), size);
if (!ret.first) {
return make_pair(false, KeyValueHolder());
}
#endif
#ifndef MMKV_DISABLE_CRYPT
if (m_crypter) {
if (KeyValueHolderCrypt::isValueStoredAsOffset(valueLength)) {
m_crypter->getCurStatus(t_status);
}
}
#endif
try {
if (isKeyEncoded) {
m_output->writeRawData(keyData);
} else {
m_output->writeData(keyData);
}
if (isDataHolder) {
m_output->writeRawVarint32((int32_t) valueLength);
}
m_output->writeData(data); // note: write size of data
} catch (std::exception &e) {
MMKVError("%s", e.what());
return make_pair(false, KeyValueHolder());
} catch (...) {
MMKVError("append fail");
return make_pair(false, KeyValueHolder());
}
auto offset = static_cast<uint32_t>(m_actualSize);
auto ptr = (uint8_t *) m_file->getMemory() + Fixed32Size + m_actualSize;
#ifndef MMKV_DISABLE_CRYPT
if (m_crypter) {
m_crypter->encrypt(ptr, ptr, size);
}
#endif
m_actualSize += size;
updateCRCDigest(ptr, size);
return make_pair(true, KeyValueHolder(originKeyLength, valueLength, offset));
}
KVHolderRet_t MMKV::doOverrideDataWithKey(const MMBuffer &data,
const MMBuffer &keyData,
bool isDataHolder,
uint32_t originKeyLength) {
auto isKeyEncoded = (originKeyLength < keyData.length());
auto keyLength = static_cast<uint32_t>(keyData.length());
auto valueLength = static_cast<uint32_t>(data.length());
if (isDataHolder) {
valueLength += pbRawVarint32Size(valueLength);
}
// size needed to encode the key
size_t size = isKeyEncoded ? keyLength : (keyLength + pbRawVarint32Size(keyLength));
// size needed to encode the value
size += valueLength + pbRawVarint32Size(valueLength);
if (!checkSizeForOverride(size)) {
return doAppendDataWithKey(data, keyData, isDataHolder, originKeyLength);
}
// we don't not support override in multi-process mode
// SCOPED_LOCK(m_exclusiveProcessLock);
#ifdef MMKV_IOS
auto ret = guardForBackgroundWriting(m_output->curWritePointer(), size);
if (!ret.first) {
return make_pair(false, KeyValueHolder());
}
#endif
#ifndef MMKV_DISABLE_CRYPT
if (m_crypter) {
if (m_metaInfo->m_version >= MMKVVersionRandomIV) {
m_crypter->resetIV(m_metaInfo->m_vector, sizeof(m_metaInfo->m_vector));
} else {
m_crypter->resetIV();
}
if (KeyValueHolderCrypt::isValueStoredAsOffset(valueLength)) {
m_crypter->getCurStatus(t_status);
}
}
#endif
try {
// write ItemSizeHolder
m_output->setPosition(0);
m_output->writeRawVarint32(ItemSizeHolder);
m_actualSize = ItemSizeHolderSize;
if (isKeyEncoded) {
m_output->writeRawData(keyData);
} else {
m_output->writeData(keyData);
}
if (isDataHolder) {
m_output->writeRawVarint32((int32_t) valueLength);
}
m_output->writeData(data); // note: write size of data
} catch (std::exception &e) {
MMKVError("%s", e.what());
return make_pair(false, KeyValueHolder());
} catch (...) {
MMKVError("append fail");
return make_pair(false, KeyValueHolder());
}
auto offset = static_cast<uint32_t>(m_actualSize);
m_actualSize += size;
auto ptr = (uint8_t *) m_file->getMemory() + Fixed32Size;
#ifndef MMKV_DISABLE_CRYPT
if (m_crypter) {
m_crypter->encrypt(ptr, ptr, m_actualSize);
}
#endif
recaculateCRCDigestOnly();
return make_pair(true, KeyValueHolder(originKeyLength, valueLength, offset));
}
bool MMKV::checkSizeForOverride(size_t size) {
if (!isFileValid()) {
MMKVWarning("[%s] file not valid", m_mmapID.c_str());
return false;
}
// only override if the file can hole it without ftruncate()
auto fileSize = m_file->getFileSize();
auto spaceNeededForOverride = size + Fixed32Size + ItemSizeHolderSize;
if (size > fileSize || spaceNeededForOverride > fileSize) {
return false;
}
return true;
}
KVHolderRet_t MMKV::appendDataWithKey(const MMBuffer &data, MMKVKey_t key, bool isDataHolder) {
#ifdef MMKV_APPLE
auto oData = [key dataUsingEncoding:NSUTF8StringEncoding];
auto keyData = MMBuffer(oData, MMBufferNoCopy);
#else
auto keyData = MMBuffer((void *) key.data(), key.size(), MMBufferNoCopy);
#endif
return doAppendDataWithKey(data, keyData, isDataHolder, static_cast<uint32_t>(keyData.length()));
}
KVHolderRet_t MMKV::overrideDataWithKey(const MMBuffer &data, MMKVKey_t key, bool isDataHolder) {
#ifdef MMKV_APPLE
auto oData = [key dataUsingEncoding:NSUTF8StringEncoding];
auto keyData = MMBuffer(oData, MMBufferNoCopy);
#else
auto keyData = MMBuffer((void *) key.data(), key.size(), MMBufferNoCopy);
#endif
return doOverrideDataWithKey(data, keyData, isDataHolder, static_cast<uint32_t>(keyData.length()));
}
KVHolderRet_t MMKV::appendDataWithKey(const MMBuffer &data, const KeyValueHolder &kvHolder, bool isDataHolder) {
SCOPED_LOCK(m_exclusiveProcessLock);
uint32_t keyLength = kvHolder.keySize;
// size needed to encode the key
size_t rawKeySize = keyLength + pbRawVarint32Size(keyLength);
// ensureMemorySize() might change kvHolder.offset, so have to do it early
{
auto valueLength = static_cast<uint32_t>(data.length());
if (isDataHolder) {
valueLength += pbRawVarint32Size(valueLength);
}
auto size = rawKeySize + valueLength + pbRawVarint32Size(valueLength);
bool hasEnoughSize = ensureMemorySize(size);
if (!hasEnoughSize) {
return make_pair(false, KeyValueHolder());
}
}