xref: /xnu-10002.61.3/tools/lldbmacros/usertaskdebugging/gdbserver.py (revision 0f4c859e951fba394238ab619495c4e1d54d0f34)
1from __future__ import absolute_import
2
3from builtins import object
4
5import logging
6from .interface import Interface
7from . import rsprotocol
8import random
9
10
11class GDBServer(object):
12    """instance of gdbserver"""
13    def __init__(self, backing_instance):
14        super(GDBServer, self).__init__()
15        self.process = backing_instance
16        self.portnum = random.randint(2000, 8000)
17        logging.info("Starting gdb server for localhost:%d" % self.portnum)
18        self.conn = Interface('localhost', self.portnum)
19        self.version_string = 'name:kdbserver;version:0.1'
20
21    def run(self):
22        if not self.conn.connect():
23            logging.critical("No client connected. Bailing.")
24            return False
25
26        logging.debug('Starting gdb server.')
27
28        while True:
29            #loop for running the server.
30            #read command
31            readBytes = ""
32
33            while True:
34                try:
35                    p_bytes = self.conn.read()
36                except Exception as e:
37                    logging.warn("found exception in read %s" % (str(e)))
38                    logging.debug("currentbytes: %s" % readBytes)
39                    readBytes = ""
40                    break
41                readBytes += p_bytes.decode()
42                p_begin = readBytes.find('$')
43                p_end = readBytes.find('#')
44                if p_begin >= 0 and p_end >= 0 and p_end > p_begin:
45                    break
46            # ignore if empty or ack messages
47            if readBytes in ('', '+'):
48                logging.debug('ignoring message: %s' % readBytes)
49                continue
50            req_msg = rsprotocol.Message.fromRSPByteData(readBytes)
51            resp = self.handleMessage(req_msg)
52            #in case resp is to detach
53            if resp is None:
54                return True
55            for r_msg in resp:
56                logging.debug("response: %s" % r_msg.getRSPByteData())
57                self.conn.write(r_msg.getRSPByteData())
58        return True
59
60    def handleMessage(self, msg):
61        """ return array of messages that needs to responded. """
62        query = msg.getData()
63        replymsgs = []
64        sendAck = None
65        logging.debug('RCV:' + query)
66
67        if query == "?":
68            h_msg = rsprotocol.Message(self.process.getSignalInfo())
69            replymsgs.append(h_msg)
70
71        elif query[0] == 'm':
72            replymsgs.append(self.getMemory(query))
73
74        elif query in ('qVAttachOrWaitSupported'):
75            logging.debug('Ignoring query %s' % query)
76            replymsgs.append(rsprotocol.UnSupportedMessage)
77
78        elif query == "qC":
79            replymsgs.append(self.getCurrentThreadID(query))
80
81        elif query[0] in ('z', 'Z'):
82            logging.debug('Ignoring breakpoint query %s' % query)
83            replymsgs.append(rsprotocol.UnSupportedMessage)
84
85        elif query[0] in ('g', 'p'):
86            replymsgs.append(self.getRegisterData(query))
87
88        elif query[0] in ('P', 'G'):
89            # we do not support writing into registers
90            replymsgs.append(rsprotocol.Message('E05'))
91
92        elif query in ('QStartNoAckMode'):
93            replymsgs.append(rsprotocol.OKMessage)
94            sendAck = True
95
96        elif query in ('QListThreadsInStopReply', 'QThreadSuffixSupported'):
97            replymsgs.append(rsprotocol.OKMessage)
98
99        elif query == 'qGDBServerVersion':
100            replymsgs.append(rsprotocol.Message(self.version_string))
101
102        elif query == 'qShlibInfoAddr':
103            #return shared library info address if any
104            replymsgs.append(self.getSharedLibInfoAddress(query))
105
106        elif query == 'qProcessInfo':
107            replymsgs.append(self.getProcessInfo(query))
108
109        elif query == 'qHostInfo':
110            h_msg = rsprotocol.Message(self.process.getHostInfo())
111            replymsgs.append(h_msg)
112
113        elif query == 'vCont?':
114            replymsgs.append(rsprotocol.Message('vCont;'))
115
116        elif query == 'D':
117            logging.info('Client requested to detach.')
118            return None
119
120        elif query.find('qRegisterInfo') >= 0:
121            replymsgs.append(self.getRegisterInfo(query))
122
123        elif query.find('qMemoryRegionInfo') >= 0:
124            replymsgs.append(self.getMemoryRegionInfo(query))
125
126        elif query.find('qThreadStopInfo') >= 0 or query in ('qfThreadInfo', 'qsThreadInfo'):
127            replymsgs.append(self.getThreadRegistersInfo(query))
128
129        else:
130            replymsgs.append(rsprotocol.UnSupportedMessage)
131
132        if sendAck is not None:
133            if sendAck:
134                replymsgs.insert(0, rsprotocol.AckMessage)
135            else:
136                replymsgs.insert(0, rsprotocol.NAckMessage)
137
138        return replymsgs
139
140    def getThreadRegistersInfo(self, query):
141        bytes = ''
142        if query == 'qfThreadInfo':
143            bytes = self.process.getFirstThreadInfo()
144        elif query == 'qsThreadInfo':
145            bytes = self.process.getSubsequestThreadInfo()
146        else:
147            try:
148                query = query.replace('qThreadStopInfo', '')
149                tid = int(query, 16)
150                bytes = self.process.getThreadStopInfo(tid)
151            except Exception as e:
152                logging.error("Failed to get register information query: %s error: %s" % (query, e))
153        return rsprotocol.Message(bytes)
154
155    def getRegisterData(self, query):
156        if query[0] == 'g':
157            #TODO should implement this sometime. Considering getThreadRegistersInfo is there
158            #we wont need this one.
159            return rsprotocol.UnSupportedMessage
160
161        #the query is of type p<regnum>;thread:<id>;
162        bytes = ''
163        try:
164            args = query[1:].split(';')
165            if len(args) > 0:
166                regnum = int(args[0], 16)
167                if args[1].find('thread') >= 0:
168                    threadid = int(args[1].split(':')[-1], 16)
169                    bytes = self.process.getRegisterDataForThread(threadid, regnum)
170                    logging.debug('REGISTER INFO bytes = ' + bytes)
171        except Exception as e:
172            logging.error("Failed to get register information query: %s error: %s" % (query, e))
173        return rsprotocol.Message(bytes)
174
175    def getRegisterInfo(self, query):
176        bytes = ''
177        try:
178            query_index = query.replace('qRegisterInfo', '')
179            regnum = int(query_index, 16)
180            bytes = self.process.getRegisterInfo(regnum)
181        except Exception as e:
182            logging.error("Non-fatal: Failed to get register information: query: %s error: %s" % (query, e))
183        return rsprotocol.Message(bytes)
184
185    def getMemory(self, query):
186        query = query[1:]
187        addr, size = query.split(',')
188        mem_address = int(addr, 16)
189        mem_size = int(size, 16)
190        bytes = ''
191        try:
192            bytes = self.process.readMemory(mem_address, mem_size)
193        except Exception as e:
194            logging.warn('Failed to read data %s' % str(e))
195            return rsprotocol.Message('E03')
196        return rsprotocol.Message(bytes)
197
198    def getMemoryRegionInfo(self, query):
199        return rsprotocol.UnSupportedMessage
200
201    def setMemory(self, query):
202        logging.info('Not supporting writing to memory. %s' % query)
203        return rsprotocol.Message('E09')
204
205    def getProcessInfo(self, query):
206        data = ''
207        try:
208            data = self.process.getProcessInfo()
209        except Exception as e:
210            logging.error("Failed to get process information")
211        return rsprotocol.Message(data)
212
213    def getSharedLibInfoAddress(self, query):
214        data = 'E44'
215        try:
216            data = self.process.getSharedLibInfoAddress()
217            data = self.process.encodeThreadID(data)
218        except Exception as e:
219            logging.error("Failed to get Shared Library information")
220        return rsprotocol.Message(data)
221
222    def getCurrentThreadID(self, query):
223        tid = '0'
224        try:
225            tid = '%x' % (self.process.getCurrentThreadID())
226        except Exception as e:
227            logging.error("Failed to get QC info")
228
229        return rsprotocol.Message('QC'+tid)
230
231    def kill(self):
232        pass
233