Tools/lldb/lldb_webkit.py

   1 # Copyright (C) 2012 Apple. All rights reserved.
   2 #
   3 # Redistribution and use in source and binary forms, with or without
   4 # modification, are permitted provided that the following conditions
   5 # are met:
   6 # 1.  Redistributions of source code must retain the above copyright
   7 #     notice, this list of conditions and the following disclaimer.
   8 # 2.  Redistributions in binary form must reproduce the above copyright
   9 #     notice, this list of conditions and the following disclaimer in the
  10 #     documentation and/or other materials provided with the distribution.
  11 #
  12 # THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
  13 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  14 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  15 # DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  16 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  17 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  18 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  19 # ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  20 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  21 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  22
  23 """
  24     LLDB Support for WebKit Types
  25
  26     Add the following to your .lldbinit file to add WebKit Type summaries in LLDB and Xcode:
  27
  28     command script import {Path to WebKit Root}/Tools/lldb/lldb_webkit.py
  29
  30 """
  31
  32 import lldb
  33 import struct
  34
  35 def __lldb_init_module(debugger, dict):
  36     debugger.HandleCommand('type summary add --expand -F lldb_webkit.WTFString_SummaryProvider WTF::String')
  37     debugger.HandleCommand('type summary add --expand -F lldb_webkit.WTFStringImpl_SummaryProvider WTF::StringImpl')
  38     debugger.HandleCommand('type summary add --expand -F lldb_webkit.WTFAtomicString_SummaryProvider WTF::AtomicString')
  39     debugger.HandleCommand('type summary add --expand -F lldb_webkit.WTFVector_SummaryProvider -x "WTF::Vector<.+>$"')
  40     debugger.HandleCommand('type summary add --expand -F lldb_webkit.WTFHashTable_SummaryProvider -x "WTF::HashTable<.+>$"')
  41     debugger.HandleCommand('type synthetic add -x "WTF::Vector<.+>$" --python-class lldb_webkit.WTFVectorProvider')
  42     debugger.HandleCommand('type synthetic add -x "WTF::HashTable<.+>$" --python-class lldb_webkit.WTFHashTableProvider')
  43
  44 def WTFString_SummaryProvider(valobj, dict):
  45     provider = WTFStringProvider(valobj, dict)
  46     return "{ length = %d, contents = '%s' }" % (provider.get_length(), provider.to_string())
  47
  48
  49 def WTFStringImpl_SummaryProvider(valobj, dict):
  50     provider = WTFStringImplProvider(valobj, dict)
  51     return "{ length = %d, is8bit = %d, contents = '%s' }" % (provider.get_length(), provider.is_8bit(), provider.to_string())
  52
  53
  54 def WTFAtomicString_SummaryProvider(valobj, dict):
  55     return WTFString_SummaryProvider(valobj.GetChildMemberWithName('m_string'), dict)
  56
  57
  58 def WTFVector_SummaryProvider(valobj, dict):
  59     provider = WTFVectorProvider(valobj, dict)
  60     return "{ size = %d, capacity = %d }" % (provider.size, provider.capacity)
  61
  62
  63 def WTFHashTable_SummaryProvider(valobj, dict):
  64     provider = WTFHashTableProvider(valobj, dict)
  65     return "{ tableSize = %d, keyCount = %d }" % (provider.tableSize(), provider.keyCount())
  66
  67 # FIXME: Provide support for the following types:
  68 # def WTFVector_SummaryProvider(valobj, dict):
  69 # def WTFCString_SummaryProvider(valobj, dict):
  70 # def WebCoreKURLGooglePrivate_SummaryProvider(valobj, dict):
  71 # def WebCoreQualifiedName_SummaryProvider(valobj, dict):
  72 # def JSCIdentifier_SummaryProvider(valobj, dict):
  73 # def JSCJSString_SummaryProvider(valobj, dict):
  74
  75
  76 def guess_string_length(valobj, charSize, error):
  77     if not valobj.GetValue():
  78         return 0
  79
  80     maxLength = 256
  81
  82     pointer = valobj.GetValueAsUnsigned()
  83     contents = valobj.GetProcess().ReadMemory(pointer, maxLength * charSize, lldb.SBError())
  84     format = 'B' if charSize == 1 else 'H'
  85
  86     for i in xrange(0, maxLength):
  87         if not struct.unpack_from(format, contents, i * charSize)[0]:
  88             return i
  89
  90     return maxLength
  91
  92 def ustring_to_string(valobj, error, length=None):
  93     if length is None:
  94         length = guess_string_length(valobj, 2, error)
  95     else:
  96         length = int(length)
  97
  98     pointer = valobj.GetValueAsUnsigned()
  99     contents = valobj.GetProcess().ReadMemory(pointer, length * 2, lldb.SBError())
 100
 101     # lldb does not (currently) support returning unicode from python summary providers,
 102     # so potentially convert this to ascii by escaping
 103     string = contents.decode('utf16')
 104     try:
 105         return str(string)
 106     except:
 107         return string.encode('unicode_escape')
 108
 109 def lstring_to_string(valobj, error, length=None):
 110     if length is None:
 111         length = guess_string_length(valobj, 1, error)
 112     else:
 113         length = int(length)
 114
 115     pointer = valobj.GetValueAsUnsigned()
 116     contents = valobj.GetProcess().ReadMemory(pointer, length, lldb.SBError())
 117
 118     # lldb does not (currently) support returning unicode from python summary providers,
 119     # so potentially convert this to ascii by escaping
 120     string = contents.decode('utf8')
 121     try:
 122         return str(string)
 123     except:
 124         return string.encode('unicode_escape')
 125
 126 class WTFStringImplProvider:
 127     def __init__(self, valobj, dict):
 128         self.valobj = valobj
 129
 130     def get_length(self):
 131         return self.valobj.GetChildMemberWithName('m_length').GetValueAsUnsigned(0)
 132
 133     def get_data8(self):
 134         return self.valobj.GetChildAtIndex(2).GetChildMemberWithName('m_data8')
 135
 136     def get_data16(self):
 137         return self.valobj.GetChildAtIndex(2).GetChildMemberWithName('m_data16')
 138
 139     def to_string(self):
 140         error = lldb.SBError()
 141         if self.is_8bit():
 142             return lstring_to_string(self.get_data8(), error, self.get_length())
 143         return ustring_to_string(self.get_data16(), error, self.get_length())
 144
 145     def is_8bit(self):
 146         # FIXME: find a way to access WTF::StringImpl::s_hashFlag8BitBuffer
 147         return bool(self.valobj.GetChildMemberWithName('m_hashAndFlags').GetValueAsUnsigned(0) \
 148             & 1 << 6)
 149
 150
 151 class WTFStringProvider:
 152     def __init__(self, valobj, dict):
 153         self.valobj = valobj
 154
 155     def stringimpl(self):
 156         impl_ptr = self.valobj.GetChildMemberWithName('m_impl').GetChildMemberWithName('m_ptr')
 157         return WTFStringImplProvider(impl_ptr, dict)
 158
 159     def get_length(self):
 160         impl = self.stringimpl()
 161         if not impl:
 162             return 0
 163         return impl.get_length()
 164
 165     def to_string(self):
 166         impl = self.stringimpl()
 167         if not impl:
 168             return u""
 169         return impl.to_string()
 170
 171
 172 class WTFVectorProvider:
 173     def __init__(self, valobj, internal_dict):
 174         self.valobj = valobj
 175         self.update()
 176
 177     def num_children(self):
 178         return self.size + 3
 179
 180     def get_child_index(self, name):
 181         if name == "m_size":
 182             return self.size
 183         elif name == "m_capacity":
 184             return self.size + 1
 185         elif name == "m_buffer":
 186             return self.size + 2
 187         else:
 188             return int(name.lstrip('[').rstrip(']'))
 189
 190     def get_child_at_index(self, index):
 191         if index == self.size:
 192             return self.valobj.GetChildMemberWithName("m_size")
 193         elif index == self.size + 1:
 194             return self.valobj.GetChildMemberWithName("m_capacity")
 195         elif index == self.size + 2:
 196             return self.buffer
 197         elif index < self.size:
 198             offset = index * self.data_size
 199             child = self.buffer.CreateChildAtOffset('[' + str(index) + ']', offset, self.data_type)
 200             return child
 201         else:
 202             return None
 203
 204     def update(self):
 205         self.buffer = self.valobj.GetChildMemberWithName('m_buffer')
 206         self.size = self.valobj.GetChildMemberWithName('m_size').GetValueAsUnsigned(0)
 207         self.capacity = self.buffer.GetChildMemberWithName('m_capacity').GetValueAsUnsigned(0)
 208         self.data_type = self.buffer.GetType().GetPointeeType()
 209         self.data_size = self.data_type.GetByteSize()
 210
 211     def has_children(self):
 212         return True
 213
 214
 215 class WTFHashTableProvider:
 216     def __init__(self, valobj, internal_dict):
 217         self.valobj = valobj
 218         self.update()
 219
 220     def num_children(self):
 221         return self.tableSize() + 5
 222
 223     def get_child_index(self, name):
 224         if name == "m_table":
 225             return self.tableSize()
 226         elif name == "m_tableSize":
 227             return self.tableSize() + 1
 228         elif name == "m_tableSizeMask":
 229             return self.tableSize() + 2
 230         elif name == "m_keyCount":
 231             return self.tableSize() + 3
 232         elif name == "m_deletedCount":
 233             return self.tableSize() + 4
 234         else:
 235             return int(name.lstrip('[').rstrip(']'))
 236
 237     def get_child_at_index(self, index):
 238         if index == self.tableSize():
 239             return self.valobj.GetChildMemberWithName('m_table')
 240         elif index == self.tableSize() + 1:
 241             return self.valobj.GetChildMemberWithName('m_tableSize')
 242         elif index == self.tableSize() + 2:
 243             return self.valobj.GetChildMemberWithName('m_tableSizeMask')
 244         elif index == self.tableSize() + 3:
 245             return self.valobj.GetChildMemberWithName('m_keyCount')
 246         elif index == self.tableSize() + 4:
 247             return self.valobj.GetChildMemberWithName('m_deletedCount')
 248         elif index < self.tableSize():
 249             table = self.valobj.GetChildMemberWithName('m_table')
 250             return table.CreateChildAtOffset('[' + str(index) + ']', index * self.data_size, self.data_type)
 251         else:
 252             return None
 253
 254     def tableSize(self):
 255         return self.valobj.GetChildMemberWithName('m_tableSize').GetValueAsUnsigned(0)
 256
 257     def keyCount(self):
 258         return self.valobj.GetChildMemberWithName('m_keyCount').GetValueAsUnsigned(0)
 259
 260     def update(self):
 261         self.data_type = self.valobj.GetType().GetTemplateArgumentType(0)
 262         self.data_size = self.data_type.GetByteSize()
 263
 264     def has_children(self):
 265         return True