xref: /xnu-11215.61.5/tools/lldbmacros/core/operating_system.py (revision 4f1223e81cd707a65cc109d0b8ad6653699da3c4)
1*4f1223e8SApple OSS Distributions#!/usr/bin/python
2*4f1223e8SApple OSS Distributions#
3*4f1223e8SApple OSS Distributions
4*4f1223e8SApple OSS Distributions#source of register info is from http://opensource.apple.com/source/gdb/gdb-962/src/gdb/arm-tdep.c
5*4f1223e8SApple OSS Distributionsimport struct
6*4f1223e8SApple OSS Distributionsimport lldb
7*4f1223e8SApple OSS Distributions
8*4f1223e8SApple OSS Distributions
9*4f1223e8SApple OSS Distributionsosplugin_target_obj = None
10*4f1223e8SApple OSS Distributions
11*4f1223e8SApple OSS Distributionsclass PluginValue(lldb.SBValue):
12*4f1223e8SApple OSS Distributions    def GetChildMemberWithName(val, name):
13*4f1223e8SApple OSS Distributions        val_type = val.GetType()
14*4f1223e8SApple OSS Distributions        if val_type.IsPointerType():
15*4f1223e8SApple OSS Distributions            val_type = val_type.GetPointeeType()
16*4f1223e8SApple OSS Distributions        for i in range(val_type.GetNumberOfFields()):
17*4f1223e8SApple OSS Distributions            if name == val_type.GetFieldAtIndex(i).GetName():
18*4f1223e8SApple OSS Distributions                return PluginValue(val.GetChildAtIndex(i))
19*4f1223e8SApple OSS Distributions        return None
20*4f1223e8SApple OSS Distributions
21*4f1223e8SApple OSS Distributionsclass Armv8_RegisterSet(object):
22*4f1223e8SApple OSS Distributions    """ register info set for armv8 64 bit architecture"""
23*4f1223e8SApple OSS Distributions    register_info = { 'sets' : ['GPR'],
24*4f1223e8SApple OSS Distributions                  'registers': [
25*4f1223e8SApple OSS Distributions    {'name': 'x0'  , 'bitsize':64, 'offset':  0, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 0, 'dwarf': 0, 'alt-name':'arg1', 'generic':'arg1'},
26*4f1223e8SApple OSS Distributions    {'name': 'x1'  , 'bitsize':64, 'offset':  8, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 1, 'dwarf': 1, 'alt-name':'arg2', 'generic':'arg2'},
27*4f1223e8SApple OSS Distributions    {'name': 'x2'  , 'bitsize':64, 'offset': 16, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 2, 'dwarf': 2, 'alt-name':'arg3', 'generic':'arg3'},
28*4f1223e8SApple OSS Distributions    {'name': 'x3'  , 'bitsize':64, 'offset': 24, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 3, 'dwarf': 3, 'alt-name':'arg4', 'generic':'arg4'},
29*4f1223e8SApple OSS Distributions    {'name': 'x4'  , 'bitsize':64, 'offset': 32, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 4, 'dwarf': 4, 'alt-name':'arg5', 'generic':'arg5'},
30*4f1223e8SApple OSS Distributions    {'name': 'x5'  , 'bitsize':64, 'offset': 40, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 5, 'dwarf': 5, 'alt-name':'arg6', 'generic':'arg6'},
31*4f1223e8SApple OSS Distributions    {'name': 'x6'  , 'bitsize':64, 'offset': 48, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 6, 'dwarf': 6, 'alt-name':'arg7', 'generic':'arg7'},
32*4f1223e8SApple OSS Distributions    {'name': 'x7'  , 'bitsize':64, 'offset': 56, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 7, 'dwarf': 7, 'alt-name':'arg8', 'generic':'arg8'},
33*4f1223e8SApple OSS Distributions    {'name': 'x8'  , 'bitsize':64, 'offset': 64, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 8, 'dwarf': 8},
34*4f1223e8SApple OSS Distributions    {'name': 'x9'  , 'bitsize':64, 'offset': 72, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 9, 'dwarf': 9},
35*4f1223e8SApple OSS Distributions    {'name': 'x10' , 'bitsize':64, 'offset': 80, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':10, 'dwarf':10},
36*4f1223e8SApple OSS Distributions    {'name': 'x11' , 'bitsize':64, 'offset': 88, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':11, 'dwarf':11},
37*4f1223e8SApple OSS Distributions    {'name': 'x12' , 'bitsize':64, 'offset': 96, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':12, 'dwarf':12},
38*4f1223e8SApple OSS Distributions    {'name': 'x13' , 'bitsize':64, 'offset':104, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':13, 'dwarf':13},
39*4f1223e8SApple OSS Distributions    {'name': 'x14' , 'bitsize':64, 'offset':112, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':14, 'dwarf':14},
40*4f1223e8SApple OSS Distributions    {'name': 'x15' , 'bitsize':64, 'offset':120, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':15, 'dwarf':15},
41*4f1223e8SApple OSS Distributions    {'name': 'x16' , 'bitsize':64, 'offset':128, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':16, 'dwarf':16},
42*4f1223e8SApple OSS Distributions    {'name': 'x17' , 'bitsize':64, 'offset':136, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':17, 'dwarf':17},
43*4f1223e8SApple OSS Distributions    {'name': 'x18' , 'bitsize':64, 'offset':144, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':18, 'dwarf':18},
44*4f1223e8SApple OSS Distributions    {'name': 'x19' , 'bitsize':64, 'offset':152, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':19, 'dwarf':19},
45*4f1223e8SApple OSS Distributions    {'name': 'x20' , 'bitsize':64, 'offset':160, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':20, 'dwarf':20},
46*4f1223e8SApple OSS Distributions    {'name': 'x21' , 'bitsize':64, 'offset':168, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':21, 'dwarf':21},
47*4f1223e8SApple OSS Distributions    {'name': 'x22' , 'bitsize':64, 'offset':176, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':22, 'dwarf':22},
48*4f1223e8SApple OSS Distributions    {'name': 'x23' , 'bitsize':64, 'offset':184, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':23, 'dwarf':23},
49*4f1223e8SApple OSS Distributions    {'name': 'x24' , 'bitsize':64, 'offset':192, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':24, 'dwarf':24},
50*4f1223e8SApple OSS Distributions    {'name': 'x25' , 'bitsize':64, 'offset':200, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':25, 'dwarf':25},
51*4f1223e8SApple OSS Distributions    {'name': 'x26' , 'bitsize':64, 'offset':208, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':26, 'dwarf':26},
52*4f1223e8SApple OSS Distributions    {'name': 'x27' , 'bitsize':64, 'offset':216, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':27, 'dwarf':27},
53*4f1223e8SApple OSS Distributions    {'name': 'x28' , 'bitsize':64, 'offset':224, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':28, 'dwarf':28},
54*4f1223e8SApple OSS Distributions    {'name': 'fp'  , 'bitsize':64, 'offset':232, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':29, 'dwarf':29, 'alt-name': 'fp', 'generic':'fp'},
55*4f1223e8SApple OSS Distributions    {'name': 'lr'  , 'bitsize':64, 'offset':240, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':30, 'dwarf':30, 'alt-name': 'lr', 'generic':'lr'},
56*4f1223e8SApple OSS Distributions    {'name': 'sp'  , 'bitsize':64, 'offset':248, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':31, 'dwarf':31, 'alt-name': 'sp', 'generic':'sp'},
57*4f1223e8SApple OSS Distributions    {'name': 'pc'  , 'bitsize':64, 'offset':256, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':32, 'dwarf':32, 'alt-name': 'pc', 'generic':'pc'},
58*4f1223e8SApple OSS Distributions    {'name': 'far' , 'bitsize':64, 'offset':264, 'encoding':'uint', 'format':'hex', 'set':0},
59*4f1223e8SApple OSS Distributions    {'name': 'cpsr', 'bitsize':32, 'offset':272, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':33, 'dwarf':33, 'generic':'flags'},
60*4f1223e8SApple OSS Distributions    {'name': 'esr' , 'bitsize':32, 'offset':276, 'encoding':'uint', 'format':'hex', 'set':0},
61*4f1223e8SApple OSS Distributions    ]
62*4f1223e8SApple OSS Distributions    }
63*4f1223e8SApple OSS Distributions
64*4f1223e8SApple OSS Distributions    def __init__(self):
65*4f1223e8SApple OSS Distributions        self.switch_context_address = osplugin_target_obj.FindSymbols('Switch_context')[0].GetSymbol().GetStartAddress().GetLoadAddress(osplugin_target_obj)
66*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
67*4f1223e8SApple OSS Distributions    def ResetRegisterValues(self):
68*4f1223e8SApple OSS Distributions        self.x0 = 0
69*4f1223e8SApple OSS Distributions        self.x1 = 0
70*4f1223e8SApple OSS Distributions        self.x2 = 0
71*4f1223e8SApple OSS Distributions        self.x3 = 0
72*4f1223e8SApple OSS Distributions        self.x4 = 0
73*4f1223e8SApple OSS Distributions        self.x5 = 0
74*4f1223e8SApple OSS Distributions        self.x6 = 0
75*4f1223e8SApple OSS Distributions        self.x7 = 0
76*4f1223e8SApple OSS Distributions        self.x8 = 0
77*4f1223e8SApple OSS Distributions        self.x9 = 0
78*4f1223e8SApple OSS Distributions        self.x10 = 0
79*4f1223e8SApple OSS Distributions        self.x11 = 0
80*4f1223e8SApple OSS Distributions        self.x12 = 0
81*4f1223e8SApple OSS Distributions        self.x13 = 0
82*4f1223e8SApple OSS Distributions        self.x14 = 0
83*4f1223e8SApple OSS Distributions        self.x15 = 0
84*4f1223e8SApple OSS Distributions        self.x16 = 0
85*4f1223e8SApple OSS Distributions        self.x17 = 0
86*4f1223e8SApple OSS Distributions        self.x18 = 0
87*4f1223e8SApple OSS Distributions        self.x19 = 0
88*4f1223e8SApple OSS Distributions        self.x20 = 0
89*4f1223e8SApple OSS Distributions        self.x21 = 0
90*4f1223e8SApple OSS Distributions        self.x22 = 0
91*4f1223e8SApple OSS Distributions        self.x23 = 0
92*4f1223e8SApple OSS Distributions        self.x24 = 0
93*4f1223e8SApple OSS Distributions        self.x25 = 0
94*4f1223e8SApple OSS Distributions        self.x26 = 0
95*4f1223e8SApple OSS Distributions        self.x27 = 0
96*4f1223e8SApple OSS Distributions        self.x28 = 0
97*4f1223e8SApple OSS Distributions        self.fp = 0
98*4f1223e8SApple OSS Distributions        self.lr = 0
99*4f1223e8SApple OSS Distributions        self.sp = 0
100*4f1223e8SApple OSS Distributions        self.pc = 0
101*4f1223e8SApple OSS Distributions        self.far = 0
102*4f1223e8SApple OSS Distributions        self.cpsr = 0
103*4f1223e8SApple OSS Distributions        self.esr = 0
104*4f1223e8SApple OSS Distributions
105*4f1223e8SApple OSS Distributions    def __str__(self):
106*4f1223e8SApple OSS Distributions        return """ pc = """
107*4f1223e8SApple OSS Distributions
108*4f1223e8SApple OSS Distributions    def GetPackedRegisterState(self):
109*4f1223e8SApple OSS Distributions        return struct.pack('34QII', self.x0, self.x1, self.x2, self.x3, self.x4, self.x5,
110*4f1223e8SApple OSS Distributions            self.x6, self.x7, self.x8, self.x9, self.x10, self.x11, self.x12, self.x13,
111*4f1223e8SApple OSS Distributions            self.x14, self.x15, self.x16, self.x17, self.x18, self.x19, self.x20, self.x21,
112*4f1223e8SApple OSS Distributions            self.x22, self.x23, self.x24, self.x25, self.x26, self.x27, self.x28, self.fp,
113*4f1223e8SApple OSS Distributions            self.lr, self.sp, self.pc, self.far, self.cpsr, self.esr)
114*4f1223e8SApple OSS Distributions
115*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromKDPSavedState(self, kdp_state, kernel_version):
116*4f1223e8SApple OSS Distributions        """ Setup register values from KDP saved information.
117*4f1223e8SApple OSS Distributions        """
118*4f1223e8SApple OSS Distributions        saved_state = kernel_version.CreateValueFromExpression(None, '(struct arm_saved_state64 *) ' + str(kdp_state.GetValueAsUnsigned()))
119*4f1223e8SApple OSS Distributions        saved_state = saved_state.Dereference()
120*4f1223e8SApple OSS Distributions        saved_state = PluginValue(saved_state)
121*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
122*4f1223e8SApple OSS Distributions        self.x0 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(0).GetValueAsUnsigned()
123*4f1223e8SApple OSS Distributions        self.x1 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(1).GetValueAsUnsigned()
124*4f1223e8SApple OSS Distributions        self.x2 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(2).GetValueAsUnsigned()
125*4f1223e8SApple OSS Distributions        self.x3 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(3).GetValueAsUnsigned()
126*4f1223e8SApple OSS Distributions        self.x4 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(4).GetValueAsUnsigned()
127*4f1223e8SApple OSS Distributions        self.x5 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(5).GetValueAsUnsigned()
128*4f1223e8SApple OSS Distributions        self.x6 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(6).GetValueAsUnsigned()
129*4f1223e8SApple OSS Distributions        self.x7 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(7).GetValueAsUnsigned()
130*4f1223e8SApple OSS Distributions        self.x8 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(8).GetValueAsUnsigned()
131*4f1223e8SApple OSS Distributions        self.x9 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(9).GetValueAsUnsigned()
132*4f1223e8SApple OSS Distributions        self.x10 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(10).GetValueAsUnsigned()
133*4f1223e8SApple OSS Distributions        self.x11 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(11).GetValueAsUnsigned()
134*4f1223e8SApple OSS Distributions        self.x12 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(12).GetValueAsUnsigned()
135*4f1223e8SApple OSS Distributions        self.x13 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(13).GetValueAsUnsigned()
136*4f1223e8SApple OSS Distributions        self.x14 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(14).GetValueAsUnsigned()
137*4f1223e8SApple OSS Distributions        self.x15 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(15).GetValueAsUnsigned()
138*4f1223e8SApple OSS Distributions        self.x16 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(16).GetValueAsUnsigned()
139*4f1223e8SApple OSS Distributions        self.x17 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(17).GetValueAsUnsigned()
140*4f1223e8SApple OSS Distributions        self.x18 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(18).GetValueAsUnsigned()
141*4f1223e8SApple OSS Distributions        self.x19 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(19).GetValueAsUnsigned()
142*4f1223e8SApple OSS Distributions        self.x20 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(20).GetValueAsUnsigned()
143*4f1223e8SApple OSS Distributions        self.x21 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(21).GetValueAsUnsigned()
144*4f1223e8SApple OSS Distributions        self.x22 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(22).GetValueAsUnsigned()
145*4f1223e8SApple OSS Distributions        self.x23 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(23).GetValueAsUnsigned()
146*4f1223e8SApple OSS Distributions        self.x24 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(24).GetValueAsUnsigned()
147*4f1223e8SApple OSS Distributions        self.x25 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(25).GetValueAsUnsigned()
148*4f1223e8SApple OSS Distributions        self.x26 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(26).GetValueAsUnsigned()
149*4f1223e8SApple OSS Distributions        self.x27 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(27).GetValueAsUnsigned()
150*4f1223e8SApple OSS Distributions        self.x28 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(28).GetValueAsUnsigned()
151*4f1223e8SApple OSS Distributions        self.fp = saved_state.GetChildMemberWithName('fp').GetValueAsUnsigned()
152*4f1223e8SApple OSS Distributions        self.lr = saved_state.GetChildMemberWithName('lr').GetValueAsUnsigned()
153*4f1223e8SApple OSS Distributions        self.sp = saved_state.GetChildMemberWithName('sp').GetValueAsUnsigned()
154*4f1223e8SApple OSS Distributions        self.pc = saved_state.GetChildMemberWithName('pc').GetValueAsUnsigned()
155*4f1223e8SApple OSS Distributions        self.far = saved_state.GetChildMemberWithName('far').GetValueAsUnsigned()
156*4f1223e8SApple OSS Distributions        self.cpsr = saved_state.GetChildMemberWithName('cpsr').GetValueAsUnsigned()
157*4f1223e8SApple OSS Distributions        self.esr = saved_state.GetChildMemberWithName('esr').GetValueAsUnsigned()
158*4f1223e8SApple OSS Distributions        return self
159*4f1223e8SApple OSS Distributions
160*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromKernelStack(self, kstack_saved_state_addr, kernel_version):
161*4f1223e8SApple OSS Distributions        saved_state = kernel_version.CreateValueFromExpression(None, '(arm_kernel_saved_state_t *) '+ str(kstack_saved_state_addr))
162*4f1223e8SApple OSS Distributions        saved_state = saved_state.Dereference()
163*4f1223e8SApple OSS Distributions        saved_state = PluginValue(saved_state)
164*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
165*4f1223e8SApple OSS Distributions        self.x19 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(0).GetValueAsUnsigned()
166*4f1223e8SApple OSS Distributions        self.x20 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(1).GetValueAsUnsigned()
167*4f1223e8SApple OSS Distributions        self.x21 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(2).GetValueAsUnsigned()
168*4f1223e8SApple OSS Distributions        self.x22 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(3).GetValueAsUnsigned()
169*4f1223e8SApple OSS Distributions        self.x23 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(4).GetValueAsUnsigned()
170*4f1223e8SApple OSS Distributions        self.x24 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(5).GetValueAsUnsigned()
171*4f1223e8SApple OSS Distributions        self.x25 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(6).GetValueAsUnsigned()
172*4f1223e8SApple OSS Distributions        self.x26 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(7).GetValueAsUnsigned()
173*4f1223e8SApple OSS Distributions        self.x27 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(8).GetValueAsUnsigned()
174*4f1223e8SApple OSS Distributions        self.x28 = saved_state.GetChildMemberWithName('x').GetChildAtIndex(9).GetValueAsUnsigned()
175*4f1223e8SApple OSS Distributions        self.fp = saved_state.GetChildMemberWithName('fp').GetValueAsUnsigned()
176*4f1223e8SApple OSS Distributions        self.lr = saved_state.GetChildMemberWithName('lr').GetValueAsUnsigned()
177*4f1223e8SApple OSS Distributions        self.sp = saved_state.GetChildMemberWithName('sp').GetValueAsUnsigned()
178*4f1223e8SApple OSS Distributions        # pc for a blocked thread is treated to be the next instruction it would run after thread switch.
179*4f1223e8SApple OSS Distributions        self.pc = self.switch_context_address
180*4f1223e8SApple OSS Distributions        return self
181*4f1223e8SApple OSS Distributions
182*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromContinuation(self, continuation_ptr):
183*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
184*4f1223e8SApple OSS Distributions        self.pc = continuation_ptr
185*4f1223e8SApple OSS Distributions        return self
186*4f1223e8SApple OSS Distributions
187*4f1223e8SApple OSS Distributions    @classmethod
188*4f1223e8SApple OSS Distributions    def GetRegisterInfo(cls, regnum):
189*4f1223e8SApple OSS Distributions        if regnum < 0 or regnum > len(cls.register_info['registers']):
190*4f1223e8SApple OSS Distributions            return ''
191*4f1223e8SApple OSS Distributions
192*4f1223e8SApple OSS Distributions        reginfo = cls.register_info['registers'][regnum]
193*4f1223e8SApple OSS Distributions        retval = ''
194*4f1223e8SApple OSS Distributions        for i in list(reginfo.keys()):
195*4f1223e8SApple OSS Distributions            v_str = str(reginfo[i])
196*4f1223e8SApple OSS Distributions            if i == 'set':
197*4f1223e8SApple OSS Distributions                v_str = 'General Purpose Registers'
198*4f1223e8SApple OSS Distributions            retval += "%s:%s;" % (str(i), v_str)
199*4f1223e8SApple OSS Distributions        return retval
200*4f1223e8SApple OSS Distributions
201*4f1223e8SApple OSS Distributions
202*4f1223e8SApple OSS Distributions
203*4f1223e8SApple OSS Distributionsclass Armv7_RegisterSet(object):
204*4f1223e8SApple OSS Distributions    """ register info set for armv7 32 bit architecture """
205*4f1223e8SApple OSS Distributions    register_info = { 'sets' : ['GPR'],
206*4f1223e8SApple OSS Distributions                  'registers': [
207*4f1223e8SApple OSS Distributions        { 'name':'r0'   , 'bitsize' : 32, 'offset' :  0, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 0, 'dwarf' : 0},
208*4f1223e8SApple OSS Distributions        { 'name':'r1'   , 'bitsize' : 32, 'offset' :  4, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 1, 'dwarf' : 1},
209*4f1223e8SApple OSS Distributions        { 'name':'r2'   , 'bitsize' : 32, 'offset' :  8, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 2, 'dwarf' : 2},
210*4f1223e8SApple OSS Distributions        { 'name':'r3'   , 'bitsize' : 32, 'offset' : 12, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 3, 'dwarf' : 3},
211*4f1223e8SApple OSS Distributions        { 'name':'r4'   , 'bitsize' : 32, 'offset' : 16, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 4, 'dwarf' : 4},
212*4f1223e8SApple OSS Distributions        { 'name':'r5'   , 'bitsize' : 32, 'offset' : 20, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 5, 'dwarf' : 5},
213*4f1223e8SApple OSS Distributions        { 'name':'r6'   , 'bitsize' : 32, 'offset' : 24, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 6, 'dwarf' : 6},
214*4f1223e8SApple OSS Distributions        { 'name':'r7'   , 'bitsize' : 32, 'offset' : 28, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 7, 'dwarf' : 7},
215*4f1223e8SApple OSS Distributions        { 'name':'r8'   , 'bitsize' : 32, 'offset' : 32, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 8, 'dwarf' : 8},
216*4f1223e8SApple OSS Distributions        { 'name':'r9'   , 'bitsize' : 32, 'offset' : 36, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc': 9, 'dwarf' : 9},
217*4f1223e8SApple OSS Distributions        { 'name':'r10'  , 'bitsize' : 32, 'offset' : 40, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':10, 'dwarf' :10},
218*4f1223e8SApple OSS Distributions        { 'name':'r11'  , 'bitsize' : 32, 'offset' : 44, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':11, 'dwarf' :11, 'alt-name': 'fp', 'generic': 'fp'},
219*4f1223e8SApple OSS Distributions        { 'name':'r12'  , 'bitsize' : 32, 'offset' : 48, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':12, 'dwarf' :12},
220*4f1223e8SApple OSS Distributions        { 'name':'sp'   , 'bitsize' : 32, 'offset' : 52, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':13, 'dwarf' :13, 'generic': 'sp'},
221*4f1223e8SApple OSS Distributions        { 'name':'lr'   , 'bitsize' : 32, 'offset' : 56, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':14, 'dwarf' :14, 'generic': 'lr'},
222*4f1223e8SApple OSS Distributions        { 'name':'pc'   , 'bitsize' : 32, 'offset' : 60, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':15, 'dwarf' :15, 'generic': 'pc'},
223*4f1223e8SApple OSS Distributions        { 'name':'cpsr' , 'bitsize' : 32, 'offset' : 64, 'encoding':'uint', 'format':'hex', 'set':0, 'gcc':16, 'dwarf' :16, 'generic':'flags'},
224*4f1223e8SApple OSS Distributions        { 'name':'fsr'  , 'bitsize' : 32, 'offset' : 68, 'encoding':'uint', 'format':'hex', 'set':0},
225*4f1223e8SApple OSS Distributions        { 'name':'far'  , 'bitsize' : 32, 'offset' : 72, 'encoding':'uint', 'format':'hex', 'set':0}
226*4f1223e8SApple OSS Distributions        ]
227*4f1223e8SApple OSS Distributions        }
228*4f1223e8SApple OSS Distributions
229*4f1223e8SApple OSS Distributions    def __init__(self):
230*4f1223e8SApple OSS Distributions        self.switch_context_address = osplugin_target_obj.FindSymbols('load_reg')[0].GetSymbol().GetStartAddress().GetLoadAddress(osplugin_target_obj) + 8
231*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
232*4f1223e8SApple OSS Distributions
233*4f1223e8SApple OSS Distributions    @classmethod
234*4f1223e8SApple OSS Distributions    def GetRegisterInfo(cls, regnum):
235*4f1223e8SApple OSS Distributions        if regnum < 0 or regnum > len(cls.register_info['registers']):
236*4f1223e8SApple OSS Distributions            return ''
237*4f1223e8SApple OSS Distributions
238*4f1223e8SApple OSS Distributions        reginfo = cls.register_info['registers'][regnum]
239*4f1223e8SApple OSS Distributions        retval = ''
240*4f1223e8SApple OSS Distributions        for i in list(reginfo.keys()):
241*4f1223e8SApple OSS Distributions            v_str = str(reginfo[i])
242*4f1223e8SApple OSS Distributions            if i == 'set':
243*4f1223e8SApple OSS Distributions                v_str = 'General Purpose Registers'
244*4f1223e8SApple OSS Distributions            retval += "%s:%s;" % (str(i), v_str)
245*4f1223e8SApple OSS Distributions        return retval
246*4f1223e8SApple OSS Distributions
247*4f1223e8SApple OSS Distributions    def ResetRegisterValues(self):
248*4f1223e8SApple OSS Distributions        self.r0 = 0
249*4f1223e8SApple OSS Distributions        self.r1 = 0
250*4f1223e8SApple OSS Distributions        self.r2 = 0
251*4f1223e8SApple OSS Distributions        self.r3 = 0
252*4f1223e8SApple OSS Distributions        self.r4 = 0
253*4f1223e8SApple OSS Distributions        self.r5 = 0
254*4f1223e8SApple OSS Distributions        self.r6 = 0
255*4f1223e8SApple OSS Distributions        self.r7 = 0
256*4f1223e8SApple OSS Distributions        self.r8 = 0
257*4f1223e8SApple OSS Distributions        self.r9 = 0
258*4f1223e8SApple OSS Distributions        self.r10 = 0
259*4f1223e8SApple OSS Distributions        self.r11 = 0
260*4f1223e8SApple OSS Distributions        self.r12 = 0
261*4f1223e8SApple OSS Distributions        self.sp = 0
262*4f1223e8SApple OSS Distributions        self.lr = 0
263*4f1223e8SApple OSS Distributions        self.pc = 0
264*4f1223e8SApple OSS Distributions        self.cpsr = 0
265*4f1223e8SApple OSS Distributions        self.fsr = 0
266*4f1223e8SApple OSS Distributions        self.far = 0
267*4f1223e8SApple OSS Distributions
268*4f1223e8SApple OSS Distributions    def __str__(self):
269*4f1223e8SApple OSS Distributions        return """
270*4f1223e8SApple OSS Distributions            r0 = {o.r0: <#010x}
271*4f1223e8SApple OSS Distributions            r1 = {o.r1: <#010x}
272*4f1223e8SApple OSS Distributions            r2 = {o.r2: <#010x}
273*4f1223e8SApple OSS Distributions            r3 = {o.r3: <#010x}
274*4f1223e8SApple OSS Distributions            r4 = {o.r4: <#010x}
275*4f1223e8SApple OSS Distributions            r5 = {o.r5: <#010x}
276*4f1223e8SApple OSS Distributions            r6 = {o.r6: <#010x}
277*4f1223e8SApple OSS Distributions            r7 = {o.r7: <#010x}
278*4f1223e8SApple OSS Distributions            r8 = {o.r8: <#010x}
279*4f1223e8SApple OSS Distributions            r9 = {o.r9: <#010x}
280*4f1223e8SApple OSS Distributions            r10 = {o.r10: <#010x}
281*4f1223e8SApple OSS Distributions            r11 = {o.r11: <#010x}
282*4f1223e8SApple OSS Distributions            r12 = {o.r12: <#010x}
283*4f1223e8SApple OSS Distributions            sp = {o.sp: <#010x}
284*4f1223e8SApple OSS Distributions            lr = {o.lr: <#010x}
285*4f1223e8SApple OSS Distributions            pc = {o.pc: <#010x}
286*4f1223e8SApple OSS Distributions            cpsr = {o.cpsr: <#010x}
287*4f1223e8SApple OSS Distributions            fsr = {o.fsr : <#010x}
288*4f1223e8SApple OSS Distributions            far = {o.far : <#010x}
289*4f1223e8SApple OSS Distributions            """.format(o=self)
290*4f1223e8SApple OSS Distributions
291*4f1223e8SApple OSS Distributions    def GetPackedRegisterState(self):
292*4f1223e8SApple OSS Distributions        return struct.pack('19I', self.r0, self.r1, self.r2, self.r3,
293*4f1223e8SApple OSS Distributions            self.r4, self.r5, self.r6, self.r7,
294*4f1223e8SApple OSS Distributions            self.r8, self.r9, self.r10, self.r11,
295*4f1223e8SApple OSS Distributions            self.r12, self.sp, self.lr, self.pc,
296*4f1223e8SApple OSS Distributions            self.cpsr, self.fsr, self.far)
297*4f1223e8SApple OSS Distributions
298*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromKDPSavedState(self, kdp_state, kernel_version):
299*4f1223e8SApple OSS Distributions        saved_state = kernel_version.CreateValueFromExpression(None, '(struct arm_saved_state *) ' + str(kdp_state.GetValueAsUnsigned()))
300*4f1223e8SApple OSS Distributions        saved_state = saved_state.Dereference()
301*4f1223e8SApple OSS Distributions        saved_state = PluginValue(saved_state)
302*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
303*4f1223e8SApple OSS Distributions        self.r0 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(0).GetValueAsUnsigned()
304*4f1223e8SApple OSS Distributions        self.r1 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(1).GetValueAsUnsigned()
305*4f1223e8SApple OSS Distributions        self.r2 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(2).GetValueAsUnsigned()
306*4f1223e8SApple OSS Distributions        self.r3 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(3).GetValueAsUnsigned()
307*4f1223e8SApple OSS Distributions        self.r4 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(4).GetValueAsUnsigned()
308*4f1223e8SApple OSS Distributions        self.r5 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(5).GetValueAsUnsigned()
309*4f1223e8SApple OSS Distributions        self.r6 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(6).GetValueAsUnsigned()
310*4f1223e8SApple OSS Distributions        self.r7 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(7).GetValueAsUnsigned()
311*4f1223e8SApple OSS Distributions        self.r8 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(8).GetValueAsUnsigned()
312*4f1223e8SApple OSS Distributions        self.r9 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(9).GetValueAsUnsigned()
313*4f1223e8SApple OSS Distributions        self.r10 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(10).GetValueAsUnsigned()
314*4f1223e8SApple OSS Distributions        self.r11 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(11).GetValueAsUnsigned()
315*4f1223e8SApple OSS Distributions        self.r12 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(12).GetValueAsUnsigned()
316*4f1223e8SApple OSS Distributions        self.sp = saved_state.GetChildMemberWithName('sp').GetValueAsUnsigned()
317*4f1223e8SApple OSS Distributions        self.lr = saved_state.GetChildMemberWithName('lr').GetValueAsUnsigned()
318*4f1223e8SApple OSS Distributions        self.pc = saved_state.GetChildMemberWithName('pc').GetValueAsUnsigned()
319*4f1223e8SApple OSS Distributions        self.cpsr = saved_state.GetChildMemberWithName('cpsr').GetValueAsUnsigned()
320*4f1223e8SApple OSS Distributions        self.fsr = saved_state.GetChildMemberWithName('fsr').GetValueAsUnsigned()
321*4f1223e8SApple OSS Distributions        self.far = saved_state.GetChildMemberWithName('far').GetValueAsUnsigned()
322*4f1223e8SApple OSS Distributions        return self
323*4f1223e8SApple OSS Distributions
324*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromKernelStack(self, kstack_saved_state_addr, kernel_version):
325*4f1223e8SApple OSS Distributions        saved_state = kernel_version.CreateValueFromExpression(None, '(struct arm_saved_state *) '+ str(kstack_saved_state_addr))
326*4f1223e8SApple OSS Distributions        saved_state = saved_state.Dereference()
327*4f1223e8SApple OSS Distributions        saved_state = PluginValue(saved_state)
328*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
329*4f1223e8SApple OSS Distributions        self.r0 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(0).GetValueAsUnsigned()
330*4f1223e8SApple OSS Distributions        self.r1 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(1).GetValueAsUnsigned()
331*4f1223e8SApple OSS Distributions        self.r2 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(2).GetValueAsUnsigned()
332*4f1223e8SApple OSS Distributions        self.r3 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(3).GetValueAsUnsigned()
333*4f1223e8SApple OSS Distributions        self.r4 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(4).GetValueAsUnsigned()
334*4f1223e8SApple OSS Distributions        self.r5 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(5).GetValueAsUnsigned()
335*4f1223e8SApple OSS Distributions        self.r6 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(6).GetValueAsUnsigned()
336*4f1223e8SApple OSS Distributions        self.r7 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(7).GetValueAsUnsigned()
337*4f1223e8SApple OSS Distributions        self.r8 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(8).GetValueAsUnsigned()
338*4f1223e8SApple OSS Distributions        self.r9 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(9).GetValueAsUnsigned()
339*4f1223e8SApple OSS Distributions        self.r10 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(10).GetValueAsUnsigned()
340*4f1223e8SApple OSS Distributions        self.r11 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(11).GetValueAsUnsigned()
341*4f1223e8SApple OSS Distributions        self.r12 = saved_state.GetChildMemberWithName('r').GetChildAtIndex(12).GetValueAsUnsigned()
342*4f1223e8SApple OSS Distributions        self.sp = saved_state.GetChildMemberWithName('sp').GetValueAsUnsigned()
343*4f1223e8SApple OSS Distributions        self.lr = saved_state.GetChildMemberWithName('lr').GetValueAsUnsigned()
344*4f1223e8SApple OSS Distributions        # pc for a blocked thread is treated to be the next instruction it would run after thread switch.
345*4f1223e8SApple OSS Distributions        self.pc = self.switch_context_address
346*4f1223e8SApple OSS Distributions        self.cpsr = saved_state.GetChildMemberWithName('cpsr').GetValueAsUnsigned()
347*4f1223e8SApple OSS Distributions        self.fsr = saved_state.GetChildMemberWithName('fsr').GetValueAsUnsigned()
348*4f1223e8SApple OSS Distributions        self.far = saved_state.GetChildMemberWithName('far').GetValueAsUnsigned()
349*4f1223e8SApple OSS Distributions        return self
350*4f1223e8SApple OSS Distributions
351*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromContinuation(self, continuation_ptr):
352*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
353*4f1223e8SApple OSS Distributions        self.pc = continuation_ptr
354*4f1223e8SApple OSS Distributions        return self
355*4f1223e8SApple OSS Distributions
356*4f1223e8SApple OSS Distributions
357*4f1223e8SApple OSS Distributionsclass I386_RegisterSet(object):
358*4f1223e8SApple OSS Distributions    """ register info set for i386 architecture
359*4f1223e8SApple OSS Distributions    """
360*4f1223e8SApple OSS Distributions    register_info = { 'sets' : ['GPR'],
361*4f1223e8SApple OSS Distributions                  'registers': [
362*4f1223e8SApple OSS Distributions        { 'name': 'eax'   , 'bitsize': 32, 'offset' : 0, 'encoding': 'uint' , 'format':'hex' , 'set': 0, 'gcc' : 0, 'dwarf': 0},
363*4f1223e8SApple OSS Distributions        { 'name': 'ebx'   , 'bitsize': 32, 'offset' : 4, 'encoding': 'uint' , 'format':'hex' , 'set': 0, 'gcc' : 3, 'dwarf': 3},
364*4f1223e8SApple OSS Distributions        { 'name': 'ecx'   , 'bitsize': 32, 'offset' : 8, 'encoding': 'uint' , 'format':'hex' , 'set': 0, 'gcc' : 1, 'dwarf': 1},
365*4f1223e8SApple OSS Distributions        { 'name': 'edx'   , 'bitsize': 32, 'offset' :12, 'encoding': 'uint' , 'format':'hex' , 'set': 0, 'gcc' : 2, 'dwarf': 2},
366*4f1223e8SApple OSS Distributions        { 'name': 'edi'   , 'bitsize': 32, 'offset' :16, 'encoding': 'uint' , 'format':'hex' , 'set': 0, 'gcc' : 7, 'dwarf': 7},
367*4f1223e8SApple OSS Distributions        { 'name': 'esi'   , 'bitsize': 32, 'offset' :20, 'encoding': 'uint' , 'format':'hex' , 'set': 0, 'gcc' : 6, 'dwarf': 6},
368*4f1223e8SApple OSS Distributions        { 'name': 'ebp'   , 'bitsize': 32, 'offset' :24, 'encoding': 'uint' , 'format':'hex' , 'set': 0, 'gcc' : 4, 'dwarf': 5, 'generic': 'fp', 'alt-name': 'fp'},
369*4f1223e8SApple OSS Distributions        { 'name': 'esp'   , 'bitsize': 32, 'offset' :28, 'encoding': 'uint' , 'format':'hex' , 'set': 0, 'gcc' : 5, 'dwarf': 4, 'generic': 'sp', 'alt-name': 'sp'},
370*4f1223e8SApple OSS Distributions        { 'name': 'ss'    , 'bitsize': 32, 'offset' :32, 'encoding': 'uint' , 'format':'hex' , 'set': 0},
371*4f1223e8SApple OSS Distributions        { 'name': 'eflags', 'bitsize': 32, 'offset' :36, 'encoding': 'uint' , 'format':'hex' , 'set': 0, 'gcc' : 9, 'dwarf': 9, 'generic': 'flags'},
372*4f1223e8SApple OSS Distributions        { 'name': 'eip'   , 'bitsize': 32, 'offset' :40, 'encoding': 'uint' , 'format':'hex' , 'set': 0, 'gcc' :8, 'dwarf':8, 'generic': 'pc', 'alt-name': 'pc'},
373*4f1223e8SApple OSS Distributions        { 'name': 'cs'    , 'bitsize': 32, 'offset' :44, 'encoding': 'uint' , 'format':'hex' , 'set': 0},
374*4f1223e8SApple OSS Distributions        { 'name': 'ds'    , 'bitsize': 32, 'offset' :48, 'encoding': 'uint' , 'format':'hex' , 'set': 0},
375*4f1223e8SApple OSS Distributions        { 'name': 'es'    , 'bitsize': 32, 'offset' :52, 'encoding': 'uint' , 'format':'hex' , 'set': 0},
376*4f1223e8SApple OSS Distributions        { 'name': 'fs'    , 'bitsize': 32, 'offset' :56, 'encoding': 'uint' , 'format':'hex' , 'set': 0},
377*4f1223e8SApple OSS Distributions        { 'name': 'gs'    , 'bitsize': 32, 'offset' :60, 'encoding': 'uint' , 'format':'hex' , 'set': 0},
378*4f1223e8SApple OSS Distributions        ]
379*4f1223e8SApple OSS Distributions        }
380*4f1223e8SApple OSS Distributions
381*4f1223e8SApple OSS Distributions    def __init__(self):
382*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
383*4f1223e8SApple OSS Distributions
384*4f1223e8SApple OSS Distributions    @classmethod
385*4f1223e8SApple OSS Distributions    def GetRegisterInfo(cls, regnum):
386*4f1223e8SApple OSS Distributions        if regnum < 0 or regnum > len(cls.register_info['registers']):
387*4f1223e8SApple OSS Distributions            return ''
388*4f1223e8SApple OSS Distributions
389*4f1223e8SApple OSS Distributions        reginfo = cls.register_info['registers'][regnum]
390*4f1223e8SApple OSS Distributions        retval = ''
391*4f1223e8SApple OSS Distributions        for i in list(reginfo.keys()):
392*4f1223e8SApple OSS Distributions            v_str = str(reginfo[i])
393*4f1223e8SApple OSS Distributions            if i == 'set':
394*4f1223e8SApple OSS Distributions                v_str = 'General Purpose Registers'
395*4f1223e8SApple OSS Distributions            retval += "%s:%s;" % (str(i), v_str)
396*4f1223e8SApple OSS Distributions        return retval
397*4f1223e8SApple OSS Distributions
398*4f1223e8SApple OSS Distributions    def ResetRegisterValues(self):
399*4f1223e8SApple OSS Distributions        """ set all registers to zero """
400*4f1223e8SApple OSS Distributions        self.eax = 0
401*4f1223e8SApple OSS Distributions        self.ebx = 0
402*4f1223e8SApple OSS Distributions        self.ecx = 0
403*4f1223e8SApple OSS Distributions        self.edx = 0
404*4f1223e8SApple OSS Distributions        self.edi = 0
405*4f1223e8SApple OSS Distributions        self.esi = 0
406*4f1223e8SApple OSS Distributions        self.ebp = 0
407*4f1223e8SApple OSS Distributions        self.esp = 0
408*4f1223e8SApple OSS Distributions        self.ss  = 0
409*4f1223e8SApple OSS Distributions        self.eflags = 0
410*4f1223e8SApple OSS Distributions        self.eip = 0
411*4f1223e8SApple OSS Distributions        self.cs = 0
412*4f1223e8SApple OSS Distributions        self.ds = 0
413*4f1223e8SApple OSS Distributions        self.es = 0
414*4f1223e8SApple OSS Distributions        self.fs = 0
415*4f1223e8SApple OSS Distributions        self.gs = 0
416*4f1223e8SApple OSS Distributions
417*4f1223e8SApple OSS Distributions    def __str__(self):
418*4f1223e8SApple OSS Distributions        return """
419*4f1223e8SApple OSS Distributions            eax = {o.eax: #010x}
420*4f1223e8SApple OSS Distributions            ebx = {o.ebx: #010x}
421*4f1223e8SApple OSS Distributions            ecx = {o.ecx: #010x}
422*4f1223e8SApple OSS Distributions            edx = {o.edx: #010x}
423*4f1223e8SApple OSS Distributions            edi = {o.edi: #010x}
424*4f1223e8SApple OSS Distributions            esi = {o.esi: #010x}
425*4f1223e8SApple OSS Distributions            ebp = {o.ebp: #010x}
426*4f1223e8SApple OSS Distributions            esp = {o.esp: #010x}
427*4f1223e8SApple OSS Distributions            ss  = {o.ss: #010x}
428*4f1223e8SApple OSS Distributions         eflags = {o.eflags: #010x}
429*4f1223e8SApple OSS Distributions            eip = {o.eip: #010x}
430*4f1223e8SApple OSS Distributions            cs  = {o.cs: #010x}
431*4f1223e8SApple OSS Distributions            ds  = {o.ds: #010x}
432*4f1223e8SApple OSS Distributions            es  = {o.es: #010x}
433*4f1223e8SApple OSS Distributions            fs  = {o.fs: #010x}
434*4f1223e8SApple OSS Distributions            gs  = {o.gs: #010x}
435*4f1223e8SApple OSS Distributions            """.format(o=self)
436*4f1223e8SApple OSS Distributions
437*4f1223e8SApple OSS Distributions    def GetPackedRegisterState(self):
438*4f1223e8SApple OSS Distributions        """ get a struct.pack register data """
439*4f1223e8SApple OSS Distributions        return struct.pack('16I', self.eax, self.ebx, self.ecx,
440*4f1223e8SApple OSS Distributions            self.edx, self.edi, self.esi,
441*4f1223e8SApple OSS Distributions            self.ebp, self.esp, self.ss,
442*4f1223e8SApple OSS Distributions            self.eflags, self.eip, self.cs,
443*4f1223e8SApple OSS Distributions            self.ds, self.es, self.fs, self.gs
444*4f1223e8SApple OSS Distributions            )
445*4f1223e8SApple OSS Distributions
446*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromKDPSavedState(self, kdp_state, kernel_version):
447*4f1223e8SApple OSS Distributions        """ to be implemented"""
448*4f1223e8SApple OSS Distributions        return None
449*4f1223e8SApple OSS Distributions
450*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromKernelStack(self, kstack_saved_state_addr, kernel_version):
451*4f1223e8SApple OSS Distributions        """ to be implemented """
452*4f1223e8SApple OSS Distributions        return None
453*4f1223e8SApple OSS Distributions
454*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromContinuation(self, continuation_ptr):
455*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
456*4f1223e8SApple OSS Distributions        self.eip = continuation_ptr
457*4f1223e8SApple OSS Distributions        return self
458*4f1223e8SApple OSS Distributions
459*4f1223e8SApple OSS Distributions
460*4f1223e8SApple OSS Distributionsclass X86_64RegisterSet(object):
461*4f1223e8SApple OSS Distributions    """ register info set for x86_64 architecture """
462*4f1223e8SApple OSS Distributions    register_info = { 'sets' : ['GPR'],
463*4f1223e8SApple OSS Distributions                  'registers': [
464*4f1223e8SApple OSS Distributions        { 'name':'rax'       , 'bitsize' :  64, 'offset' :   0, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 0, 'dwarf' : 0},
465*4f1223e8SApple OSS Distributions        { 'name':'rbx'       , 'bitsize' :  64, 'offset' :   8, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 3, 'dwarf' : 3},
466*4f1223e8SApple OSS Distributions        { 'name':'rcx'       , 'bitsize' :  64, 'offset' :  16, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 2, 'dwarf' : 2, 'generic':'arg4', 'alt-name':'arg4', },
467*4f1223e8SApple OSS Distributions        { 'name':'rdx'       , 'bitsize' :  64, 'offset' :  24, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 1, 'dwarf' : 1, 'generic':'arg3', 'alt-name':'arg3', },
468*4f1223e8SApple OSS Distributions        { 'name':'rdi'       , 'bitsize' :  64, 'offset' :  32, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 5, 'dwarf' : 5, 'generic':'arg1', 'alt-name':'arg1', },
469*4f1223e8SApple OSS Distributions        { 'name':'rsi'       , 'bitsize' :  64, 'offset' :  40, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 4, 'dwarf' : 4, 'generic':'arg2', 'alt-name':'arg2', },
470*4f1223e8SApple OSS Distributions        { 'name':'rbp'       , 'bitsize' :  64, 'offset' :  48, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 6, 'dwarf' : 6, 'generic':'fp'  , 'alt-name':'fp', },
471*4f1223e8SApple OSS Distributions        { 'name':'rsp'       , 'bitsize' :  64, 'offset' :  56, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 7, 'dwarf' : 7, 'generic':'sp'  , 'alt-name':'sp', },
472*4f1223e8SApple OSS Distributions        { 'name':'r8'        , 'bitsize' :  64, 'offset' :  64, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 8, 'dwarf' : 8, 'generic':'arg5', 'alt-name':'arg5', },
473*4f1223e8SApple OSS Distributions        { 'name':'r9'        , 'bitsize' :  64, 'offset' :  72, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 9, 'dwarf' : 9, 'generic':'arg6', 'alt-name':'arg6', },
474*4f1223e8SApple OSS Distributions        { 'name':'r10'       , 'bitsize' :  64, 'offset' :  80, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 10, 'dwarf' : 10},
475*4f1223e8SApple OSS Distributions        { 'name':'r11'       , 'bitsize' :  64, 'offset' :  88, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 11, 'dwarf' : 11},
476*4f1223e8SApple OSS Distributions        { 'name':'r12'       , 'bitsize' :  64, 'offset' :  96, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 12, 'dwarf' : 12},
477*4f1223e8SApple OSS Distributions        { 'name':'r13'       , 'bitsize' :  64, 'offset' : 104, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 13, 'dwarf' : 13},
478*4f1223e8SApple OSS Distributions        { 'name':'r14'       , 'bitsize' :  64, 'offset' : 112, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 14, 'dwarf' : 14},
479*4f1223e8SApple OSS Distributions        { 'name':'r15'       , 'bitsize' :  64, 'offset' : 120, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 15, 'dwarf' : 15},
480*4f1223e8SApple OSS Distributions        { 'name':'rip'       , 'bitsize' :  64, 'offset' : 128, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'gcc' : 16, 'dwarf' : 16, 'generic':'pc', 'alt-name':'pc' },
481*4f1223e8SApple OSS Distributions        { 'name':'rflags'    , 'bitsize' :  64, 'offset' : 136, 'encoding':'uint'  , 'format':'hex'         , 'set': 0, 'generic':'flags', 'alt-name':'flags' },
482*4f1223e8SApple OSS Distributions        { 'name':'cs'        , 'bitsize' :  64, 'offset' : 144, 'encoding':'uint'  , 'format':'hex'         , 'set': 0                          },
483*4f1223e8SApple OSS Distributions        { 'name':'fs'        , 'bitsize' :  64, 'offset' : 152, 'encoding':'uint'  , 'format':'hex'         , 'set': 0                          },
484*4f1223e8SApple OSS Distributions        { 'name':'gs'        , 'bitsize' :  64, 'offset' : 160, 'encoding':'uint'  , 'format':'hex'         , 'set': 0                          },
485*4f1223e8SApple OSS Distributions        ]
486*4f1223e8SApple OSS Distributions        }
487*4f1223e8SApple OSS Distributions    def __init__(self):
488*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
489*4f1223e8SApple OSS Distributions
490*4f1223e8SApple OSS Distributions    @classmethod
491*4f1223e8SApple OSS Distributions    def GetRegisterInfo(cls, regnum):
492*4f1223e8SApple OSS Distributions        if regnum < 0 or regnum > len(cls.register_info['registers']):
493*4f1223e8SApple OSS Distributions            return ''
494*4f1223e8SApple OSS Distributions
495*4f1223e8SApple OSS Distributions        reginfo = cls.register_info['registers'][regnum]
496*4f1223e8SApple OSS Distributions        retval = ''
497*4f1223e8SApple OSS Distributions        for i in list(reginfo.keys()):
498*4f1223e8SApple OSS Distributions            v_str = str(reginfo[i])
499*4f1223e8SApple OSS Distributions            if i == 'set':
500*4f1223e8SApple OSS Distributions                v_str = 'General Purpose Registers'
501*4f1223e8SApple OSS Distributions            retval += "%s:%s;" % (str(i), v_str)
502*4f1223e8SApple OSS Distributions        return retval
503*4f1223e8SApple OSS Distributions
504*4f1223e8SApple OSS Distributions
505*4f1223e8SApple OSS Distributions    def ResetRegisterValues(self):
506*4f1223e8SApple OSS Distributions        """ set all the registers to zero. """
507*4f1223e8SApple OSS Distributions        self.rax = 0
508*4f1223e8SApple OSS Distributions        self.rbx = 0
509*4f1223e8SApple OSS Distributions        self.rcx = 0
510*4f1223e8SApple OSS Distributions        self.rdx = 0
511*4f1223e8SApple OSS Distributions        self.rdi = 0
512*4f1223e8SApple OSS Distributions        self.rsi = 0
513*4f1223e8SApple OSS Distributions        self.rbp = 0
514*4f1223e8SApple OSS Distributions        self.rsp = 0
515*4f1223e8SApple OSS Distributions        self.r8  = 0
516*4f1223e8SApple OSS Distributions        self.r9  = 0
517*4f1223e8SApple OSS Distributions        self.r10 = 0
518*4f1223e8SApple OSS Distributions        self.r11 = 0
519*4f1223e8SApple OSS Distributions        self.r12 = 0
520*4f1223e8SApple OSS Distributions        self.r13 = 0
521*4f1223e8SApple OSS Distributions        self.r14 = 0
522*4f1223e8SApple OSS Distributions        self.r15 = 0
523*4f1223e8SApple OSS Distributions        self.rip = 0
524*4f1223e8SApple OSS Distributions        self.rflags = 0
525*4f1223e8SApple OSS Distributions        self.cs  = 0
526*4f1223e8SApple OSS Distributions        self.fs  = 0
527*4f1223e8SApple OSS Distributions        self.gs  = 0
528*4f1223e8SApple OSS Distributions
529*4f1223e8SApple OSS Distributions    def __str__(self):
530*4f1223e8SApple OSS Distributions        return """
531*4f1223e8SApple OSS Distributions            rax = {o.rax: <#018x}
532*4f1223e8SApple OSS Distributions            rbx = {o.rbx: <#018x}
533*4f1223e8SApple OSS Distributions            rcx = {o.rcx: <#018x}
534*4f1223e8SApple OSS Distributions            rdx = {o.rdx: <#018x}
535*4f1223e8SApple OSS Distributions            rdi = {o.rdi: <#018x}
536*4f1223e8SApple OSS Distributions            rsi = {o.rsi: <#018x}
537*4f1223e8SApple OSS Distributions            rbp = {o.rbp: <#018x}
538*4f1223e8SApple OSS Distributions            rsp = {o.rsp: <#018x}
539*4f1223e8SApple OSS Distributions            r8  = {o.r8: <#018x}
540*4f1223e8SApple OSS Distributions            r9  = {o.r9: <#018x}
541*4f1223e8SApple OSS Distributions            r10 = {o.r10: <#018x}
542*4f1223e8SApple OSS Distributions            r11 = {o.r11: <#018x}
543*4f1223e8SApple OSS Distributions            r12 = {o.r12: <#018x}
544*4f1223e8SApple OSS Distributions            r13 = {o.r13: <#018x}
545*4f1223e8SApple OSS Distributions            r14 = {o.r14: <#018x}
546*4f1223e8SApple OSS Distributions            r15 = {o.r15: <#018x}
547*4f1223e8SApple OSS Distributions            rip = {o.rip: <#018x}
548*4f1223e8SApple OSS Distributions            rflags =  {o.rflags: <#018x}
549*4f1223e8SApple OSS Distributions            cs = {o.cs: <#018x}
550*4f1223e8SApple OSS Distributions            fs = {o.fs: <#018x}
551*4f1223e8SApple OSS Distributions            gs = {o.gs: <#018x}
552*4f1223e8SApple OSS Distributions            """.format(o=self)
553*4f1223e8SApple OSS Distributions
554*4f1223e8SApple OSS Distributions    def GetPackedRegisterState(self):
555*4f1223e8SApple OSS Distributions        """ get a struct.pack register data for passing to C constructs """
556*4f1223e8SApple OSS Distributions        return struct.pack('21Q', self.rax, self.rbx, self.rcx, self.rdx, self.rdi,
557*4f1223e8SApple OSS Distributions            self.rsi, self.rbp, self.rsp, self.r8,  self.r9,
558*4f1223e8SApple OSS Distributions            self.r10, self.r11, self.r12, self.r13, self.r14,
559*4f1223e8SApple OSS Distributions            self.r15, self.rip, self.rflags, self.cs, self.fs, self.gs)
560*4f1223e8SApple OSS Distributions
561*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromKDPSavedState(self, kdp_state, kernel_version):
562*4f1223e8SApple OSS Distributions        saved_state = kernel_version.CreateValueFromExpression(None, '(struct x86_saved_state64 *) '+ str(kdp_state.GetValueAsUnsigned()))
563*4f1223e8SApple OSS Distributions        saved_state = saved_state.Dereference()
564*4f1223e8SApple OSS Distributions        saved_state = PluginValue(saved_state)
565*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
566*4f1223e8SApple OSS Distributions        self.rdi = saved_state.GetChildMemberWithName('rdi').GetValueAsUnsigned()
567*4f1223e8SApple OSS Distributions        self.rsi = saved_state.GetChildMemberWithName('rsi').GetValueAsUnsigned()
568*4f1223e8SApple OSS Distributions        self.rdx = saved_state.GetChildMemberWithName('rdx').GetValueAsUnsigned()
569*4f1223e8SApple OSS Distributions        self.r10 = saved_state.GetChildMemberWithName('r10').GetValueAsUnsigned()
570*4f1223e8SApple OSS Distributions        self.r8 = saved_state.GetChildMemberWithName('r8').GetValueAsUnsigned()
571*4f1223e8SApple OSS Distributions        self.r9 = saved_state.GetChildMemberWithName('r9').GetValueAsUnsigned()
572*4f1223e8SApple OSS Distributions        self.r15 = saved_state.GetChildMemberWithName('r15').GetValueAsUnsigned()
573*4f1223e8SApple OSS Distributions        self.r14 = saved_state.GetChildMemberWithName('r14').GetValueAsUnsigned()
574*4f1223e8SApple OSS Distributions        self.r13 = saved_state.GetChildMemberWithName('r13').GetValueAsUnsigned()
575*4f1223e8SApple OSS Distributions        self.r12 = saved_state.GetChildMemberWithName('r12').GetValueAsUnsigned()
576*4f1223e8SApple OSS Distributions        self.r11 = saved_state.GetChildMemberWithName('r11').GetValueAsUnsigned()
577*4f1223e8SApple OSS Distributions        self.rbp = saved_state.GetChildMemberWithName('rbp').GetValueAsUnsigned()
578*4f1223e8SApple OSS Distributions        self.rbx = saved_state.GetChildMemberWithName('rbx').GetValueAsUnsigned()
579*4f1223e8SApple OSS Distributions        self.rcx = saved_state.GetChildMemberWithName('rcx').GetValueAsUnsigned()
580*4f1223e8SApple OSS Distributions        self.rax = saved_state.GetChildMemberWithName('rax').GetValueAsUnsigned()
581*4f1223e8SApple OSS Distributions        self.rip = saved_state.GetChildMemberWithName('isf').GetChildMemberWithName('rip').GetValueAsUnsigned()
582*4f1223e8SApple OSS Distributions        self.rflags = saved_state.GetChildMemberWithName('isf').GetChildMemberWithName('rflags').GetValueAsUnsigned()
583*4f1223e8SApple OSS Distributions        self.rsp = saved_state.GetChildMemberWithName('isf').GetChildMemberWithName('rsp').GetValueAsUnsigned()
584*4f1223e8SApple OSS Distributions        return self
585*4f1223e8SApple OSS Distributions
586*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromKernelStack(self, kstack_saved_state_addr, kernel_version):
587*4f1223e8SApple OSS Distributions        saved_state = kernel_version.CreateValueFromExpression(None, '(struct x86_kernel_state *) '+ str(kstack_saved_state_addr))
588*4f1223e8SApple OSS Distributions        saved_state = saved_state.Dereference()
589*4f1223e8SApple OSS Distributions        saved_state = PluginValue(saved_state)
590*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
591*4f1223e8SApple OSS Distributions        self.rbx = saved_state.GetChildMemberWithName('k_rbx').GetValueAsUnsigned()
592*4f1223e8SApple OSS Distributions        self.rsp = saved_state.GetChildMemberWithName('k_rsp').GetValueAsUnsigned()
593*4f1223e8SApple OSS Distributions        self.rbp = saved_state.GetChildMemberWithName('k_rbp').GetValueAsUnsigned()
594*4f1223e8SApple OSS Distributions        self.r12 = saved_state.GetChildMemberWithName('k_r12').GetValueAsUnsigned()
595*4f1223e8SApple OSS Distributions        self.r13 = saved_state.GetChildMemberWithName('k_r13').GetValueAsUnsigned()
596*4f1223e8SApple OSS Distributions        self.r14 = saved_state.GetChildMemberWithName('k_r14').GetValueAsUnsigned()
597*4f1223e8SApple OSS Distributions        self.r15 = saved_state.GetChildMemberWithName('k_r15').GetValueAsUnsigned()
598*4f1223e8SApple OSS Distributions        self.rip = saved_state.GetChildMemberWithName('k_rip').GetValueAsUnsigned()
599*4f1223e8SApple OSS Distributions        return self
600*4f1223e8SApple OSS Distributions
601*4f1223e8SApple OSS Distributions    def ReadRegisterDataFromContinuation(self, continuation_ptr):
602*4f1223e8SApple OSS Distributions        self.ResetRegisterValues()
603*4f1223e8SApple OSS Distributions        self.rip = continuation_ptr
604*4f1223e8SApple OSS Distributions        return self
605*4f1223e8SApple OSS Distributions
606*4f1223e8SApple OSS Distributions
607*4f1223e8SApple OSS Distributions
608*4f1223e8SApple OSS Distributions
609*4f1223e8SApple OSS Distributionsdef IterateQueue(queue_head: lldb.SBValue, element_ptr_type: lldb.SBType, element_field_name: str):
610*4f1223e8SApple OSS Distributions    """ iterate over a queue in kernel of type queue_head_t. refer to osfmk/kern/queue.h
611*4f1223e8SApple OSS Distributions        params:
612*4f1223e8SApple OSS Distributions            queue_head         - lldb.SBValue : Value object for queue_head.
613*4f1223e8SApple OSS Distributions            element_type       - lldb.SBType : a pointer type of the element 'next' points to. Typically its structs like thread, task etc..
614*4f1223e8SApple OSS Distributions            element_field_name - str : name of the field in target struct.
615*4f1223e8SApple OSS Distributions        returns:
616*4f1223e8SApple OSS Distributions            A generator does not return. It is used for iterating.
617*4f1223e8SApple OSS Distributions            SBValue  : an object thats of type (element_type) queue_head->next. Always a pointer object
618*4f1223e8SApple OSS Distributions    """
619*4f1223e8SApple OSS Distributions    queue_head_addr = 0x0
620*4f1223e8SApple OSS Distributions    if queue_head.TypeIsPointerType():
621*4f1223e8SApple OSS Distributions        queue_head_addr = queue_head.GetValueAsUnsigned()
622*4f1223e8SApple OSS Distributions    else:
623*4f1223e8SApple OSS Distributions        queue_head_addr = queue_head.GetAddress().GetLoadAddress(osplugin_target_obj)
624*4f1223e8SApple OSS Distributions    cur_elt: lldb.SBValue = queue_head.GetChildMemberWithName('next')
625*4f1223e8SApple OSS Distributions    while True:
626*4f1223e8SApple OSS Distributions        if not (cur_elt.IsValid() and cur_elt.error.success) or cur_elt.GetValueAsUnsigned() == 0 or cur_elt.GetValueAsUnsigned() == queue_head_addr:
627*4f1223e8SApple OSS Distributions            break
628*4f1223e8SApple OSS Distributions        elt = cur_elt.Cast(element_ptr_type)
629*4f1223e8SApple OSS Distributions        yield elt
630*4f1223e8SApple OSS Distributions        cur_elt = elt.GetChildMemberWithName(element_field_name).GetChildMemberWithName('next')
631*4f1223e8SApple OSS Distributions
632*4f1223e8SApple OSS Distributionsdef GetUniqueSessionID(process_obj):
633*4f1223e8SApple OSS Distributions    """ Create a unique session identifier.
634*4f1223e8SApple OSS Distributions        params:
635*4f1223e8SApple OSS Distributions          process_obj: lldb.SBProcess object refering to connected process.
636*4f1223e8SApple OSS Distributions        returns:
637*4f1223e8SApple OSS Distributions          int - a unique number identified by processid and stopid.
638*4f1223e8SApple OSS Distributions    """
639*4f1223e8SApple OSS Distributions    session_key_str = ""
640*4f1223e8SApple OSS Distributions    if hasattr(process_obj, "GetUniqueID"):
641*4f1223e8SApple OSS Distributions        session_key_str += str(process_obj.GetUniqueID()) + ":"
642*4f1223e8SApple OSS Distributions    else:
643*4f1223e8SApple OSS Distributions        session_key_str += "0:"
644*4f1223e8SApple OSS Distributions
645*4f1223e8SApple OSS Distributions    if hasattr(process_obj, "GetStopID"):
646*4f1223e8SApple OSS Distributions        session_key_str += str(process_obj.GetStopID())
647*4f1223e8SApple OSS Distributions    else:
648*4f1223e8SApple OSS Distributions        session_key_str +="1"
649*4f1223e8SApple OSS Distributions
650*4f1223e8SApple OSS Distributions    return hash(session_key_str)
651*4f1223e8SApple OSS Distributions
652*4f1223e8SApple OSS Distributions
653*4f1223e8SApple OSS Distributions(archX86_64, archARMv7, archI386, archARMv8) = ("x86_64", "armv7", "i386", "arm64")
654*4f1223e8SApple OSS Distributions
655*4f1223e8SApple OSS Distributionsclass OperatingSystemPlugIn(object):
656*4f1223e8SApple OSS Distributions    """Class that provides data for an instance of a LLDB 'OperatingSystemPython' plug-in class"""
657*4f1223e8SApple OSS Distributions
658*4f1223e8SApple OSS Distributions    def __init__(self, process):
659*4f1223e8SApple OSS Distributions        '''Initialization needs a valid.SBProcess object'''
660*4f1223e8SApple OSS Distributions        self.process = None
661*4f1223e8SApple OSS Distributions        self.registers = None
662*4f1223e8SApple OSS Distributions        self.threads = None
663*4f1223e8SApple OSS Distributions        self.thread_cache = {}
664*4f1223e8SApple OSS Distributions        self.current_session_id = 0
665*4f1223e8SApple OSS Distributions        self.kdp_thread = None
666*4f1223e8SApple OSS Distributions        if type(process) is lldb.SBProcess and process.IsValid():
667*4f1223e8SApple OSS Distributions            global osplugin_target_obj
668*4f1223e8SApple OSS Distributions            self.process = process
669*4f1223e8SApple OSS Distributions            self._target = process.target
670*4f1223e8SApple OSS Distributions            osplugin_target_obj = self._target
671*4f1223e8SApple OSS Distributions            self.current_session_id = GetUniqueSessionID(self.process)
672*4f1223e8SApple OSS Distributions            self.version = self._target.FindGlobalVariables('version', 1).GetValueAtIndex(0)
673*4f1223e8SApple OSS Distributions
674*4f1223e8SApple OSS Distributions            # Configure explicit pointer stripping
675*4f1223e8SApple OSS Distributions            is_tagged = self._target.FindFirstGlobalVariable('kasan_tbi_enabled').GetValueAsUnsigned()
676*4f1223e8SApple OSS Distributions
677*4f1223e8SApple OSS Distributions            if is_tagged:
678*4f1223e8SApple OSS Distributions
679*4f1223e8SApple OSS Distributions                def strip_ptr(ptr):
680*4f1223e8SApple OSS Distributions                    if ptr != 0:
681*4f1223e8SApple OSS Distributions                        ptr |= (0xFF << 56)
682*4f1223e8SApple OSS Distributions                    return ptr
683*4f1223e8SApple OSS Distributions                self._strip_ptr = strip_ptr
684*4f1223e8SApple OSS Distributions
685*4f1223e8SApple OSS Distributions                def strip_thread_sbval(th):
686*4f1223e8SApple OSS Distributions                    addr = th.GetValueAsAddress()
687*4f1223e8SApple OSS Distributions                    return self.version.CreateValueFromExpression(str(addr), '(struct thread *)' + str(addr))
688*4f1223e8SApple OSS Distributions                self._strip_thread_sbval = strip_thread_sbval
689*4f1223e8SApple OSS Distributions
690*4f1223e8SApple OSS Distributions            else:
691*4f1223e8SApple OSS Distributions                self._strip_ptr = lambda ptr: ptr
692*4f1223e8SApple OSS Distributions                self._strip_thread_sbval = lambda val: val
693*4f1223e8SApple OSS Distributions
694*4f1223e8SApple OSS Distributions            self.kernel_stack_size = self._target.FindGlobalVariables('kernel_stack_size', 1).GetValueAtIndex(0).GetValueAsUnsigned()
695*4f1223e8SApple OSS Distributions            self.kernel_context_size = 0
696*4f1223e8SApple OSS Distributions            self.connected_over_kdp = False
697*4f1223e8SApple OSS Distributions            # connected_to_debugserver signifies if we are connected to astris or other gdbserver instance
698*4f1223e8SApple OSS Distributions            # that has the correct thread state for on core threads. For kdp and coredumps we rely on in memory
699*4f1223e8SApple OSS Distributions            # state of threads.
700*4f1223e8SApple OSS Distributions            self.connected_to_debugserver = True
701*4f1223e8SApple OSS Distributions            plugin_string = self.process.GetPluginName().lower()
702*4f1223e8SApple OSS Distributions            if plugin_string.find("kdp") >=0:
703*4f1223e8SApple OSS Distributions                self.connected_over_kdp = True
704*4f1223e8SApple OSS Distributions                self.connected_to_debugserver = False
705*4f1223e8SApple OSS Distributions            #print "version", self.version, "kernel_stack_size", self.kernel_stack_size, "context_size", self.kernel_context_size
706*4f1223e8SApple OSS Distributions            self.threads = None # Will be an dictionary containing info for each thread
707*4f1223e8SApple OSS Distributions            triple = self.process.target.triple
708*4f1223e8SApple OSS Distributions            arch = triple.split('-')[0].lower()
709*4f1223e8SApple OSS Distributions            self.target_arch = ""
710*4f1223e8SApple OSS Distributions            self.kernel_context_size = 0
711*4f1223e8SApple OSS Distributions            if arch == archX86_64 :
712*4f1223e8SApple OSS Distributions                self.target_arch = archX86_64
713*4f1223e8SApple OSS Distributions                print("Target arch: x86_64")
714*4f1223e8SApple OSS Distributions                self.register_set = X86_64RegisterSet()
715*4f1223e8SApple OSS Distributions                self.kernel_context_size = self._target.FindFirstType('x86_kernel_state').GetByteSize()
716*4f1223e8SApple OSS Distributions                self.kernel_thread_state_size = self._target.FindFirstType('struct thread_kernel_state').GetByteSize()
717*4f1223e8SApple OSS Distributions            elif arch.startswith(archARMv7) :
718*4f1223e8SApple OSS Distributions                self.target_arch = arch
719*4f1223e8SApple OSS Distributions                print("Target arch: " + self.target_arch)
720*4f1223e8SApple OSS Distributions                self.register_set = Armv7_RegisterSet()
721*4f1223e8SApple OSS Distributions            elif arch.startswith(archARMv8):
722*4f1223e8SApple OSS Distributions                self.target_arch = arch
723*4f1223e8SApple OSS Distributions                print("Target arch: " + self.target_arch)
724*4f1223e8SApple OSS Distributions                self.register_set = Armv8_RegisterSet()
725*4f1223e8SApple OSS Distributions            #  connection     intel         arm
726*4f1223e8SApple OSS Distributions            #  kdp            Memory        Memory
727*4f1223e8SApple OSS Distributions            #  gdb            Server        Server
728*4f1223e8SApple OSS Distributions            #  coredump       Memory        Server
729*4f1223e8SApple OSS Distributions            if not self.connected_over_kdp :
730*4f1223e8SApple OSS Distributions                if plugin_string.find('core') >= 0 and self.target_arch == archX86_64:
731*4f1223e8SApple OSS Distributions                    self.connected_to_debugserver = False
732*4f1223e8SApple OSS Distributions            self.registers = self.register_set.register_info
733*4f1223e8SApple OSS Distributions            if self.connected_to_debugserver:
734*4f1223e8SApple OSS Distributions                print("Connected to live debugserver or arm core. Will associate on-core threads to registers reported by server.")
735*4f1223e8SApple OSS Distributions            else:
736*4f1223e8SApple OSS Distributions                print("Instantiating threads completely from saved state in memory.")
737*4f1223e8SApple OSS Distributions
738*4f1223e8SApple OSS Distributions    def create_thread(self, tid, context):
739*4f1223e8SApple OSS Distributions
740*4f1223e8SApple OSS Distributions        # Strip TBI explicitly in case create_thread() is called externally.
741*4f1223e8SApple OSS Distributions        context = self._strip_ptr(context)
742*4f1223e8SApple OSS Distributions
743*4f1223e8SApple OSS Distributions        # tid == deadbeef means its a custom thread which kernel does not know of.
744*4f1223e8SApple OSS Distributions        if tid == 0xdeadbeef :
745*4f1223e8SApple OSS Distributions            # tid manipulation should be the same as in "switchtoregs" code in lldbmacros/process.py .
746*4f1223e8SApple OSS Distributions            tid = 0xdead0000 | (context & ~0xffff0000)
747*4f1223e8SApple OSS Distributions            tid = tid & 0xdeadffff
748*4f1223e8SApple OSS Distributions            thread_obj = { 'tid'   : tid,
749*4f1223e8SApple OSS Distributions                           'ptr'   : context,
750*4f1223e8SApple OSS Distributions                           'name'  : 'switchtoregs' + hex(context),
751*4f1223e8SApple OSS Distributions                           'queue' : 'None',
752*4f1223e8SApple OSS Distributions                           'state' : 'stopped',
753*4f1223e8SApple OSS Distributions                           'stop_reason' : 'none'
754*4f1223e8SApple OSS Distributions                         }
755*4f1223e8SApple OSS Distributions            self.thread_cache[tid] = thread_obj
756*4f1223e8SApple OSS Distributions            return thread_obj
757*4f1223e8SApple OSS Distributions
758*4f1223e8SApple OSS Distributions        th_ptr = context
759*4f1223e8SApple OSS Distributions        th = self.version.CreateValueFromExpression(str(th_ptr), '(struct thread *)' + str(th_ptr))
760*4f1223e8SApple OSS Distributions        thread_id = th.GetChildMemberWithName('thread_id').GetValueAsUnsigned()
761*4f1223e8SApple OSS Distributions        if tid != thread_id:
762*4f1223e8SApple OSS Distributions            print("FATAL ERROR: Creating thread from memory 0x%x with tid in mem=%d when requested tid = %d " % (context, thread_id, tid))
763*4f1223e8SApple OSS Distributions            return None
764*4f1223e8SApple OSS Distributions
765*4f1223e8SApple OSS Distributions        wait_queue = self._strip_ptr(th.GetChildMemberWithName('wait_queue').GetValueAsUnsigned())
766*4f1223e8SApple OSS Distributions        thread_obj = { 'tid'   : thread_id,
767*4f1223e8SApple OSS Distributions                       'ptr'   : th.GetValueAsUnsigned(),
768*4f1223e8SApple OSS Distributions                       'name'  : hex(th.GetValueAsUnsigned()).rstrip('L'),
769*4f1223e8SApple OSS Distributions                       'queue' : hex(wait_queue).rstrip('L'),
770*4f1223e8SApple OSS Distributions                       'state' : 'stopped',
771*4f1223e8SApple OSS Distributions                       'stop_reason' : 'none'
772*4f1223e8SApple OSS Distributions                     }
773*4f1223e8SApple OSS Distributions
774*4f1223e8SApple OSS Distributions        if self.current_session_id != GetUniqueSessionID(self.process):
775*4f1223e8SApple OSS Distributions            self.thread_cache = {}
776*4f1223e8SApple OSS Distributions            self.current_session_id = GetUniqueSessionID(self.process)
777*4f1223e8SApple OSS Distributions
778*4f1223e8SApple OSS Distributions        self.thread_cache[tid] = thread_obj
779*4f1223e8SApple OSS Distributions        return thread_obj
780*4f1223e8SApple OSS Distributions
781*4f1223e8SApple OSS Distributions    def get_thread_info(self):
782*4f1223e8SApple OSS Distributions        self.kdp_thread = None
783*4f1223e8SApple OSS Distributions        self.kdp_state = None
784*4f1223e8SApple OSS Distributions        if self.connected_over_kdp :
785*4f1223e8SApple OSS Distributions            kdp = self._target.FindGlobalVariables('kdp',1).GetValueAtIndex(0)
786*4f1223e8SApple OSS Distributions            kdp_state = kdp.GetChildMemberWithName('saved_state')
787*4f1223e8SApple OSS Distributions            kdp_thread = self._strip_thread_sbval(kdp.GetChildMemberWithName('kdp_thread'))
788*4f1223e8SApple OSS Distributions            if kdp_thread and kdp_thread.GetValueAsUnsigned() != 0:
789*4f1223e8SApple OSS Distributions                self.kdp_thread = kdp_thread
790*4f1223e8SApple OSS Distributions                self.kdp_state = kdp_state
791*4f1223e8SApple OSS Distributions                kdp_thid = kdp_thread.GetChildMemberWithName('thread_id').GetValueAsUnsigned()
792*4f1223e8SApple OSS Distributions                self.create_thread(kdp_thid, kdp_thread.GetValueAsUnsigned())
793*4f1223e8SApple OSS Distributions                self.thread_cache[kdp_thid]['core']=0
794*4f1223e8SApple OSS Distributions                retval = [self.thread_cache[kdp_thid]]
795*4f1223e8SApple OSS Distributions                return retval
796*4f1223e8SApple OSS Distributions            else:
797*4f1223e8SApple OSS Distributions                print("FATAL FAILURE: Unable to find kdp_thread state for this connection.")
798*4f1223e8SApple OSS Distributions                return []
799*4f1223e8SApple OSS Distributions
800*4f1223e8SApple OSS Distributions        num_threads = self._target.FindGlobalVariables('threads_count',1).GetValueAtIndex(0).GetValueAsUnsigned()
801*4f1223e8SApple OSS Distributions        #In case we are caught before threads are initialized. Fallback to threads known by astris/gdb server.
802*4f1223e8SApple OSS Distributions        if num_threads <=0 :
803*4f1223e8SApple OSS Distributions            return []
804*4f1223e8SApple OSS Distributions
805*4f1223e8SApple OSS Distributions        self.current_session_id = GetUniqueSessionID(self.process)
806*4f1223e8SApple OSS Distributions        self.threads = []
807*4f1223e8SApple OSS Distributions        self.thread_cache = {}
808*4f1223e8SApple OSS Distributions        self.processors = []
809*4f1223e8SApple OSS Distributions        try:
810*4f1223e8SApple OSS Distributions            processor_list_val = PluginValue(self._target.FindGlobalVariables('processor_list',1).GetValueAtIndex(0))
811*4f1223e8SApple OSS Distributions            while processor_list_val.IsValid() and processor_list_val.error.success and processor_list_val.GetValueAsUnsigned() !=0:
812*4f1223e8SApple OSS Distributions                th = self._strip_thread_sbval(processor_list_val.GetChildMemberWithName('active_thread'))
813*4f1223e8SApple OSS Distributions                th_id = th.GetChildMemberWithName('thread_id').GetValueAsUnsigned()
814*4f1223e8SApple OSS Distributions                cpu_id = processor_list_val.GetChildMemberWithName('cpu_id').GetValueAsUnsigned()
815*4f1223e8SApple OSS Distributions                self.processors.append({'active_thread': th.GetValueAsUnsigned(), 'cpu_id': cpu_id})
816*4f1223e8SApple OSS Distributions                self.create_thread(th_id, th.GetValueAsUnsigned())
817*4f1223e8SApple OSS Distributions                if self.connected_to_debugserver:
818*4f1223e8SApple OSS Distributions                    self.thread_cache[th_id]['core'] = cpu_id
819*4f1223e8SApple OSS Distributions                self.thread_cache[th_id]['queue'] = "cpu-%d" % int(cpu_id)
820*4f1223e8SApple OSS Distributions                nth = self.thread_cache[th_id]
821*4f1223e8SApple OSS Distributions                self.threads.append(nth)
822*4f1223e8SApple OSS Distributions                self.thread_cache[nth['tid']] = nth
823*4f1223e8SApple OSS Distributions                processor_list_val = processor_list_val.GetChildMemberWithName('processor_list')
824*4f1223e8SApple OSS Distributions        except KeyboardInterrupt as ke:
825*4f1223e8SApple OSS Distributions            print("OS Plugin Interrupted during thread loading process. \nWARNING:Thread registers and backtraces may not be accurate.")
826*4f1223e8SApple OSS Distributions            return self.threads
827*4f1223e8SApple OSS Distributions
828*4f1223e8SApple OSS Distributions        if hasattr(self.process, 'CreateOSPluginThread'):
829*4f1223e8SApple OSS Distributions            return self.threads
830*4f1223e8SApple OSS Distributions
831*4f1223e8SApple OSS Distributions        # FIXME remove legacy code
832*4f1223e8SApple OSS Distributions        try:
833*4f1223e8SApple OSS Distributions            thread_q_head = self._target.FindGlobalVariables('threads', 1).GetValueAtIndex(0)
834*4f1223e8SApple OSS Distributions            thread_type = self._target.FindFirstType('thread')
835*4f1223e8SApple OSS Distributions            thread_ptr_type = thread_type.GetPointerType()
836*4f1223e8SApple OSS Distributions            for th in IterateQueue(thread_q_head, thread_ptr_type, 'threads'):
837*4f1223e8SApple OSS Distributions                th = self._strip_thread_sbval(th)
838*4f1223e8SApple OSS Distributions                th_id = th.GetChildMemberWithName('thread_id').GetValueAsUnsigned()
839*4f1223e8SApple OSS Distributions                self.create_thread(th_id, th.GetValueAsUnsigned())
840*4f1223e8SApple OSS Distributions                nth = self.thread_cache[th_id]
841*4f1223e8SApple OSS Distributions                for cputhread in self.processors:
842*4f1223e8SApple OSS Distributions                    if cputhread['active_thread'] == nth['ptr']:
843*4f1223e8SApple OSS Distributions                        nth['core'] = cputhread['cpu_id']
844*4f1223e8SApple OSS Distributions                self.threads.append( nth )
845*4f1223e8SApple OSS Distributions        except KeyboardInterrupt as ke:
846*4f1223e8SApple OSS Distributions            print("OS Plugin Interrupted during thread loading process. \nWARNING:Thread registers and backtraces may not be accurate.")
847*4f1223e8SApple OSS Distributions            return self.threads
848*4f1223e8SApple OSS Distributions        # end legacy code
849*4f1223e8SApple OSS Distributions        return self.threads
850*4f1223e8SApple OSS Distributions
851*4f1223e8SApple OSS Distributions    def get_register_info(self):
852*4f1223e8SApple OSS Distributions        if self.registers == None:
853*4f1223e8SApple OSS Distributions            print("Register Information not found ")
854*4f1223e8SApple OSS Distributions        return self.register_set.register_info
855*4f1223e8SApple OSS Distributions
856*4f1223e8SApple OSS Distributions    def get_register_data(self, tid):
857*4f1223e8SApple OSS Distributions        thobj = None
858*4f1223e8SApple OSS Distributions        try:
859*4f1223e8SApple OSS Distributions            regs = self.register_set
860*4f1223e8SApple OSS Distributions            if self.current_session_id != GetUniqueSessionID(self.process):
861*4f1223e8SApple OSS Distributions                self.thread_cache = {}
862*4f1223e8SApple OSS Distributions                self.current_session_id = GetUniqueSessionID(self.process)
863*4f1223e8SApple OSS Distributions            if tid in self.thread_cache:
864*4f1223e8SApple OSS Distributions
865*4f1223e8SApple OSS Distributions                #Check if the thread is a fake one. Then create and return registers directly
866*4f1223e8SApple OSS Distributions                if self.thread_cache[tid]['name'].find('switchtoregs') == 0:
867*4f1223e8SApple OSS Distributions                    savedstateobj = self.version.CreateValueFromExpression(None, '(uintptr_t *) ' + str(self.thread_cache[tid]['ptr']))
868*4f1223e8SApple OSS Distributions                    regs.ReadRegisterDataFromKDPSavedState(savedstateobj, self.version)
869*4f1223e8SApple OSS Distributions                    return regs.GetPackedRegisterState()
870*4f1223e8SApple OSS Distributions
871*4f1223e8SApple OSS Distributions                thobj = self.version.CreateValueFromExpression(self.thread_cache[tid]['name'], '(struct thread *)' + str(self.thread_cache[tid]['ptr']))
872*4f1223e8SApple OSS Distributions
873*4f1223e8SApple OSS Distributions            if thobj == None :
874*4f1223e8SApple OSS Distributions                print("FATAL ERROR: Could not find thread with id %d" % tid)
875*4f1223e8SApple OSS Distributions                regs.ResetRegisterValues()
876*4f1223e8SApple OSS Distributions                return regs.GetPackedRegisterState()
877*4f1223e8SApple OSS Distributions
878*4f1223e8SApple OSS Distributions            if self.kdp_thread and self.kdp_thread.GetValueAsUnsigned() == thobj.GetValueAsUnsigned():
879*4f1223e8SApple OSS Distributions                regs.ReadRegisterDataFromKDPSavedState(self.kdp_state, self.version)
880*4f1223e8SApple OSS Distributions                return regs.GetPackedRegisterState()
881*4f1223e8SApple OSS Distributions            if int(PluginValue(thobj).GetChildMemberWithName('kernel_stack').GetValueAsUnsigned()) != 0 :
882*4f1223e8SApple OSS Distributions                if self.target_arch == archX86_64 :
883*4f1223e8SApple OSS Distributions                    # we do have a stack so lets get register information
884*4f1223e8SApple OSS Distributions                    saved_state_addr = PluginValue(thobj).GetChildMemberWithName('kernel_stack').GetValueAsUnsigned() + self.kernel_stack_size - self.kernel_thread_state_size
885*4f1223e8SApple OSS Distributions                    regs.ReadRegisterDataFromKernelStack(saved_state_addr, self.version)
886*4f1223e8SApple OSS Distributions                    return regs.GetPackedRegisterState()
887*4f1223e8SApple OSS Distributions                elif self.target_arch.startswith(archARMv7) and int(PluginValue(thobj).GetChildMemberWithName('machine').GetChildMemberWithName('kstackptr').GetValueAsUnsigned()) != 0:
888*4f1223e8SApple OSS Distributions                    #we have stack on the machine.kstackptr.
889*4f1223e8SApple OSS Distributions                    saved_state_addr = PluginValue(thobj).GetChildMemberWithName('machine').GetChildMemberWithName('kstackptr').GetValueAsUnsigned()
890*4f1223e8SApple OSS Distributions                    regs.ReadRegisterDataFromKernelStack(saved_state_addr, self.version)
891*4f1223e8SApple OSS Distributions                    return regs.GetPackedRegisterState()
892*4f1223e8SApple OSS Distributions                elif self.target_arch.startswith(archARMv8) and int(PluginValue(thobj).GetChildMemberWithName('machine').GetChildMemberWithName('kstackptr').GetValueAsUnsigned()) != 0:
893*4f1223e8SApple OSS Distributions                    saved_state_addr = PluginValue(thobj).GetChildMemberWithName('machine').GetChildMemberWithName('kstackptr').GetValueAsAddress()
894*4f1223e8SApple OSS Distributions                    arm_ctx = PluginValue(self.version.CreateValueFromExpression(None, '(struct arm_kernel_context *) ' + str(saved_state_addr)))
895*4f1223e8SApple OSS Distributions                    arm_ss_addr = arm_ctx.GetChildMemberWithName('ss').GetLoadAddress()
896*4f1223e8SApple OSS Distributions                    regs.ReadRegisterDataFromKernelStack(arm_ss_addr, self.version)
897*4f1223e8SApple OSS Distributions                    return regs.GetPackedRegisterState()
898*4f1223e8SApple OSS Distributions            elif self.target_arch == archX86_64 or self.target_arch.startswith(archARMv7) or self.target_arch.startswith(archARMv8):
899*4f1223e8SApple OSS Distributions                regs.ReadRegisterDataFromContinuation( PluginValue(thobj).GetChildMemberWithName('continuation').GetValueAsAddress())
900*4f1223e8SApple OSS Distributions                return regs.GetPackedRegisterState()
901*4f1223e8SApple OSS Distributions            #incase we failed very miserably
902*4f1223e8SApple OSS Distributions        except KeyboardInterrupt as ke:
903*4f1223e8SApple OSS Distributions            print("OS Plugin Interrupted during thread register load. \nWARNING:Thread registers and backtraces may not be accurate. for tid = %d" % tid)
904*4f1223e8SApple OSS Distributions        regs.ResetRegisterValues()
905*4f1223e8SApple OSS Distributions        print("FATAL ERROR: Failed to get register state for thread id 0x%x " % tid)
906*4f1223e8SApple OSS Distributions        print(thobj)
907*4f1223e8SApple OSS Distributions        return regs.GetPackedRegisterState()
908