1 //===-- ConstString.cpp -----------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
9 #include "lldb/Core/ConstString.h"
10 #include "lldb/Core/Stream.h"
11 #include "lldb/Host/Mutex.h"
12 #include "llvm/ADT/StringMap.h"
16 using namespace lldb_private;
22 typedef const char * StringPoolValueType;
23 typedef llvm::StringMap<StringPoolValueType, llvm::BumpPtrAllocator> StringPool;
24 typedef llvm::StringMapEntry<StringPoolValueType> StringPoolEntryType;
26 //------------------------------------------------------------------
27 // Default constructor
29 // Initialize the member variables and create the empty string.
30 //------------------------------------------------------------------
32 m_mutex (Mutex::eMutexTypeRecursive),
37 //------------------------------------------------------------------
39 //------------------------------------------------------------------
45 static StringPoolEntryType &
46 GetStringMapEntryFromKeyData (const char *keyData)
48 char *ptr = const_cast<char*>(keyData) - sizeof (StringPoolEntryType);
49 return *reinterpret_cast<StringPoolEntryType*>(ptr);
53 GetConstCStringLength (const char *ccstr) const
57 const StringPoolEntryType&entry = GetStringMapEntryFromKeyData (ccstr);
58 return entry.getKey().size();
64 GetMangledCounterpart (const char *ccstr) const
67 return GetStringMapEntryFromKeyData (ccstr).getValue();
72 SetMangledCounterparts (const char *key_ccstr, const char *value_ccstr)
74 if (key_ccstr && value_ccstr)
76 GetStringMapEntryFromKeyData (key_ccstr).setValue(value_ccstr);
77 GetStringMapEntryFromKeyData (value_ccstr).setValue(key_ccstr);
84 GetConstCString (const char *cstr)
87 return GetConstCStringWithLength (cstr, strlen (cstr));
92 GetConstCStringWithLength (const char *cstr, size_t cstr_len)
96 Mutex::Locker locker (m_mutex);
97 llvm::StringRef string_ref (cstr, cstr_len);
98 StringPoolEntryType& entry = *m_string_map.insert (std::make_pair (string_ref, (StringPoolValueType)NULL)).first;
99 return entry.getKeyData();
105 GetConstCStringWithStringRef (const llvm::StringRef &string_ref)
107 if (string_ref.data())
109 Mutex::Locker locker (m_mutex);
110 StringPoolEntryType& entry = *m_string_map.insert (std::make_pair (string_ref, (StringPoolValueType)NULL)).first;
111 return entry.getKeyData();
117 GetConstCStringAndSetMangledCounterPart (const char *demangled_cstr, const char *mangled_ccstr)
121 Mutex::Locker locker (m_mutex);
122 // Make string pool entry with the mangled counterpart already set
123 StringPoolEntryType& entry = *m_string_map.insert (std::make_pair (llvm::StringRef (demangled_cstr), mangled_ccstr)).first;
125 // Extract the const version of the demangled_cstr
126 const char *demangled_ccstr = entry.getKeyData();
127 // Now assign the demangled const string as the counterpart of the
128 // mangled const string...
129 GetStringMapEntryFromKeyData (mangled_ccstr).setValue(demangled_ccstr);
130 // Return the constant demangled C string
131 return demangled_ccstr;
137 GetConstTrimmedCStringWithLength (const char *cstr, size_t cstr_len)
141 const size_t trimmed_len = std::min<size_t> (strlen (cstr), cstr_len);
142 return GetConstCStringWithLength (cstr, trimmed_len);
147 //------------------------------------------------------------------
148 // Return the size in bytes that this object and any items in its
149 // collection of uniqued strings + data count values takes in
151 //------------------------------------------------------------------
155 Mutex::Locker locker (m_mutex);
156 size_t mem_size = sizeof(Pool);
157 const_iterator end = m_string_map.end();
158 for (const_iterator pos = m_string_map.begin(); pos != end; ++pos)
160 mem_size += sizeof(StringPoolEntryType) + pos->getKey().size();
166 //------------------------------------------------------------------
168 //------------------------------------------------------------------
169 typedef StringPool::iterator iterator;
170 typedef StringPool::const_iterator const_iterator;
172 //------------------------------------------------------------------
174 //------------------------------------------------------------------
175 mutable Mutex m_mutex;
176 StringPool m_string_map;
179 //----------------------------------------------------------------------
180 // Frameworks and dylibs aren't supposed to have global C++
181 // initializers so we hide the string pool in a static function so
182 // that it will get initialized on the first call to this static
185 // Note, for now we make the string pool a pointer to the pool, because
186 // we can't guarantee that some objects won't get destroyed after the
187 // global destructor chain is run, and trying to make sure no destructors
188 // touch ConstStrings is difficult. So we leak the pool instead.
189 //----------------------------------------------------------------------
193 static std::once_flag g_pool_initialization_flag;
194 static Pool *g_string_pool = NULL;
196 std::call_once(g_pool_initialization_flag, [] () {
197 g_string_pool = new Pool();
200 return *g_string_pool;
203 ConstString::ConstString (const char *cstr) :
204 m_string (StringPool().GetConstCString (cstr))
208 ConstString::ConstString (const char *cstr, size_t cstr_len) :
209 m_string (StringPool().GetConstCStringWithLength (cstr, cstr_len))
213 ConstString::ConstString (const llvm::StringRef &s) :
214 m_string (StringPool().GetConstCStringWithLength (s.data(), s.size()))
219 ConstString::operator < (const ConstString& rhs) const
221 if (m_string == rhs.m_string)
224 llvm::StringRef lhs_string_ref (m_string, StringPool().GetConstCStringLength (m_string));
225 llvm::StringRef rhs_string_ref (rhs.m_string, StringPool().GetConstCStringLength (rhs.m_string));
227 // If both have valid C strings, then return the comparison
228 if (lhs_string_ref.data() && rhs_string_ref.data())
229 return lhs_string_ref < rhs_string_ref;
231 // Else one of them was NULL, so if LHS is NULL then it is less than
232 return lhs_string_ref.data() == NULL;
236 lldb_private::operator << (Stream& s, const ConstString& str)
238 const char *cstr = str.GetCString();
246 ConstString::GetLength () const
248 return StringPool().GetConstCStringLength (m_string);
252 ConstString::Compare (const ConstString& lhs, const ConstString& rhs)
254 // If the iterators are the same, this is the same string
255 const char *lhs_cstr = lhs.m_string;
256 const char *rhs_cstr = rhs.m_string;
257 if (lhs_cstr == rhs_cstr)
259 if (lhs_cstr && rhs_cstr)
261 llvm::StringRef lhs_string_ref (lhs_cstr, StringPool().GetConstCStringLength (lhs_cstr));
262 llvm::StringRef rhs_string_ref (rhs_cstr, StringPool().GetConstCStringLength (rhs_cstr));
263 return lhs_string_ref.compare(rhs_string_ref);
267 return +1; // LHS isn't NULL but RHS is
269 return -1; // LHS is NULL but RHS isn't
273 ConstString::Dump(Stream *s, const char *fail_value) const
277 const char *cstr = AsCString (fail_value);
279 s->PutCString (cstr);
284 ConstString::DumpDebug(Stream *s) const
286 const char *cstr = GetCString ();
287 size_t cstr_len = GetLength();
288 // Only print the parens if we have a non-NULL string
289 const char *parens = cstr ? "\"" : "";
290 s->Printf("%*p: ConstString, string = %s%s%s, length = %" PRIu64,
291 static_cast<int>(sizeof(void*) * 2),
292 static_cast<const void*>(this), parens, cstr, parens,
293 static_cast<uint64_t>(cstr_len));
297 ConstString::SetCString (const char *cstr)
299 m_string = StringPool().GetConstCString (cstr);
303 ConstString::SetString (const llvm::StringRef &s)
305 m_string = StringPool().GetConstCStringWithLength (s.data(), s.size());
309 ConstString::SetCStringWithMangledCounterpart (const char *demangled, const ConstString &mangled)
311 m_string = StringPool().GetConstCStringAndSetMangledCounterPart (demangled, mangled.m_string);
315 ConstString::GetMangledCounterpart (ConstString &counterpart) const
317 counterpart.m_string = StringPool().GetMangledCounterpart(m_string);
318 return (bool)counterpart;
322 ConstString::SetCStringWithLength (const char *cstr, size_t cstr_len)
324 m_string = StringPool().GetConstCStringWithLength(cstr, cstr_len);
328 ConstString::SetTrimmedCStringWithLength (const char *cstr, size_t cstr_len)
330 m_string = StringPool().GetConstTrimmedCStringWithLength (cstr, cstr_len);
334 ConstString::StaticMemorySize()
336 // Get the size of the static string pool
337 return StringPool().MemorySize();