Enrico Granata | 579a296 | 2012-03-13 21:52:00 +0000 | [diff] [blame] | 1 | """ |
| 2 | LLDB AppKit formatters |
| 3 | |
| 4 | part of The LLVM Compiler Infrastructure |
| 5 | This file is distributed under the University of Illinois Open Source |
| 6 | License. See LICENSE.TXT for details. |
| 7 | """ |
Enrico Granata | dc1df6b | 2013-03-16 00:50:25 +0000 | [diff] [blame] | 8 | # example summary provider for NSMachPort |
| 9 | # the real summary is now C++ code built into LLDB |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 10 | import lldb |
| 11 | import ctypes |
Enrico Granata | 0d235d5 | 2012-04-25 01:39:27 +0000 | [diff] [blame] | 12 | import lldb.runtime.objc.objc_runtime |
| 13 | import lldb.formatters.metrics |
| 14 | import lldb.formatters.Logger |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 15 | |
Enrico Granata | 0d235d5 | 2012-04-25 01:39:27 +0000 | [diff] [blame] | 16 | statistics = lldb.formatters.metrics.Metrics() |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 17 | statistics.add_metric('invalid_isa') |
| 18 | statistics.add_metric('invalid_pointer') |
| 19 | statistics.add_metric('unknown_class') |
| 20 | statistics.add_metric('code_notrun') |
| 21 | |
| 22 | # despite the similary to synthetic children providers, these classes are not |
| 23 | # trying to provide anything but the port number of an NSMachPort, so they need not |
| 24 | # obey the interface specification for synthetic children providers |
| 25 | class NSMachPortKnown_SummaryProvider: |
| 26 | def adjust_for_architecture(self): |
Enrico Granata | f2a8467 | 2012-03-05 19:56:33 +0000 | [diff] [blame] | 27 | pass |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 28 | |
Enrico Granata | f2a8467 | 2012-03-05 19:56:33 +0000 | [diff] [blame] | 29 | def __init__(self, valobj, params): |
Enrico Granata | 0d235d5 | 2012-04-25 01:39:27 +0000 | [diff] [blame] | 30 | logger = lldb.formatters.Logger.Logger() |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 31 | self.valobj = valobj; |
Enrico Granata | f2a8467 | 2012-03-05 19:56:33 +0000 | [diff] [blame] | 32 | self.sys_params = params |
| 33 | if not(self.sys_params.types_cache.NSUInteger): |
| 34 | if self.sys_params.is_64_bit: |
| 35 | self.sys_params.types_cache.NSUInteger = self.valobj.GetType().GetBasicType(lldb.eBasicTypeUnsignedLong) |
| 36 | else: |
| 37 | self.sys_params.types_cache.NSUInteger = self.valobj.GetType().GetBasicType(lldb.eBasicTypeUnsignedInt) |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 38 | self.update(); |
| 39 | |
| 40 | def update(self): |
Enrico Granata | 0d235d5 | 2012-04-25 01:39:27 +0000 | [diff] [blame] | 41 | logger = lldb.formatters.Logger.Logger() |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 42 | self.adjust_for_architecture(); |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 43 | |
| 44 | # one pointer is the ISA |
| 45 | # then we have one other internal pointer, plus |
| 46 | # 4 bytes worth of flags. hence, these values |
| 47 | def offset(self): |
Enrico Granata | 0d235d5 | 2012-04-25 01:39:27 +0000 | [diff] [blame] | 48 | logger = lldb.formatters.Logger.Logger() |
Enrico Granata | f2a8467 | 2012-03-05 19:56:33 +0000 | [diff] [blame] | 49 | if self.sys_params.is_64_bit: |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 50 | return 20 |
| 51 | else: |
| 52 | return 12 |
| 53 | |
| 54 | def port(self): |
Enrico Granata | 0d235d5 | 2012-04-25 01:39:27 +0000 | [diff] [blame] | 55 | logger = lldb.formatters.Logger.Logger() |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 56 | vport = self.valobj.CreateChildAtOffset("port", |
| 57 | self.offset(), |
Enrico Granata | f2a8467 | 2012-03-05 19:56:33 +0000 | [diff] [blame] | 58 | self.sys_params.types_cache.NSUInteger) |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 59 | return vport.GetValueAsUnsigned(0) |
| 60 | |
| 61 | |
| 62 | class NSMachPortUnknown_SummaryProvider: |
| 63 | def adjust_for_architecture(self): |
Enrico Granata | f2a8467 | 2012-03-05 19:56:33 +0000 | [diff] [blame] | 64 | pass |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 65 | |
Enrico Granata | f2a8467 | 2012-03-05 19:56:33 +0000 | [diff] [blame] | 66 | def __init__(self, valobj, params): |
Enrico Granata | 0d235d5 | 2012-04-25 01:39:27 +0000 | [diff] [blame] | 67 | logger = lldb.formatters.Logger.Logger() |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 68 | self.valobj = valobj; |
Enrico Granata | f2a8467 | 2012-03-05 19:56:33 +0000 | [diff] [blame] | 69 | self.sys_params = params |
| 70 | self.update(); |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 71 | |
| 72 | def update(self): |
Enrico Granata | 0d235d5 | 2012-04-25 01:39:27 +0000 | [diff] [blame] | 73 | logger = lldb.formatters.Logger.Logger() |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 74 | self.adjust_for_architecture(); |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 75 | |
| 76 | def port(self): |
Enrico Granata | 0d235d5 | 2012-04-25 01:39:27 +0000 | [diff] [blame] | 77 | logger = lldb.formatters.Logger.Logger() |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 78 | stream = lldb.SBStream() |
| 79 | self.valobj.GetExpressionPath(stream) |
Enrico Granata | 579a296 | 2012-03-13 21:52:00 +0000 | [diff] [blame] | 80 | num_children_vo = self.valobj.CreateValueFromExpression("port","(int)[" + stream.GetData() + " machPort]") |
| 81 | if num_children_vo.IsValid(): |
| 82 | return num_children_vo.GetValueAsUnsigned(0) |
| 83 | return '<variable is not NSMachPort>' |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 84 | |
| 85 | |
| 86 | def GetSummary_Impl(valobj): |
Enrico Granata | 0d235d5 | 2012-04-25 01:39:27 +0000 | [diff] [blame] | 87 | logger = lldb.formatters.Logger.Logger() |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 88 | global statistics |
Enrico Granata | a5c2ce0 | 2012-04-25 17:53:41 +0000 | [diff] [blame] | 89 | class_data,wrapper =lldb.runtime.objc.objc_runtime.Utilities.prepare_class_detection(valobj,statistics) |
Enrico Granata | 579a296 | 2012-03-13 21:52:00 +0000 | [diff] [blame] | 90 | if wrapper: |
| 91 | return wrapper |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 92 | |
| 93 | name_string = class_data.class_name() |
Enrico Granata | 8f18240 | 2012-04-02 16:39:29 +0000 | [diff] [blame] | 94 | logger >> "class name is: " + str(name_string) |
| 95 | |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 96 | if name_string == 'NSMachPort': |
Enrico Granata | f2a8467 | 2012-03-05 19:56:33 +0000 | [diff] [blame] | 97 | wrapper = NSMachPortKnown_SummaryProvider(valobj, class_data.sys_params) |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 98 | statistics.metric_hit('code_notrun',valobj) |
| 99 | else: |
Enrico Granata | f2a8467 | 2012-03-05 19:56:33 +0000 | [diff] [blame] | 100 | wrapper = NSMachPortUnknown_SummaryProvider(valobj, class_data.sys_params) |
Enrico Granata | 805f79b | 2012-03-30 00:51:12 +0000 | [diff] [blame] | 101 | statistics.metric_hit('unknown_class',valobj.GetName() + " seen as " + name_string) |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 102 | return wrapper; |
| 103 | |
| 104 | def NSMachPort_SummaryProvider (valobj,dict): |
Enrico Granata | 0d235d5 | 2012-04-25 01:39:27 +0000 | [diff] [blame] | 105 | logger = lldb.formatters.Logger.Logger() |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 106 | provider = GetSummary_Impl(valobj); |
| 107 | if provider != None: |
Enrico Granata | a5c2ce0 | 2012-04-25 17:53:41 +0000 | [diff] [blame] | 108 | if isinstance(provider,lldb.runtime.objc.objc_runtime.SpecialSituation_Description): |
Enrico Granata | 579a296 | 2012-03-13 21:52:00 +0000 | [diff] [blame] | 109 | return provider.message() |
| 110 | try: |
| 111 | summary = provider.port(); |
| 112 | except: |
| 113 | summary = None |
Enrico Granata | 8f18240 | 2012-04-02 16:39:29 +0000 | [diff] [blame] | 114 | logger >> "got summary " + str(summary) |
Enrico Granata | 579a296 | 2012-03-13 21:52:00 +0000 | [diff] [blame] | 115 | if summary == None: |
| 116 | summary = '<variable is not NSMachPort>' |
| 117 | if isinstance(summary, basestring): |
| 118 | return summay |
| 119 | return 'mach port: ' + str(summary) |
| 120 | return 'Summary Unavailable' |
Enrico Granata | b370df2 | 2012-02-23 23:10:27 +0000 | [diff] [blame] | 121 | |
| 122 | def __lldb_init_module(debugger,dict): |
| 123 | debugger.HandleCommand("type summary add -F NSMachPort.NSMachPort_SummaryProvider NSMachPort") |