MMKV_IO.cpp 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545
  1. /*
  2. * Tencent is pleased to support the open source community by making
  3. * MMKV available.
  4. *
  5. * Copyright (C) 2020 THL A29 Limited, a Tencent company.
  6. * All rights reserved.
  7. *
  8. * Licensed under the BSD 3-Clause License (the "License"); you may not use
  9. * this file except in compliance with the License. You may obtain a copy of
  10. * the License at
  11. *
  12. * https://opensource.org/licenses/BSD-3-Clause
  13. *
  14. * Unless required by applicable law or agreed to in writing, software
  15. * distributed under the License is distributed on an "AS IS" BASIS,
  16. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17. * See the License for the specific language governing permissions and
  18. * limitations under the License.
  19. */
  20. #include "MMKV_IO.h"
  21. #include "CodedInputData.h"
  22. #include "CodedOutputData.h"
  23. #include "InterProcessLock.h"
  24. #include "MMBuffer.h"
  25. #include "MMKVLog.h"
  26. #include "MMKVMetaInfo.hpp"
  27. #include "MemoryFile.h"
  28. #include "MiniPBCoder.h"
  29. #include "PBUtility.h"
  30. #include "ScopedLock.hpp"
  31. #include "ThreadLock.h"
  32. #include "aes/AESCrypt.h"
  33. #include "aes/openssl/openssl_aes.h"
  34. #include "aes/openssl/openssl_md5.h"
  35. #include "crc32/Checksum.h"
  36. #include <algorithm>
  37. #include <cassert>
  38. #include <cstring>
  39. #include <ctime>
  40. #ifdef MMKV_IOS
  41. # include "MMKV_OSX.h"
  42. #endif
  43. #ifdef MMKV_APPLE
  44. # if __has_feature(objc_arc)
  45. # error This file must be compiled with MRC. Use -fno-objc-arc flag.
  46. # endif
  47. #endif // MMKV_APPLE
  48. using namespace std;
  49. using namespace mmkv;
  50. using KVHolderRet_t = std::pair<bool, KeyValueHolder>;
  51. MMKV_NAMESPACE_BEGIN
  52. void MMKV::loadFromFile() {
  53. loadMetaInfoAndCheck();
  54. #ifndef MMKV_DISABLE_CRYPT
  55. if (m_crypter) {
  56. if (m_metaInfo->m_version >= MMKVVersionRandomIV) {
  57. m_crypter->resetIV(m_metaInfo->m_vector, sizeof(m_metaInfo->m_vector));
  58. }
  59. }
  60. #endif
  61. if (!m_file->isFileValid()) {
  62. m_file->reloadFromFile();
  63. }
  64. if (!m_file->isFileValid()) {
  65. MMKVError("file [%s] not valid", m_path.c_str());
  66. } else {
  67. // error checking
  68. bool loadFromFile = false, needFullWriteback = false;
  69. checkDataValid(loadFromFile, needFullWriteback);
  70. MMKVInfo("loading [%s] with %zu actual size, file size %zu, InterProcess %d, meta info "
  71. "version:%u",
  72. m_mmapID.c_str(), m_actualSize, m_file->getFileSize(), m_isInterProcess, m_metaInfo->m_version);
  73. auto ptr = (uint8_t *) m_file->getMemory();
  74. // loading
  75. if (loadFromFile && m_actualSize > 0) {
  76. MMKVInfo("loading [%s] with crc %u sequence %u version %u", m_mmapID.c_str(), m_metaInfo->m_crcDigest,
  77. m_metaInfo->m_sequence, m_metaInfo->m_version);
  78. MMBuffer inputBuffer(ptr + Fixed32Size, m_actualSize, MMBufferNoCopy);
  79. if (m_crypter) {
  80. clearDictionary(m_dicCrypt);
  81. } else {
  82. clearDictionary(m_dic);
  83. }
  84. if (needFullWriteback) {
  85. #ifndef MMKV_DISABLE_CRYPT
  86. if (m_crypter) {
  87. MiniPBCoder::greedyDecodeMap(*m_dicCrypt, inputBuffer, m_crypter);
  88. } else
  89. #endif
  90. {
  91. MiniPBCoder::greedyDecodeMap(*m_dic, inputBuffer);
  92. }
  93. } else {
  94. #ifndef MMKV_DISABLE_CRYPT
  95. if (m_crypter) {
  96. MiniPBCoder::decodeMap(*m_dicCrypt, inputBuffer, m_crypter);
  97. } else
  98. #endif
  99. {
  100. MiniPBCoder::decodeMap(*m_dic, inputBuffer);
  101. }
  102. }
  103. m_output = new CodedOutputData(ptr + Fixed32Size, m_file->getFileSize() - Fixed32Size);
  104. m_output->seek(m_actualSize);
  105. if (needFullWriteback) {
  106. fullWriteback();
  107. }
  108. } else {
  109. // file not valid or empty, discard everything
  110. SCOPED_LOCK(m_exclusiveProcessLock);
  111. m_output = new CodedOutputData(ptr + Fixed32Size, m_file->getFileSize() - Fixed32Size);
  112. if (m_actualSize > 0) {
  113. writeActualSize(0, 0, nullptr, IncreaseSequence);
  114. sync(MMKV_SYNC);
  115. } else {
  116. writeActualSize(0, 0, nullptr, KeepSequence);
  117. }
  118. }
  119. auto count = m_crypter ? m_dicCrypt->size() : m_dic->size();
  120. MMKVInfo("loaded [%s] with %zu key-values", m_mmapID.c_str(), count);
  121. }
  122. m_needLoadFromFile = false;
  123. }
  124. // read from last m_position
  125. void MMKV::partialLoadFromFile() {
  126. m_metaInfo->read(m_metaFile->getMemory());
  127. size_t oldActualSize = m_actualSize;
  128. m_actualSize = readActualSize();
  129. auto fileSize = m_file->getFileSize();
  130. MMKVDebug("loading [%s] with file size %zu, oldActualSize %zu, newActualSize %zu", m_mmapID.c_str(), fileSize,
  131. oldActualSize, m_actualSize);
  132. if (m_actualSize > 0) {
  133. if (m_actualSize < fileSize && m_actualSize + Fixed32Size <= fileSize) {
  134. if (m_actualSize > oldActualSize) {
  135. auto position = oldActualSize;
  136. size_t addedSize = m_actualSize - position;
  137. auto basePtr = (uint8_t *) m_file->getMemory() + Fixed32Size;
  138. // incremental update crc digest
  139. m_crcDigest = (uint32_t) CRC32(m_crcDigest, basePtr + position, addedSize);
  140. if (m_crcDigest == m_metaInfo->m_crcDigest) {
  141. MMBuffer inputBuffer(basePtr, m_actualSize, MMBufferNoCopy);
  142. #ifndef MMKV_DISABLE_CRYPT
  143. if (m_crypter) {
  144. MiniPBCoder::greedyDecodeMap(*m_dicCrypt, inputBuffer, m_crypter, position);
  145. } else
  146. #endif
  147. {
  148. MiniPBCoder::greedyDecodeMap(*m_dic, inputBuffer, position);
  149. }
  150. m_output->seek(addedSize);
  151. m_hasFullWriteback = false;
  152. [[maybe_unused]] auto count = m_crypter ? m_dicCrypt->size() : m_dic->size();
  153. MMKVDebug("partial loaded [%s] with %zu values", m_mmapID.c_str(), count);
  154. return;
  155. } else {
  156. MMKVError("m_crcDigest[%u] != m_metaInfo->m_crcDigest[%u]", m_crcDigest, m_metaInfo->m_crcDigest);
  157. }
  158. }
  159. }
  160. }
  161. // something is wrong, do a full load
  162. clearMemoryCache();
  163. loadFromFile();
  164. }
  165. void MMKV::loadMetaInfoAndCheck() {
  166. if (!m_metaFile->isFileValid()) {
  167. m_metaFile->reloadFromFile();
  168. }
  169. if (!m_metaFile->isFileValid()) {
  170. MMKVError("file [%s] not valid", m_metaFile->getPath().c_str());
  171. return;
  172. }
  173. m_metaInfo->read(m_metaFile->getMemory());
  174. // the meta file is in specious status
  175. if (m_metaInfo->m_version >= MMKVVersionHolder) {
  176. MMKVWarning("meta file [%s] in specious state, version %u, flags 0x%llx", m_mmapID.c_str(), m_metaInfo->m_version, m_metaInfo->m_flags);
  177. // MMKVVersionActualSize is the last version we don't check meta file
  178. m_metaInfo->m_version = MMKVVersionActualSize;
  179. m_metaInfo->m_flags = 0;
  180. m_metaInfo->write(m_metaFile->getMemory());
  181. }
  182. if (m_metaInfo->m_version >= MMKVVersionFlag) {
  183. m_enableKeyExpire = m_metaInfo->hasFlag(MMKVMetaInfo::EnableKeyExipre);
  184. MMKVInfo("meta file [%s] has flag [%llu]", m_mmapID.c_str(), m_metaInfo->m_flags);
  185. } else {
  186. if (m_metaInfo->m_flags != 0) {
  187. m_metaInfo->m_flags = 0;
  188. m_metaInfo->write(m_metaFile->getMemory());
  189. }
  190. }
  191. }
  192. void MMKV::checkDataValid(bool &loadFromFile, bool &needFullWriteback) {
  193. // try auto recover from last confirmed location
  194. auto fileSize = m_file->getFileSize();
  195. auto checkLastConfirmedInfo = [&] {
  196. if (m_metaInfo->m_version >= MMKVVersionActualSize) {
  197. // downgrade & upgrade support
  198. uint32_t oldStyleActualSize = 0;
  199. memcpy(&oldStyleActualSize, m_file->getMemory(), Fixed32Size);
  200. if (oldStyleActualSize != m_actualSize) {
  201. MMKVWarning("oldStyleActualSize %u not equal to meta actual size %lu", oldStyleActualSize,
  202. m_actualSize);
  203. if (oldStyleActualSize < fileSize && (oldStyleActualSize + Fixed32Size) <= fileSize) {
  204. if (checkFileCRCValid(oldStyleActualSize, m_metaInfo->m_crcDigest)) {
  205. MMKVInfo("looks like [%s] been downgrade & upgrade again", m_mmapID.c_str());
  206. loadFromFile = true;
  207. writeActualSize(oldStyleActualSize, m_metaInfo->m_crcDigest, nullptr, KeepSequence);
  208. return;
  209. }
  210. } else {
  211. MMKVWarning("oldStyleActualSize %u greater than file size %lu", oldStyleActualSize, fileSize);
  212. }
  213. }
  214. auto lastActualSize = m_metaInfo->m_lastConfirmedMetaInfo.lastActualSize;
  215. if (lastActualSize < fileSize && (lastActualSize + Fixed32Size) <= fileSize) {
  216. auto lastCRCDigest = m_metaInfo->m_lastConfirmedMetaInfo.lastCRCDigest;
  217. if (checkFileCRCValid(lastActualSize, lastCRCDigest)) {
  218. loadFromFile = true;
  219. writeActualSize(lastActualSize, lastCRCDigest, nullptr, KeepSequence);
  220. } else {
  221. MMKVError("check [%s] error: lastActualSize %u, lastActualCRC %u", m_mmapID.c_str(), lastActualSize,
  222. lastCRCDigest);
  223. }
  224. } else {
  225. MMKVError("check [%s] error: lastActualSize %u, file size is %u", m_mmapID.c_str(), lastActualSize,
  226. fileSize);
  227. }
  228. }
  229. };
  230. m_actualSize = readActualSize();
  231. if (m_actualSize < fileSize && (m_actualSize + Fixed32Size) <= fileSize) {
  232. if (checkFileCRCValid(m_actualSize, m_metaInfo->m_crcDigest)) {
  233. loadFromFile = true;
  234. } else {
  235. checkLastConfirmedInfo();
  236. if (!loadFromFile) {
  237. auto strategic = onMMKVCRCCheckFail(m_mmapID);
  238. if (strategic == OnErrorRecover) {
  239. loadFromFile = true;
  240. needFullWriteback = true;
  241. }
  242. MMKVInfo("recover strategic for [%s] is %d", m_mmapID.c_str(), strategic);
  243. }
  244. }
  245. } else {
  246. MMKVError("check [%s] error: %zu size in total, file size is %zu", m_mmapID.c_str(), m_actualSize, fileSize);
  247. checkLastConfirmedInfo();
  248. if (!loadFromFile) {
  249. auto strategic = onMMKVFileLengthError(m_mmapID);
  250. if (strategic == OnErrorRecover) {
  251. // make sure we don't over read the file
  252. m_actualSize = fileSize - Fixed32Size;
  253. loadFromFile = true;
  254. needFullWriteback = true;
  255. }
  256. MMKVInfo("recover strategic for [%s] is %d", m_mmapID.c_str(), strategic);
  257. }
  258. }
  259. }
  260. void MMKV::checkLoadData() {
  261. if (m_needLoadFromFile) {
  262. SCOPED_LOCK(m_sharedProcessLock);
  263. m_needLoadFromFile = false;
  264. loadFromFile();
  265. return;
  266. }
  267. if (!m_isInterProcess) {
  268. return;
  269. }
  270. if (!m_metaFile->isFileValid()) {
  271. return;
  272. }
  273. SCOPED_LOCK(m_sharedProcessLock);
  274. MMKVMetaInfo metaInfo;
  275. metaInfo.read(m_metaFile->getMemory());
  276. if (m_metaInfo->m_sequence != metaInfo.m_sequence) {
  277. MMKVInfo("[%s] oldSeq %u, newSeq %u", m_mmapID.c_str(), m_metaInfo->m_sequence, metaInfo.m_sequence);
  278. SCOPED_LOCK(m_sharedProcessLock);
  279. clearMemoryCache();
  280. loadFromFile();
  281. notifyContentChanged();
  282. } else if (m_metaInfo->m_crcDigest != metaInfo.m_crcDigest) {
  283. MMKVDebug("[%s] oldCrc %u, newCrc %u, new actualSize %u", m_mmapID.c_str(), m_metaInfo->m_crcDigest,
  284. metaInfo.m_crcDigest, metaInfo.m_actualSize);
  285. SCOPED_LOCK(m_sharedProcessLock);
  286. size_t fileSize = m_file->getActualFileSize();
  287. if (m_file->getFileSize() != fileSize) {
  288. MMKVInfo("file size has changed [%s] from %zu to %zu", m_mmapID.c_str(), m_file->getFileSize(), fileSize);
  289. clearMemoryCache();
  290. loadFromFile();
  291. } else {
  292. partialLoadFromFile();
  293. }
  294. notifyContentChanged();
  295. }
  296. }
  297. constexpr uint32_t ItemSizeHolder = 0x00ffffff;
  298. constexpr uint32_t ItemSizeHolderSize = 4;
  299. static pair<MMBuffer, size_t> prepareEncode(const MMKVMap &dic) {
  300. // make some room for placeholder
  301. size_t totalSize = ItemSizeHolderSize;
  302. for (auto &itr : dic) {
  303. auto &kvHolder = itr.second;
  304. totalSize += kvHolder.computedKVSize + kvHolder.valueSize;
  305. }
  306. return make_pair(MMBuffer(), totalSize);
  307. }
  308. #ifndef MMKV_DISABLE_CRYPT
  309. static pair<MMBuffer, size_t> prepareEncode(const MMKVMapCrypt &dic) {
  310. MMKVVector vec;
  311. size_t totalSize = 0;
  312. // make some room for placeholder
  313. uint32_t smallestOffet = 5 + 1; // 5 is the largest size needed to encode varint32
  314. for (auto &itr : dic) {
  315. auto &kvHolder = itr.second;
  316. if (kvHolder.type == KeyValueHolderType_Offset) {
  317. totalSize += kvHolder.pbKeyValueSize + kvHolder.keySize + kvHolder.valueSize;
  318. smallestOffet = min(smallestOffet, kvHolder.offset);
  319. } else {
  320. vec.emplace_back(itr.first, kvHolder.toMMBuffer(nullptr, nullptr));
  321. }
  322. }
  323. if (smallestOffet > 5) {
  324. smallestOffet = ItemSizeHolderSize;
  325. }
  326. totalSize += smallestOffet;
  327. if (vec.empty()) {
  328. return make_pair(MMBuffer(), totalSize);
  329. }
  330. auto buffer = MiniPBCoder::encodeDataWithObject(vec);
  331. // skip the pb size of buffer
  332. auto sizeOfMap = CodedInputData(buffer.getPtr(), buffer.length()).readUInt32();
  333. totalSize += sizeOfMap;
  334. return make_pair(std::move(buffer), totalSize);
  335. }
  336. #endif
  337. static pair<MMBuffer, size_t> prepareEncode(MMKVVector &&vec) {
  338. // make some room for placeholder
  339. size_t totalSize = ItemSizeHolderSize;
  340. auto buffer = MiniPBCoder::encodeDataWithObject(vec);
  341. // skip the pb size of buffer
  342. auto sizeOfMap = CodedInputData(buffer.getPtr(), buffer.length()).readUInt32();
  343. totalSize += sizeOfMap;
  344. return make_pair(std::move(buffer), totalSize);
  345. }
  346. // since we use append mode, when -[setData: forKey:] many times, space may not be enough
  347. // try a full rewrite to make space
  348. bool MMKV::ensureMemorySize(size_t newSize) {
  349. if (!isFileValid()) {
  350. MMKVWarning("[%s] file not valid", m_mmapID.c_str());
  351. return false;
  352. }
  353. if (newSize >= m_output->spaceLeft() || (m_crypter ? m_dicCrypt->empty() : m_dic->empty())) {
  354. // remove expired keys
  355. if (m_enableKeyExpire) {
  356. filterExpiredKeys();
  357. }
  358. // try a full rewrite to make space
  359. auto preparedData = m_crypter ? prepareEncode(*m_dicCrypt) : prepareEncode(*m_dic);
  360. // m_actualSize == 0 means inserting key-vakue for the first time, no need to call msync()
  361. return expandAndWriteBack(newSize, std::move(preparedData), m_actualSize > 0);
  362. }
  363. return true;
  364. }
  365. // try a full rewrite to make space
  366. bool MMKV::expandAndWriteBack(size_t newSize, std::pair<mmkv::MMBuffer, size_t> preparedData, bool needSync) {
  367. auto fileSize = m_file->getFileSize();
  368. auto sizeOfDic = preparedData.second;
  369. size_t lenNeeded = sizeOfDic + Fixed32Size + newSize;
  370. size_t nowDicCount = m_crypter ? m_dicCrypt->size() : m_dic->size();
  371. size_t laterDicCount = std::max<size_t>(1, nowDicCount + 1);
  372. // or use <cmath> ceil()
  373. size_t avgItemSize = (lenNeeded + laterDicCount - 1) / laterDicCount;
  374. size_t futureUsage = avgItemSize * std::max<size_t>(8, laterDicCount / 2);
  375. // 1. no space for a full rewrite, double it
  376. // 2. or space is not large enough for future usage, double it to avoid frequently full rewrite
  377. if (lenNeeded >= fileSize || (needSync && (lenNeeded + futureUsage) >= fileSize)) {
  378. size_t oldSize = fileSize;
  379. do {
  380. fileSize *= 2;
  381. } while (lenNeeded + futureUsage >= fileSize);
  382. MMKVInfo("extending [%s] file size from %zu to %zu, incoming size:%zu, future usage:%zu", m_mmapID.c_str(),
  383. oldSize, fileSize, newSize, futureUsage);
  384. // if we can't extend size, rollback to old state
  385. if (!m_file->truncate(fileSize)) {
  386. return false;
  387. }
  388. // check if we fail to make more space
  389. if (!isFileValid()) {
  390. MMKVWarning("[%s] file not valid", m_mmapID.c_str());
  391. return false;
  392. }
  393. }
  394. return doFullWriteBack(std::move(preparedData), nullptr, needSync);
  395. }
  396. size_t MMKV::readActualSize() {
  397. MMKV_ASSERT(m_file->getMemory());
  398. MMKV_ASSERT(m_metaFile->isFileValid());
  399. uint32_t actualSize = 0;
  400. memcpy(&actualSize, m_file->getMemory(), Fixed32Size);
  401. if (m_metaInfo->m_version >= MMKVVersionActualSize) {
  402. if (m_metaInfo->m_actualSize != actualSize) {
  403. MMKVWarning("[%s] actual size %u, meta actual size %u", m_mmapID.c_str(), actualSize,
  404. m_metaInfo->m_actualSize);
  405. }
  406. return m_metaInfo->m_actualSize;
  407. } else {
  408. return actualSize;
  409. }
  410. }
  411. void MMKV::oldStyleWriteActualSize(size_t actualSize) {
  412. MMKV_ASSERT(m_file->getMemory());
  413. m_actualSize = actualSize;
  414. #ifdef MMKV_IOS
  415. auto ret = guardForBackgroundWriting(m_file->getMemory(), Fixed32Size);
  416. if (!ret.first) {
  417. return;
  418. }
  419. #endif
  420. memcpy(m_file->getMemory(), &actualSize, Fixed32Size);
  421. }
  422. bool MMKV::writeActualSize(size_t size, uint32_t crcDigest, const void *iv, bool increaseSequence) {
  423. // backward compatibility
  424. oldStyleWriteActualSize(size);
  425. if (!m_metaFile->isFileValid()) {
  426. return false;
  427. }
  428. bool needsFullWrite = false;
  429. m_actualSize = size;
  430. m_metaInfo->m_actualSize = static_cast<uint32_t>(size);
  431. m_crcDigest = crcDigest;
  432. m_metaInfo->m_crcDigest = crcDigest;
  433. if (m_metaInfo->m_version < MMKVVersionSequence) {
  434. m_metaInfo->m_version = MMKVVersionSequence;
  435. needsFullWrite = true;
  436. }
  437. #ifndef MMKV_DISABLE_CRYPT
  438. if (unlikely(iv)) {
  439. memcpy(m_metaInfo->m_vector, iv, sizeof(m_metaInfo->m_vector));
  440. if (m_metaInfo->m_version < MMKVVersionRandomIV) {
  441. m_metaInfo->m_version = MMKVVersionRandomIV;
  442. }
  443. needsFullWrite = true;
  444. }
  445. #endif
  446. if (unlikely(increaseSequence)) {
  447. m_metaInfo->m_sequence++;
  448. m_metaInfo->m_lastConfirmedMetaInfo.lastActualSize = static_cast<uint32_t>(size);
  449. m_metaInfo->m_lastConfirmedMetaInfo.lastCRCDigest = crcDigest;
  450. if (m_metaInfo->m_version < MMKVVersionActualSize) {
  451. m_metaInfo->m_version = MMKVVersionActualSize;
  452. }
  453. needsFullWrite = true;
  454. MMKVInfo("[%s] increase sequence to %u, crc %u, actualSize %u", m_mmapID.c_str(), m_metaInfo->m_sequence,
  455. m_metaInfo->m_crcDigest, m_metaInfo->m_actualSize);
  456. }
  457. if (m_metaInfo->m_version < MMKVVersionFlag) {
  458. m_metaInfo->m_flags = 0;
  459. m_metaInfo->m_version = MMKVVersionFlag;
  460. needsFullWrite = true;
  461. }
  462. #ifdef MMKV_IOS
  463. auto ret = guardForBackgroundWriting(m_metaFile->getMemory(), sizeof(MMKVMetaInfo));
  464. if (!ret.first) {
  465. return false;
  466. }
  467. #endif
  468. if (unlikely(needsFullWrite)) {
  469. m_metaInfo->write(m_metaFile->getMemory());
  470. } else {
  471. m_metaInfo->writeCRCAndActualSizeOnly(m_metaFile->getMemory());
  472. }
  473. return true;
  474. }
  475. MMBuffer MMKV::getRawDataForKey(MMKVKey_t key) {
  476. checkLoadData();
  477. #ifndef MMKV_DISABLE_CRYPT
  478. if (m_crypter) {
  479. auto itr = m_dicCrypt->find(key);
  480. if (itr != m_dicCrypt->end()) {
  481. auto basePtr = (uint8_t *) (m_file->getMemory()) + Fixed32Size;
  482. return itr->second.toMMBuffer(basePtr, m_crypter);
  483. }
  484. } else
  485. #endif
  486. {
  487. auto itr = m_dic->find(key);
  488. if (itr != m_dic->end()) {
  489. auto basePtr = (uint8_t *) (m_file->getMemory()) + Fixed32Size;
  490. return itr->second.toMMBuffer(basePtr);
  491. }
  492. }
  493. MMBuffer nan;
  494. return nan;
  495. }
  496. mmkv::MMBuffer MMKV::getDataForKey(MMKVKey_t key) {
  497. if (unlikely(m_enableKeyExpire)) {
  498. return getDataWithoutMTimeForKey(key);
  499. }
  500. return getRawDataForKey(key);
  501. }
  502. #ifndef MMKV_DISABLE_CRYPT
  503. // for Apple watch simulator
  504. # if defined(TARGET_OS_SIMULATOR) && defined(TARGET_CPU_X86)
  505. static AESCryptStatus t_status;
  506. # else
  507. thread_local AESCryptStatus t_status;
  508. # endif
  509. #endif // MMKV_DISABLE_CRYPT
  510. bool MMKV::setDataForKey(MMBuffer &&data, MMKVKey_t key, bool isDataHolder) {
  511. if ((!isDataHolder && data.length() == 0) || isKeyEmpty(key)) {
  512. return false;
  513. }
  514. SCOPED_LOCK(m_lock);
  515. SCOPED_LOCK(m_exclusiveProcessLock);
  516. checkLoadData();
  517. #ifndef MMKV_DISABLE_CRYPT
  518. if (m_crypter) {
  519. if (isDataHolder) {
  520. auto sizeNeededForData = pbRawVarint32Size((uint32_t) data.length()) + data.length();
  521. if (!KeyValueHolderCrypt::isValueStoredAsOffset(sizeNeededForData)) {
  522. data = MiniPBCoder::encodeDataWithObject(data);
  523. isDataHolder = false;
  524. }
  525. }
  526. auto itr = m_dicCrypt->find(key);
  527. if (itr != m_dicCrypt->end()) {
  528. # ifdef MMKV_APPLE
  529. auto ret = appendDataWithKey(data, key, itr->second, isDataHolder);
  530. # else
  531. auto ret = appendDataWithKey(data, key, isDataHolder);
  532. # endif
  533. if (!ret.first) {
  534. return false;
  535. }
  536. KeyValueHolderCrypt kvHolder;
  537. if (KeyValueHolderCrypt::isValueStoredAsOffset(ret.second.valueSize)) {
  538. kvHolder = KeyValueHolderCrypt(ret.second.keySize, ret.second.valueSize, ret.second.offset);
  539. memcpy(&kvHolder.cryptStatus, &t_status, sizeof(t_status));
  540. } else {
  541. kvHolder = KeyValueHolderCrypt(std::move(data));
  542. }
  543. if (likely(!m_enableKeyExpire)) {
  544. itr->second = std::move(kvHolder);
  545. } else {
  546. itr = m_dicCrypt->find(key);
  547. if (itr != m_dicCrypt->end()) {
  548. itr->second = std::move(kvHolder);
  549. } else {
  550. // in case filterExpiredKeys() is triggered
  551. m_dicCrypt->emplace(key, std::move(kvHolder));
  552. retain_key(key);
  553. }
  554. }
  555. } else {
  556. auto ret = appendDataWithKey(data, key, isDataHolder);
  557. if (!ret.first) {
  558. return false;
  559. }
  560. if (KeyValueHolderCrypt::isValueStoredAsOffset(ret.second.valueSize)) {
  561. auto r = m_dicCrypt->emplace(
  562. key, KeyValueHolderCrypt(ret.second.keySize, ret.second.valueSize, ret.second.offset));
  563. if (r.second) {
  564. memcpy(&(r.first->second.cryptStatus), &t_status, sizeof(t_status));
  565. }
  566. } else {
  567. m_dicCrypt->emplace(key, KeyValueHolderCrypt(std::move(data)));
  568. }
  569. retain_key(key);
  570. }
  571. } else
  572. #endif // MMKV_DISABLE_CRYPT
  573. {
  574. auto itr = m_dic->find(key);
  575. if (itr != m_dic->end()) {
  576. if (likely(!m_enableKeyExpire)) {
  577. auto ret = appendDataWithKey(data, itr->second, isDataHolder);
  578. if (!ret.first) {
  579. return false;
  580. }
  581. itr->second = std::move(ret.second);
  582. } else {
  583. auto ret = appendDataWithKey(data, key, isDataHolder);
  584. if (!ret.first) {
  585. return false;
  586. }
  587. itr = m_dic->find(key);
  588. if (itr != m_dic->end()) {
  589. itr->second = std::move(ret.second);
  590. } else {
  591. // in case filterExpiredKeys() is triggered
  592. m_dic->emplace(key, std::move(ret.second));
  593. retain_key(key);
  594. }
  595. }
  596. } else {
  597. auto ret = appendDataWithKey(data, key, isDataHolder);
  598. if (!ret.first) {
  599. return false;
  600. }
  601. m_dic->emplace(key, std::move(ret.second));
  602. retain_key(key);
  603. }
  604. }
  605. m_hasFullWriteback = false;
  606. return true;
  607. }
  608. bool MMKV::removeDataForKey(MMKVKey_t key) {
  609. if (isKeyEmpty(key)) {
  610. return false;
  611. }
  612. #ifndef MMKV_DISABLE_CRYPT
  613. if (m_crypter) {
  614. auto itr = m_dicCrypt->find(key);
  615. if (itr != m_dicCrypt->end()) {
  616. m_hasFullWriteback = false;
  617. static MMBuffer nan;
  618. # ifdef MMKV_APPLE
  619. auto ret = appendDataWithKey(nan, key, itr->second);
  620. if (ret.first) {
  621. if (unlikely(m_enableKeyExpire)) {
  622. // filterExpiredKeys() may invalid itr
  623. itr = m_dicCrypt->find(key);
  624. if (itr == m_dicCrypt->end()) {
  625. return true;
  626. }
  627. }
  628. auto oldKey = itr->first;
  629. m_dicCrypt->erase(itr);
  630. [oldKey release];
  631. }
  632. # else
  633. auto ret = appendDataWithKey(nan, key);
  634. if (ret.first) {
  635. if (unlikely(m_enableKeyExpire)) {
  636. m_dicCrypt->erase(key);
  637. } else {
  638. m_dicCrypt->erase(itr);
  639. }
  640. }
  641. # endif
  642. return ret.first;
  643. }
  644. } else
  645. #endif // MMKV_DISABLE_CRYPT
  646. {
  647. auto itr = m_dic->find(key);
  648. if (itr != m_dic->end()) {
  649. m_hasFullWriteback = false;
  650. static MMBuffer nan;
  651. auto ret = likely(!m_enableKeyExpire) ? appendDataWithKey(nan, itr->second) : appendDataWithKey(nan, key);
  652. if (ret.first) {
  653. #ifdef MMKV_APPLE
  654. if (unlikely(m_enableKeyExpire)) {
  655. // filterExpiredKeys() may invalid itr
  656. itr = m_dic->find(key);
  657. if (itr == m_dic->end()) {
  658. return true;
  659. }
  660. }
  661. auto oldKey = itr->first;
  662. m_dic->erase(itr);
  663. [oldKey release];
  664. #else
  665. if (unlikely(m_enableKeyExpire)) {
  666. // filterExpiredKeys() may invalid itr
  667. m_dic->erase(key);
  668. } else {
  669. m_dic->erase(itr);
  670. }
  671. #endif
  672. }
  673. return ret.first;
  674. }
  675. }
  676. return false;
  677. }
  678. KVHolderRet_t
  679. MMKV::doAppendDataWithKey(const MMBuffer &data, const MMBuffer &keyData, bool isDataHolder, uint32_t originKeyLength) {
  680. auto isKeyEncoded = (originKeyLength < keyData.length());
  681. auto keyLength = static_cast<uint32_t>(keyData.length());
  682. auto valueLength = static_cast<uint32_t>(data.length());
  683. if (isDataHolder) {
  684. valueLength += pbRawVarint32Size(valueLength);
  685. }
  686. // size needed to encode the key
  687. size_t size = isKeyEncoded ? keyLength : (keyLength + pbRawVarint32Size(keyLength));
  688. // size needed to encode the value
  689. size += valueLength + pbRawVarint32Size(valueLength);
  690. SCOPED_LOCK(m_exclusiveProcessLock);
  691. bool hasEnoughSize = ensureMemorySize(size);
  692. if (!hasEnoughSize || !isFileValid()) {
  693. return make_pair(false, KeyValueHolder());
  694. }
  695. #ifdef MMKV_IOS
  696. auto ret = guardForBackgroundWriting(m_output->curWritePointer(), size);
  697. if (!ret.first) {
  698. return make_pair(false, KeyValueHolder());
  699. }
  700. #endif
  701. #ifndef MMKV_DISABLE_CRYPT
  702. if (m_crypter) {
  703. if (KeyValueHolderCrypt::isValueStoredAsOffset(valueLength)) {
  704. m_crypter->getCurStatus(t_status);
  705. }
  706. }
  707. #endif
  708. try {
  709. if (isKeyEncoded) {
  710. m_output->writeRawData(keyData);
  711. } else {
  712. m_output->writeData(keyData);
  713. }
  714. if (isDataHolder) {
  715. m_output->writeRawVarint32((int32_t) valueLength);
  716. }
  717. m_output->writeData(data); // note: write size of data
  718. } catch (std::exception &e) {
  719. MMKVError("%s", e.what());
  720. return make_pair(false, KeyValueHolder());
  721. }
  722. auto offset = static_cast<uint32_t>(m_actualSize);
  723. auto ptr = (uint8_t *) m_file->getMemory() + Fixed32Size + m_actualSize;
  724. #ifndef MMKV_DISABLE_CRYPT
  725. if (m_crypter) {
  726. m_crypter->encrypt(ptr, ptr, size);
  727. }
  728. #endif
  729. m_actualSize += size;
  730. updateCRCDigest(ptr, size);
  731. return make_pair(true, KeyValueHolder(originKeyLength, valueLength, offset));
  732. }
  733. KVHolderRet_t MMKV::appendDataWithKey(const MMBuffer &data, MMKVKey_t key, bool isDataHolder) {
  734. #ifdef MMKV_APPLE
  735. auto oData = [key dataUsingEncoding:NSUTF8StringEncoding];
  736. auto keyData = MMBuffer(oData, MMBufferNoCopy);
  737. #else
  738. auto keyData = MMBuffer((void *) key.data(), key.size(), MMBufferNoCopy);
  739. #endif
  740. return doAppendDataWithKey(data, keyData, isDataHolder, static_cast<uint32_t>(keyData.length()));
  741. }
  742. KVHolderRet_t MMKV::appendDataWithKey(const MMBuffer &data, const KeyValueHolder &kvHolder, bool isDataHolder) {
  743. SCOPED_LOCK(m_exclusiveProcessLock);
  744. uint32_t keyLength = kvHolder.keySize;
  745. // size needed to encode the key
  746. size_t rawKeySize = keyLength + pbRawVarint32Size(keyLength);
  747. // ensureMemorySize() might change kvHolder.offset, so have to do it early
  748. {
  749. auto valueLength = static_cast<uint32_t>(data.length());
  750. if (isDataHolder) {
  751. valueLength += pbRawVarint32Size(valueLength);
  752. }
  753. auto size = rawKeySize + valueLength + pbRawVarint32Size(valueLength);
  754. bool hasEnoughSize = ensureMemorySize(size);
  755. if (!hasEnoughSize) {
  756. return make_pair(false, KeyValueHolder());
  757. }
  758. }
  759. auto basePtr = (uint8_t *) m_file->getMemory() + Fixed32Size;
  760. MMBuffer keyData(basePtr + kvHolder.offset, rawKeySize, MMBufferNoCopy);
  761. return doAppendDataWithKey(data, keyData, isDataHolder, keyLength);
  762. }
  763. bool MMKV::fullWriteback(AESCrypt *newCrypter, bool onlyWhileExpire) {
  764. if (m_hasFullWriteback) {
  765. return true;
  766. }
  767. if (m_needLoadFromFile) {
  768. return true;
  769. }
  770. if (!isFileValid()) {
  771. MMKVWarning("[%s] file not valid", m_mmapID.c_str());
  772. return false;
  773. }
  774. if (unlikely(m_enableKeyExpire)) {
  775. auto expiredCount = filterExpiredKeys();
  776. if (onlyWhileExpire && expiredCount == 0) {
  777. return true;
  778. }
  779. }
  780. auto isEmpty = m_crypter ? m_dicCrypt->empty() : m_dic->empty();
  781. if (isEmpty) {
  782. clearAll();
  783. return true;
  784. }
  785. SCOPED_LOCK(m_exclusiveProcessLock);
  786. auto preparedData = m_crypter ? prepareEncode(*m_dicCrypt) : prepareEncode(*m_dic);
  787. auto sizeOfDic = preparedData.second;
  788. if (sizeOfDic > 0) {
  789. auto fileSize = m_file->getFileSize();
  790. if (sizeOfDic + Fixed32Size <= fileSize) {
  791. return doFullWriteBack(std::move(preparedData), newCrypter);
  792. } else {
  793. assert(0);
  794. assert(newCrypter == nullptr);
  795. // expandAndWriteBack() will extend file & full rewrite, no need to write back again
  796. auto newSize = sizeOfDic + Fixed32Size - fileSize;
  797. return expandAndWriteBack(newSize, std::move(preparedData));
  798. }
  799. }
  800. return false;
  801. }
  802. // we don't need to really serialize the dictionary, just reuse what's already in the file
  803. static void
  804. memmoveDictionary(MMKVMap &dic, CodedOutputData *output, uint8_t *ptr, AESCrypt *encrypter, size_t totalSize) {
  805. auto originOutputPtr = output->curWritePointer();
  806. // make space to hold the fake size of dictionary's serialization result
  807. auto writePtr = originOutputPtr + ItemSizeHolderSize;
  808. // reuse what's already in the file
  809. if (!dic.empty()) {
  810. // sort by offset
  811. vector<KeyValueHolder *> vec;
  812. vec.reserve(dic.size());
  813. for (auto &itr : dic) {
  814. vec.push_back(&itr.second);
  815. }
  816. sort(vec.begin(), vec.end(), [](const auto &left, const auto &right) { return left->offset < right->offset; });
  817. // merge nearby items to make memmove quicker
  818. vector<pair<uint32_t, uint32_t>> dataSections; // pair(offset, size)
  819. dataSections.emplace_back(vec.front()->offset, vec.front()->computedKVSize + vec.front()->valueSize);
  820. for (size_t index = 1, total = vec.size(); index < total; index++) {
  821. auto kvHolder = vec[index];
  822. auto &lastSection = dataSections.back();
  823. if (kvHolder->offset == lastSection.first + lastSection.second) {
  824. lastSection.second += kvHolder->computedKVSize + kvHolder->valueSize;
  825. } else {
  826. dataSections.emplace_back(kvHolder->offset, kvHolder->computedKVSize + kvHolder->valueSize);
  827. }
  828. }
  829. // do the move
  830. auto basePtr = ptr + Fixed32Size;
  831. for (auto &section : dataSections) {
  832. // memmove() should handle this well: src == dst
  833. memmove(writePtr, basePtr + section.first, section.second);
  834. writePtr += section.second;
  835. }
  836. // update offset
  837. if (!encrypter) {
  838. auto offset = ItemSizeHolderSize;
  839. for (auto kvHolder : vec) {
  840. kvHolder->offset = offset;
  841. offset += kvHolder->computedKVSize + kvHolder->valueSize;
  842. }
  843. }
  844. }
  845. // hold the fake size of dictionary's serialization result
  846. output->writeRawVarint32(ItemSizeHolder);
  847. auto writtenSize = static_cast<size_t>(writePtr - originOutputPtr);
  848. #ifndef MMKV_DISABLE_CRYPT
  849. if (encrypter) {
  850. encrypter->encrypt(originOutputPtr, originOutputPtr, writtenSize);
  851. }
  852. #endif
  853. assert(writtenSize == totalSize);
  854. output->seek(writtenSize - ItemSizeHolderSize);
  855. }
  856. #ifndef MMKV_DISABLE_CRYPT
  857. static void memmoveDictionary(MMKVMapCrypt &dic,
  858. CodedOutputData *output,
  859. uint8_t *ptr,
  860. AESCrypt *decrypter,
  861. AESCrypt *encrypter,
  862. pair<MMBuffer, size_t> &preparedData) {
  863. // reuse what's already in the file
  864. vector<KeyValueHolderCrypt *> vec;
  865. if (!dic.empty()) {
  866. // sort by offset
  867. vec.reserve(dic.size());
  868. for (auto &itr : dic) {
  869. if (itr.second.type == KeyValueHolderType_Offset) {
  870. vec.push_back(&itr.second);
  871. }
  872. }
  873. sort(vec.begin(), vec.end(), [](auto left, auto right) { return left->offset < right->offset; });
  874. }
  875. auto sizeHolder = ItemSizeHolder, sizeHolderSize = ItemSizeHolderSize;
  876. if (!vec.empty()) {
  877. auto smallestOffset = vec.front()->offset;
  878. if (smallestOffset != ItemSizeHolderSize && smallestOffset <= 5) {
  879. sizeHolderSize = smallestOffset;
  880. assert(sizeHolderSize != 0);
  881. static const uint32_t ItemSizeHolders[] = {0, 0x0f, 0xff, 0xffff, 0xffffff, 0xffffffff};
  882. sizeHolder = ItemSizeHolders[sizeHolderSize];
  883. }
  884. }
  885. output->writeRawVarint32(static_cast<int32_t>(sizeHolder));
  886. auto writePtr = output->curWritePointer();
  887. if (encrypter) {
  888. encrypter->encrypt(writePtr - sizeHolderSize, writePtr - sizeHolderSize, sizeHolderSize);
  889. }
  890. if (!vec.empty()) {
  891. // merge nearby items to make memmove quicker
  892. vector<tuple<uint32_t, uint32_t, AESCryptStatus *>> dataSections; // pair(offset, size)
  893. dataSections.push_back(vec.front()->toTuple());
  894. for (size_t index = 1, total = vec.size(); index < total; index++) {
  895. auto kvHolder = vec[index];
  896. auto &lastSection = dataSections.back();
  897. if (kvHolder->offset == get<0>(lastSection) + get<1>(lastSection)) {
  898. get<1>(lastSection) += kvHolder->pbKeyValueSize + kvHolder->keySize + kvHolder->valueSize;
  899. } else {
  900. dataSections.push_back(kvHolder->toTuple());
  901. }
  902. }
  903. // do the move
  904. auto basePtr = ptr + Fixed32Size;
  905. for (auto &section : dataSections) {
  906. auto crypter = decrypter->cloneWithStatus(*get<2>(section));
  907. crypter.decrypt(basePtr + get<0>(section), writePtr, get<1>(section));
  908. writePtr += get<1>(section);
  909. }
  910. // update offset & AESCryptStatus
  911. if (encrypter) {
  912. auto offset = sizeHolderSize;
  913. for (auto kvHolder : vec) {
  914. kvHolder->offset = offset;
  915. auto size = kvHolder->pbKeyValueSize + kvHolder->keySize + kvHolder->valueSize;
  916. encrypter->getCurStatus(kvHolder->cryptStatus);
  917. encrypter->encrypt(basePtr + offset, basePtr + offset, size);
  918. offset += size;
  919. }
  920. }
  921. }
  922. auto &data = preparedData.first;
  923. if (data.length() > 0) {
  924. auto dataSize = CodedInputData(data.getPtr(), data.length()).readUInt32();
  925. if (dataSize > 0) {
  926. auto dataPtr = (uint8_t *) data.getPtr() + pbRawVarint32Size(dataSize);
  927. if (encrypter) {
  928. encrypter->encrypt(dataPtr, writePtr, dataSize);
  929. } else {
  930. memcpy(writePtr, dataPtr, dataSize);
  931. }
  932. writePtr += dataSize;
  933. }
  934. }
  935. auto writtenSize = static_cast<size_t>(writePtr - output->curWritePointer());
  936. assert(writtenSize + sizeHolderSize == preparedData.second);
  937. output->seek(writtenSize);
  938. }
  939. # define InvalidCryptPtr ((AESCrypt *) (void *) (1))
  940. #endif // MMKV_DISABLE_CRYPT
  941. static void fullWriteBackWholeData(MMBuffer allData, size_t totalSize, CodedOutputData *output) {
  942. auto originOutputPtr = output->curWritePointer();
  943. output->writeRawVarint32(ItemSizeHolder);
  944. if (allData.length() > 0) {
  945. auto dataSize = CodedInputData(allData.getPtr(), allData.length()).readUInt32();
  946. if (dataSize > 0) {
  947. auto dataPtr = (uint8_t *)allData.getPtr() + pbRawVarint32Size(dataSize);
  948. memcpy(output->curWritePointer(), dataPtr, dataSize);
  949. output->seek(dataSize);
  950. }
  951. }
  952. [[maybe_unused]] auto writtenSize = (size_t) (output->curWritePointer() - originOutputPtr);
  953. assert(writtenSize == totalSize);
  954. }
  955. #ifndef MMKV_DISABLE_CRYPT
  956. bool MMKV::doFullWriteBack(pair<MMBuffer, size_t> prepared, AESCrypt *newCrypter, bool needSync) {
  957. auto ptr = (uint8_t *) m_file->getMemory();
  958. auto totalSize = prepared.second;
  959. #ifdef MMKV_IOS
  960. auto ret = guardForBackgroundWriting(ptr + Fixed32Size, totalSize);
  961. if (!ret.first) {
  962. return false;
  963. }
  964. #endif
  965. uint8_t newIV[AES_KEY_LEN];
  966. auto encrypter = (newCrypter == InvalidCryptPtr) ? nullptr : (newCrypter ? newCrypter : m_crypter);
  967. if (encrypter) {
  968. AESCrypt::fillRandomIV(newIV);
  969. encrypter->resetIV(newIV, sizeof(newIV));
  970. }
  971. delete m_output;
  972. m_output = new CodedOutputData(ptr + Fixed32Size, m_file->getFileSize() - Fixed32Size);
  973. if (m_crypter) {
  974. auto decrypter = m_crypter;
  975. memmoveDictionary(*m_dicCrypt, m_output, ptr, decrypter, encrypter, prepared);
  976. } else if (prepared.first.length() != 0) {
  977. auto &preparedData = prepared.first;
  978. fullWriteBackWholeData(std::move(preparedData), totalSize, m_output);
  979. if (encrypter) {
  980. encrypter->encrypt(ptr + Fixed32Size, ptr + Fixed32Size, totalSize);
  981. }
  982. } else {
  983. memmoveDictionary(*m_dic, m_output, ptr, encrypter, totalSize);
  984. }
  985. m_actualSize = totalSize;
  986. if (encrypter) {
  987. recaculateCRCDigestWithIV(newIV);
  988. } else {
  989. recaculateCRCDigestWithIV(nullptr);
  990. }
  991. m_hasFullWriteback = true;
  992. // make sure lastConfirmedMetaInfo is saved if needed
  993. if (needSync) {
  994. sync(MMKV_SYNC);
  995. }
  996. return true;
  997. }
  998. #else // MMKV_DISABLE_CRYPT
  999. bool MMKV::doFullWriteBack(pair<MMBuffer, size_t> prepared, AESCrypt *, bool needSync) {
  1000. auto ptr = (uint8_t *) m_file->getMemory();
  1001. auto totalSize = prepared.second;
  1002. #ifdef MMKV_IOS
  1003. auto ret = guardForBackgroundWriting(ptr + Fixed32Size, totalSize);
  1004. if (!ret.first) {
  1005. return false;
  1006. }
  1007. #endif
  1008. delete m_output;
  1009. m_output = new CodedOutputData(ptr + Fixed32Size, m_file->getFileSize() - Fixed32Size);
  1010. if (prepared.first.length() != 0) {
  1011. auto &preparedData = prepared.first;
  1012. fullWriteBackWholeData(std::move(preparedData), totalSize, m_output);
  1013. } else {
  1014. constexpr AESCrypt *encrypter = nullptr;
  1015. memmoveDictionary(*m_dic, m_output, ptr, encrypter, totalSize);
  1016. }
  1017. m_actualSize = totalSize;
  1018. recaculateCRCDigestWithIV(nullptr);
  1019. m_hasFullWriteback = true;
  1020. // make sure lastConfirmedMetaInfo is saved if needed
  1021. if (needSync) {
  1022. sync(MMKV_SYNC);
  1023. }
  1024. return true;
  1025. }
  1026. #endif // MMKV_DISABLE_CRYPT
  1027. #ifndef MMKV_DISABLE_CRYPT
  1028. bool MMKV::reKey(const string &cryptKey) {
  1029. SCOPED_LOCK(m_lock);
  1030. SCOPED_LOCK(m_exclusiveProcessLock);
  1031. checkLoadData();
  1032. bool ret = false;
  1033. if (m_crypter) {
  1034. if (cryptKey.length() > 0) {
  1035. string oldKey = this->cryptKey();
  1036. if (cryptKey == oldKey) {
  1037. return true;
  1038. } else {
  1039. // change encryption key
  1040. MMKVInfo("reKey with new aes key");
  1041. auto newCrypt = new AESCrypt(cryptKey.data(), cryptKey.length());
  1042. m_hasFullWriteback = false;
  1043. ret = fullWriteback(newCrypt);
  1044. if (ret) {
  1045. delete m_crypter;
  1046. m_crypter = newCrypt;
  1047. } else {
  1048. delete newCrypt;
  1049. }
  1050. }
  1051. } else {
  1052. // decryption to plain text
  1053. MMKVInfo("reKey to no aes key");
  1054. m_hasFullWriteback = false;
  1055. ret = fullWriteback(InvalidCryptPtr);
  1056. if (ret) {
  1057. delete m_crypter;
  1058. m_crypter = nullptr;
  1059. if (!m_dic) {
  1060. m_dic = new MMKVMap();
  1061. }
  1062. }
  1063. }
  1064. } else {
  1065. if (cryptKey.length() > 0) {
  1066. // transform plain text to encrypted text
  1067. MMKVInfo("reKey to a aes key");
  1068. m_hasFullWriteback = false;
  1069. auto newCrypt = new AESCrypt(cryptKey.data(), cryptKey.length());
  1070. ret = fullWriteback(newCrypt);
  1071. if (ret) {
  1072. m_crypter = newCrypt;
  1073. if (!m_dicCrypt) {
  1074. m_dicCrypt = new MMKVMapCrypt();
  1075. }
  1076. } else {
  1077. delete newCrypt;
  1078. }
  1079. } else {
  1080. return true;
  1081. }
  1082. }
  1083. // m_dic or m_dicCrypt is not valid after reKey
  1084. if (ret) {
  1085. clearMemoryCache();
  1086. }
  1087. return ret;
  1088. }
  1089. #endif
  1090. void MMKV::trim() {
  1091. SCOPED_LOCK(m_lock);
  1092. MMKVInfo("prepare to trim %s", m_mmapID.c_str());
  1093. checkLoadData();
  1094. if (m_actualSize == 0) {
  1095. clearAll();
  1096. return;
  1097. } else if (m_file->getFileSize() <= DEFAULT_MMAP_SIZE) {
  1098. return;
  1099. }
  1100. SCOPED_LOCK(m_exclusiveProcessLock);
  1101. fullWriteback();
  1102. auto oldSize = m_file->getFileSize();
  1103. auto fileSize = oldSize;
  1104. while (fileSize > (m_actualSize + Fixed32Size) * 2) {
  1105. fileSize /= 2;
  1106. }
  1107. fileSize = std::max<size_t>(fileSize, DEFAULT_MMAP_SIZE);
  1108. if (oldSize == fileSize) {
  1109. MMKVInfo("there's no need to trim %s with size %zu, actualSize %zu", m_mmapID.c_str(), fileSize, m_actualSize);
  1110. return;
  1111. }
  1112. MMKVInfo("trimming %s from %zu to %zu, actualSize %zu", m_mmapID.c_str(), oldSize, fileSize, m_actualSize);
  1113. if (!m_file->truncate(fileSize)) {
  1114. return;
  1115. }
  1116. fileSize = m_file->getFileSize();
  1117. auto ptr = (uint8_t *) m_file->getMemory();
  1118. delete m_output;
  1119. m_output = new CodedOutputData(ptr + pbFixed32Size(), fileSize - Fixed32Size);
  1120. m_output->seek(m_actualSize);
  1121. MMKVInfo("finish trim %s from %zu to %zu", m_mmapID.c_str(), oldSize, fileSize);
  1122. }
  1123. void MMKV::clearAll() {
  1124. MMKVInfo("cleaning all key-values from [%s]", m_mmapID.c_str());
  1125. SCOPED_LOCK(m_lock);
  1126. SCOPED_LOCK(m_exclusiveProcessLock);
  1127. checkLoadData();
  1128. if (m_file->getFileSize() == DEFAULT_MMAP_SIZE && m_actualSize == 0) {
  1129. MMKVInfo("nothing to clear for [%s]", m_mmapID.c_str());
  1130. return;
  1131. }
  1132. m_file->truncate(DEFAULT_MMAP_SIZE);
  1133. #ifndef MMKV_DISABLE_CRYPT
  1134. uint8_t newIV[AES_KEY_LEN];
  1135. AESCrypt::fillRandomIV(newIV);
  1136. if (m_crypter) {
  1137. m_crypter->resetIV(newIV, sizeof(newIV));
  1138. }
  1139. writeActualSize(0, 0, newIV, IncreaseSequence);
  1140. #else
  1141. writeActualSize(0, 0, nullptr, IncreaseSequence);
  1142. #endif
  1143. m_metaFile->msync(MMKV_SYNC);
  1144. clearMemoryCache();
  1145. loadFromFile();
  1146. }
  1147. bool MMKV::isFileValid(const string &mmapID, MMKVPath_t *relatePath) {
  1148. MMKVPath_t kvPath = mappedKVPathWithID(mmapID, MMKV_SINGLE_PROCESS, relatePath);
  1149. if (!isFileExist(kvPath)) {
  1150. return true;
  1151. }
  1152. MMKVPath_t crcPath = crcPathWithID(mmapID, MMKV_SINGLE_PROCESS, relatePath);
  1153. if (!isFileExist(crcPath)) {
  1154. return false;
  1155. }
  1156. uint32_t crcFile = 0;
  1157. MMBuffer *data = readWholeFile(crcPath);
  1158. if (data) {
  1159. if (data->getPtr()) {
  1160. MMKVMetaInfo metaInfo;
  1161. metaInfo.read(data->getPtr());
  1162. crcFile = metaInfo.m_crcDigest;
  1163. }
  1164. delete data;
  1165. } else {
  1166. return false;
  1167. }
  1168. uint32_t crcDigest = 0;
  1169. MMBuffer *fileData = readWholeFile(kvPath);
  1170. if (fileData) {
  1171. if (fileData->getPtr() && (fileData->length() >= Fixed32Size)) {
  1172. uint32_t actualSize = 0;
  1173. memcpy(&actualSize, fileData->getPtr(), Fixed32Size);
  1174. if (actualSize > (fileData->length() - Fixed32Size)) {
  1175. delete fileData;
  1176. return false;
  1177. }
  1178. crcDigest = (uint32_t) CRC32(0, (const uint8_t *) fileData->getPtr() + Fixed32Size, (uint32_t) actualSize);
  1179. }
  1180. delete fileData;
  1181. return crcFile == crcDigest;
  1182. } else {
  1183. return false;
  1184. }
  1185. }
  1186. // ---- auto expire ----
  1187. uint32_t MMKV::getCurrentTimeInSecond() {
  1188. auto time = ::time(nullptr);
  1189. return static_cast<uint32_t>(time);
  1190. }
  1191. bool MMKV::doFullWriteBack(MMKVVector &&vec) {
  1192. auto preparedData = prepareEncode(std::move(vec));
  1193. // must clean before write-back and after prepareEncode()
  1194. if (m_crypter) {
  1195. clearDictionary(m_dicCrypt);
  1196. } else {
  1197. clearDictionary(m_dic);
  1198. }
  1199. bool ret = false;
  1200. auto sizeOfDic = preparedData.second;
  1201. auto fileSize = m_file->getFileSize();
  1202. if (sizeOfDic + Fixed32Size <= fileSize) {
  1203. ret = doFullWriteBack(std::move(preparedData), nullptr);
  1204. } else {
  1205. // expandAndWriteBack() will extend file & full rewrite, no need to write back again
  1206. auto newSize = sizeOfDic + Fixed32Size - fileSize;
  1207. ret = expandAndWriteBack(newSize, std::move(preparedData));
  1208. }
  1209. clearMemoryCache();
  1210. return ret;
  1211. }
  1212. bool MMKV::enableAutoKeyExpire(uint32_t expiredInSeconds) {
  1213. SCOPED_LOCK(m_lock);
  1214. SCOPED_LOCK(m_exclusiveProcessLock);
  1215. checkLoadData();
  1216. if (m_expiredInSeconds != expiredInSeconds) {
  1217. MMKVInfo("expiredInSeconds: %u", expiredInSeconds);
  1218. m_expiredInSeconds = expiredInSeconds;
  1219. }
  1220. m_enableKeyExpire = true;
  1221. if (m_metaInfo->hasFlag(MMKVMetaInfo::EnableKeyExipre)) {
  1222. return true;
  1223. }
  1224. auto autoRecordExpireTime = (m_expiredInSeconds != 0);
  1225. auto time = autoRecordExpireTime ? getCurrentTimeInSecond() + m_expiredInSeconds : 0;
  1226. MMKVInfo("turn on recording expire date for all keys inside [%s] from now %u", m_mmapID.c_str(), time);
  1227. m_metaInfo->setFlag(MMKVMetaInfo::EnableKeyExipre);
  1228. m_metaInfo->m_version = MMKVVersionFlag;
  1229. if (m_file->getFileSize() == DEFAULT_MMAP_SIZE && m_actualSize == 0) {
  1230. MMKVInfo("file is new, don't need a full writeback [%s], just update meta file", m_mmapID.c_str());
  1231. writeActualSize(0, 0, nullptr, IncreaseSequence);
  1232. m_metaFile->msync(MMKV_SYNC);
  1233. return true;
  1234. }
  1235. MMKVVector vec;
  1236. auto packKeyValue = [&](const MMKVKey_t &key, const MMBuffer &value) {
  1237. MMBuffer data(value.length() + Fixed32Size);
  1238. auto ptr = (uint8_t *)data.getPtr();
  1239. memcpy(ptr, value.getPtr(), value.length());
  1240. memcpy(ptr + value.length(), &time, Fixed32Size);
  1241. vec.emplace_back(key, std::move(data));
  1242. };
  1243. auto basePtr = (uint8_t *) (m_file->getMemory()) + Fixed32Size;
  1244. #ifndef MMKV_DISABLE_CRYPT
  1245. if (m_crypter) {
  1246. for (auto &pair : *m_dicCrypt) {
  1247. auto &key = pair.first;
  1248. auto &value = pair.second;
  1249. auto buffer = value.toMMBuffer(basePtr, m_crypter);
  1250. packKeyValue(key, buffer);
  1251. }
  1252. } else
  1253. #endif
  1254. {
  1255. for (auto &pair : *m_dic) {
  1256. auto &key = pair.first;
  1257. auto &value = pair.second;
  1258. auto buffer = value.toMMBuffer(basePtr);
  1259. packKeyValue(key, buffer);
  1260. }
  1261. }
  1262. return doFullWriteBack(std::move(vec));
  1263. }
  1264. bool MMKV::disableAutoKeyExpire() {
  1265. SCOPED_LOCK(m_lock);
  1266. SCOPED_LOCK(m_exclusiveProcessLock);
  1267. checkLoadData();
  1268. m_expiredInSeconds = 0;
  1269. m_enableKeyExpire = false;
  1270. if (!m_metaInfo->hasFlag(MMKVMetaInfo::EnableKeyExipre)) {
  1271. return true;
  1272. }
  1273. MMKVInfo("erase previous recorded expire date for all keys inside [%s]", m_mmapID.c_str());
  1274. m_metaInfo->unsetFlag(MMKVMetaInfo::EnableKeyExipre);
  1275. m_metaInfo->m_version = MMKVVersionFlag;
  1276. if (m_file->getFileSize() == DEFAULT_MMAP_SIZE && m_actualSize == 0) {
  1277. MMKVInfo("file is new, don't need a full write-back [%s], just update meta file", m_mmapID.c_str());
  1278. writeActualSize(0, 0, nullptr, IncreaseSequence);
  1279. m_metaFile->msync(MMKV_SYNC);
  1280. return true;
  1281. }
  1282. MMKVVector vec;
  1283. auto packKeyValue = [&](const MMKVKey_t &key, const MMBuffer &value) {
  1284. assert(value.length() >= Fixed32Size);
  1285. MMBuffer data(value.length() - Fixed32Size);
  1286. auto ptr = (uint8_t *)data.getPtr();
  1287. memcpy(ptr, value.getPtr(), value.length() - Fixed32Size);
  1288. vec.emplace_back(key, std::move(data));
  1289. };
  1290. auto basePtr = (uint8_t *) (m_file->getMemory()) + Fixed32Size;
  1291. #ifndef MMKV_DISABLE_CRYPT
  1292. if (m_crypter) {
  1293. for (auto &pair : *m_dicCrypt) {
  1294. auto &key = pair.first;
  1295. auto &value = pair.second;
  1296. auto buffer = value.toMMBuffer(basePtr, m_crypter);
  1297. packKeyValue(key, buffer);
  1298. }
  1299. } else
  1300. #endif
  1301. {
  1302. for (auto &pair : *m_dic) {
  1303. auto &key = pair.first;
  1304. auto &value = pair.second;
  1305. auto buffer = value.toMMBuffer(basePtr);
  1306. packKeyValue(key, buffer);
  1307. }
  1308. }
  1309. return doFullWriteBack(std::move(vec));
  1310. }
  1311. uint32_t MMKV::getExpireTimeForKey(MMKVKey_t key) {
  1312. SCOPED_LOCK(m_lock);
  1313. SCOPED_LOCK(m_sharedProcessLock);
  1314. checkLoadData();
  1315. if (!m_enableKeyExpire || key_length(key) == 0) {
  1316. return 0;
  1317. }
  1318. auto raw = getRawDataForKey(key);
  1319. assert(raw.length() == 0 || raw.length() >= Fixed32Size);
  1320. if (raw.length() < Fixed32Size) {
  1321. return 0;
  1322. }
  1323. auto ptr = (const uint8_t *)raw.getPtr() + raw.length() - Fixed32Size;
  1324. auto time = *(const uint32_t *)ptr;
  1325. return time;
  1326. }
  1327. mmkv::MMBuffer MMKV::getDataWithoutMTimeForKey(MMKVKey_t key) {
  1328. SCOPED_LOCK(m_lock);
  1329. SCOPED_LOCK(m_sharedProcessLock);
  1330. checkLoadData();
  1331. auto raw = getRawDataForKey(key);
  1332. assert(raw.length() == 0 || raw.length() >= Fixed32Size);
  1333. if (raw.length() < Fixed32Size) {
  1334. return raw;
  1335. }
  1336. auto newLength = raw.length() - Fixed32Size;
  1337. if (m_enableKeyExpire) {
  1338. auto ptr = (const uint8_t *)raw.getPtr() + newLength;
  1339. auto time = *(const uint32_t *)ptr;
  1340. if (time != ExpireNever && time <= getCurrentTimeInSecond()) {
  1341. #ifdef MMKV_APPLE
  1342. MMKVInfo("deleting expired key [%@] in mmkv [%s], due date %u", key, m_mmapID.c_str(), time);
  1343. #else
  1344. MMKVInfo("deleting expired key [%s] in mmkv [%s], due date %u", key.c_str(), m_mmapID.c_str(), time);
  1345. #endif
  1346. removeValueForKey(key);
  1347. return MMBuffer();
  1348. }
  1349. }
  1350. return MMBuffer(std::move(raw), newLength);
  1351. }
  1352. #define NOOP ((void)0)
  1353. size_t MMKV::filterExpiredKeys() {
  1354. if (!m_enableKeyExpire || (m_crypter ? m_dicCrypt->empty() : m_dic->empty())) {
  1355. return 0;
  1356. }
  1357. SCOPED_LOCK(m_sharedProcessLock);
  1358. auto now = getCurrentTimeInSecond();
  1359. MMKVInfo("filtering expired keys inside [%s] now: %u, m_expiredInSeconds: %u", m_mmapID.c_str(), now, m_expiredInSeconds);
  1360. size_t count = 0;
  1361. auto basePtr = (uint8_t *)(m_file->getMemory()) + Fixed32Size;
  1362. #ifndef MMKV_DISABLE_CRYPT
  1363. if (m_crypter) {
  1364. for (auto itr = m_dicCrypt->begin(); itr != m_dicCrypt->end(); NOOP) {
  1365. auto &kvHolder = itr->second;
  1366. assert(kvHolder.realValueSize() >= Fixed32Size);
  1367. auto buffer = kvHolder.toMMBuffer(basePtr, m_crypter);
  1368. auto ptr = (uint8_t*) buffer.getPtr();
  1369. ptr += buffer.length() - Fixed32Size;
  1370. auto time = *(const uint32_t *)ptr;
  1371. if (time != ExpireNever && time <= now) {
  1372. auto oldKey = itr->first;
  1373. itr = m_dicCrypt->erase(itr);
  1374. #ifdef MMKV_APPLE
  1375. MMKVInfo("deleting expired key [%@], due date %u", oldKey, time);
  1376. [oldKey release];
  1377. #else
  1378. MMKVInfo("deleting expired key [%s], due date %u", oldKey.c_str(), time);
  1379. #endif
  1380. count++;
  1381. } else {
  1382. itr++;
  1383. }
  1384. }
  1385. } else
  1386. #endif // !MMKV_DISABLE_CRYPT
  1387. {
  1388. for (auto itr = m_dic->begin(); itr != m_dic->end(); NOOP) {
  1389. auto &kvHolder = itr->second;
  1390. assert(kvHolder.valueSize >= Fixed32Size);
  1391. auto ptr = basePtr + kvHolder.offset + kvHolder.computedKVSize;
  1392. ptr += kvHolder.valueSize - Fixed32Size;
  1393. auto time = *(const uint32_t *)ptr;
  1394. if (time != ExpireNever && time <= now) {
  1395. auto oldKey = itr->first;
  1396. itr = m_dic->erase(itr);
  1397. #ifdef MMKV_APPLE
  1398. MMKVInfo("deleting expired key [%@], due date %u", oldKey, time);
  1399. [oldKey release];
  1400. #else
  1401. MMKVInfo("deleting expired key [%s], due date %u", oldKey.c_str(), time);
  1402. #endif
  1403. count++;
  1404. } else {
  1405. itr++;
  1406. }
  1407. }
  1408. }
  1409. if (count != 0) {
  1410. MMKVInfo("deleted %zu expired keys inside [%s]", count, m_mmapID.c_str());
  1411. }
  1412. return count;
  1413. }
  1414. MMKV_NAMESPACE_END