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
|
//===------- string_pool.h - Thread-safe pool for strings -------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// Contains a thread-safe string pool. Strings are ref-counted, but not
// automatically deallocated. Unused entries can be cleared by calling
// StringPool::clearDeadEntries.
//
//===----------------------------------------------------------------------===//
#ifndef ORC_RT_STRING_POOL_H
#define ORC_RT_STRING_POOL_H
#include <atomic>
#include <cassert>
#include <functional>
#include <mutex>
#include <string>
#include <unordered_map>
namespace __orc_rt {
class PooledStringPtr;
/// String pool for strings names used by the ORC runtime.
class StringPool {
friend class PooledStringPtr;
public:
/// Destroy a StringPool.
~StringPool();
/// Create a string pointer from the given string.
PooledStringPtr intern(std::string S);
/// Remove from the pool any entries that are no longer referenced.
void clearDeadEntries();
/// Returns true if the pool is empty.
bool empty() const;
private:
using RefCountType = std::atomic<size_t>;
using PoolMap = std::unordered_map<std::string, RefCountType>;
using PoolMapEntry = PoolMap::value_type;
mutable std::mutex PoolMutex;
PoolMap Pool;
};
/// Pointer to a pooled string.
class PooledStringPtr {
friend class StringPool;
friend struct std::hash<PooledStringPtr>;
public:
PooledStringPtr() = default;
PooledStringPtr(std::nullptr_t) {}
PooledStringPtr(const PooledStringPtr &Other) : S(Other.S) {
if (S)
++S->second;
}
PooledStringPtr &operator=(const PooledStringPtr &Other) {
if (S) {
assert(S->second && "Releasing PooledStringPtr with zero ref count");
--S->second;
}
S = Other.S;
if (S)
++S->second;
return *this;
}
PooledStringPtr(PooledStringPtr &&Other) : S(nullptr) {
std::swap(S, Other.S);
}
PooledStringPtr &operator=(PooledStringPtr &&Other) {
if (S) {
assert(S->second && "Releasing PooledStringPtr with zero ref count");
--S->second;
}
S = nullptr;
std::swap(S, Other.S);
return *this;
}
~PooledStringPtr() {
if (S) {
assert(S->second && "Releasing PooledStringPtr with zero ref count");
--S->second;
}
}
explicit operator bool() const { return S; }
const std::string &operator*() const { return S->first; }
friend bool operator==(const PooledStringPtr &LHS,
const PooledStringPtr &RHS) {
return LHS.S == RHS.S;
}
friend bool operator!=(const PooledStringPtr &LHS,
const PooledStringPtr &RHS) {
return !(LHS == RHS);
}
friend bool operator<(const PooledStringPtr &LHS,
const PooledStringPtr &RHS) {
return LHS.S < RHS.S;
}
private:
using PoolEntry = StringPool::PoolMapEntry;
using PoolEntryPtr = PoolEntry *;
PooledStringPtr(StringPool::PoolMapEntry *S) : S(S) {
if (S)
++S->second;
}
PoolEntryPtr S = nullptr;
};
inline StringPool::~StringPool() {
#ifndef NDEBUG
clearDeadEntries();
assert(Pool.empty() && "Dangling references at pool destruction time");
#endif // NDEBUG
}
inline PooledStringPtr StringPool::intern(std::string S) {
std::lock_guard<std::mutex> Lock(PoolMutex);
PoolMap::iterator I;
bool Added;
std::tie(I, Added) = Pool.try_emplace(std::move(S), 0);
return PooledStringPtr(&*I);
}
inline void StringPool::clearDeadEntries() {
std::lock_guard<std::mutex> Lock(PoolMutex);
for (auto I = Pool.begin(), E = Pool.end(); I != E;) {
auto Tmp = I++;
if (Tmp->second == 0)
Pool.erase(Tmp);
}
}
inline bool StringPool::empty() const {
std::lock_guard<std::mutex> Lock(PoolMutex);
return Pool.empty();
}
} // end namespace __orc_rt
namespace std {
// Make PooledStringPtrs hashable.
template <> struct hash<__orc_rt::PooledStringPtr> {
size_t operator()(const __orc_rt::PooledStringPtr &A) const {
return hash<__orc_rt::PooledStringPtr::PoolEntryPtr>()(A.S);
}
};
} // namespace std
#endif // ORC_RT_REF_COUNTED_STRING_POOL_H
|