mirror of
https://github.com/mozilla/gecko-dev.git
synced 2025-02-26 12:20:56 +00:00

This class implements a shared memory key-value store that fits into a single memory mapped segment. All of the runtime data for its instances are stored in the shared memory region, which means that memory overhead for each instance in each process is only a few bytes. Importantly, the key and value strings returned by this class are also pointers into the shared memory region, which means that once an instance is created, its memory cannot be unmapped until process shutdown. For the uses I intend to put it to, this is a reasonable constraint. If we need to use it for shorter-lived maps in the future, we can add an option to return non-literal dependent strings that will be copied if they need to be kept alive long term. MozReview-Commit-ID: 5BwAaDsb7HS --HG-- extra : rebase_source : b472fe628018f88a2c4d6b3de4b7143aeca55e14 extra : absorb_source : 5cdeb568cfd2b4a5a767191402e699e61e653b3b
159 lines
3.8 KiB
C++
159 lines
3.8 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* vim: set ts=8 sts=4 et sw=4 tw=99: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "SharedStringMap.h"
|
|
|
|
#include "MemMapSnapshot.h"
|
|
#include "ScriptPreloader-inl.h"
|
|
|
|
#include "mozilla/BinarySearch.h"
|
|
#include "mozilla/ipc/FileDescriptor.h"
|
|
|
|
using namespace mozilla::loader;
|
|
|
|
namespace mozilla {
|
|
|
|
using namespace ipc;
|
|
|
|
namespace dom {
|
|
namespace ipc {
|
|
|
|
static inline size_t
|
|
GetAlignmentOffset(size_t aOffset, size_t aAlign)
|
|
{
|
|
auto mod = aOffset % aAlign;
|
|
return mod ? aAlign - mod : 0;
|
|
}
|
|
|
|
|
|
SharedStringMap::SharedStringMap(const FileDescriptor& aMapFile, size_t aMapSize)
|
|
{
|
|
auto result = mMap.initWithHandle(aMapFile, aMapSize);
|
|
MOZ_RELEASE_ASSERT(result.isOk());
|
|
// We return literal nsStrings and nsCStrings pointing to the mapped data,
|
|
// which means that we may still have references to the mapped data even
|
|
// after this instance is destroyed. That means that we need to keep the
|
|
// mapping alive until process shutdown, in order to be safe.
|
|
mMap.setPersistent();
|
|
}
|
|
|
|
SharedStringMap::SharedStringMap(SharedStringMapBuilder&& aBuilder)
|
|
{
|
|
auto result = aBuilder.Finalize(mMap);
|
|
MOZ_RELEASE_ASSERT(result.isOk());
|
|
mMap.setPersistent();
|
|
}
|
|
|
|
mozilla::ipc::FileDescriptor
|
|
SharedStringMap::CloneFileDescriptor() const
|
|
{
|
|
return mMap.cloneHandle();
|
|
}
|
|
|
|
bool
|
|
SharedStringMap::Has(const nsCString& aKey)
|
|
{
|
|
size_t index;
|
|
return Find(aKey, &index);
|
|
}
|
|
|
|
bool
|
|
SharedStringMap::Get(const nsCString& aKey, nsAString& aValue)
|
|
{
|
|
const auto& entries = Entries();
|
|
|
|
size_t index;
|
|
if (!Find(aKey, &index)) {
|
|
return false;
|
|
}
|
|
|
|
aValue.Assign(ValueTable().Get(entries[index].mValue));
|
|
return true;
|
|
}
|
|
|
|
bool
|
|
SharedStringMap::Find(const nsCString& aKey, size_t* aIndex)
|
|
{
|
|
const auto& keys = KeyTable();
|
|
|
|
return BinarySearchIf(Entries(), 0, EntryCount(),
|
|
[&] (const Entry& aEntry) {
|
|
return aKey.Compare(keys.GetBare(aEntry.mKey));
|
|
},
|
|
aIndex);
|
|
}
|
|
|
|
|
|
void
|
|
SharedStringMapBuilder::Add(const nsCString& aKey, const nsString& aValue)
|
|
{
|
|
mEntries.Put(aKey, {{mKeyTable.Add(aKey), aKey.Length()},
|
|
{mValueTable.Add(aValue), aValue.Length()}});
|
|
}
|
|
|
|
Result<Ok, nsresult>
|
|
SharedStringMapBuilder::Finalize(loader::AutoMemMap& aMap)
|
|
{
|
|
using Header = SharedStringMap::Header;
|
|
|
|
MOZ_ASSERT(mEntries.Count() == mKeyTable.Count());
|
|
|
|
nsTArray<nsCString> keys(mEntries.Count());
|
|
for (auto iter = mEntries.Iter(); !iter.Done(); iter.Next()) {
|
|
keys.AppendElement(iter.Key());
|
|
}
|
|
keys.Sort();
|
|
|
|
|
|
Header header = {uint32_t(keys.Length())};
|
|
|
|
size_t offset = sizeof(header);
|
|
offset += GetAlignmentOffset(offset, alignof(Header));
|
|
|
|
offset += keys.Length() * sizeof(SharedStringMap::Entry);
|
|
|
|
header.mKeyStringsOffset = offset;
|
|
header.mKeyStringsSize = mKeyTable.Size();
|
|
|
|
offset += header.mKeyStringsSize;
|
|
offset += GetAlignmentOffset(offset, alignof(decltype(mValueTable)::ElemType));
|
|
|
|
header.mValueStringsOffset = offset;
|
|
header.mValueStringsSize = mValueTable.Size();
|
|
|
|
offset += header.mValueStringsSize;
|
|
|
|
|
|
MemMapSnapshot mem;
|
|
MOZ_TRY(mem.Init(offset));
|
|
|
|
auto headerPtr = mem.Get<Header>();
|
|
headerPtr[0] = header;
|
|
|
|
auto* entry = reinterpret_cast<Entry*>(&headerPtr[1]);
|
|
for (auto& key : keys) {
|
|
*entry++ = mEntries.Get(key);
|
|
}
|
|
|
|
auto ptr = mem.Get<uint8_t>();
|
|
|
|
mKeyTable.Write({ &ptr[header.mKeyStringsOffset],
|
|
header.mKeyStringsSize });
|
|
|
|
mValueTable.Write({ &ptr[header.mValueStringsOffset],
|
|
header.mValueStringsSize });
|
|
|
|
mKeyTable.Clear();
|
|
mValueTable.Clear();
|
|
mEntries.Clear();
|
|
|
|
return mem.Finalize(aMap);
|
|
}
|
|
|
|
} // ipc
|
|
} // dom
|
|
} // mozilla
|