xref: /xnu-8020.101.4/tools/lldbmacros/core/io.py (revision e7776783b89a353188416a9a346c6cdb4928faad)
1*e7776783SApple OSS Distributions""" Python I/O subsystem backed by LLDB. """
2*e7776783SApple OSS Distributions
3*e7776783SApple OSS Distributionsfrom __future__ import absolute_import, division, print_function
4*e7776783SApple OSS Distributions
5*e7776783SApple OSS Distributionsfrom builtins import bytes
6*e7776783SApple OSS Distributions
7*e7776783SApple OSS Distributionsimport io
8*e7776783SApple OSS Distributionsimport lldb
9*e7776783SApple OSS Distributions
10*e7776783SApple OSS Distributions
11*e7776783SApple OSS Distributionsclass SBProcessRawIO(io.RawIOBase):
12*e7776783SApple OSS Distributions    """ RAW I/O implementation backed by a process memory. """
13*e7776783SApple OSS Distributions
14*e7776783SApple OSS Distributions    def __init__(self, sbprocess, address, size):
15*e7776783SApple OSS Distributions        """ Create new SBProcess I/O.
16*e7776783SApple OSS Distributions
17*e7776783SApple OSS Distributions            sbproces: SBProcess instance to read data from.
18*e7776783SApple OSS Distributions            address: Starting memory address in process' VA.
19*e7776783SApple OSS Distributions            size: Size of the memory range.
20*e7776783SApple OSS Distributions        """
21*e7776783SApple OSS Distributions        super(SBProcessRawIO, self).__init__()
22*e7776783SApple OSS Distributions
23*e7776783SApple OSS Distributions        self._sbprocess = sbprocess
24*e7776783SApple OSS Distributions        self._start = address
25*e7776783SApple OSS Distributions        self._offset = 0
26*e7776783SApple OSS Distributions        self._end = address + size
27*e7776783SApple OSS Distributions
28*e7776783SApple OSS Distributions    # Base I/O methods
29*e7776783SApple OSS Distributions
30*e7776783SApple OSS Distributions    def readable(self):
31*e7776783SApple OSS Distributions        return True
32*e7776783SApple OSS Distributions
33*e7776783SApple OSS Distributions    def writable(self):
34*e7776783SApple OSS Distributions        # This is a lie that allows using BufferedRandom on top of this I/O.
35*e7776783SApple OSS Distributions        return True
36*e7776783SApple OSS Distributions
37*e7776783SApple OSS Distributions    def seekable(self):
38*e7776783SApple OSS Distributions        return True
39*e7776783SApple OSS Distributions
40*e7776783SApple OSS Distributions    # Raw I/O methods
41*e7776783SApple OSS Distributions
42*e7776783SApple OSS Distributions    def tell(self):
43*e7776783SApple OSS Distributions        return self._offset
44*e7776783SApple OSS Distributions
45*e7776783SApple OSS Distributions    def seek(self, offset, whence=0):
46*e7776783SApple OSS Distributions        seekto = offset
47*e7776783SApple OSS Distributions        if whence == 0:
48*e7776783SApple OSS Distributions            seekto += 0
49*e7776783SApple OSS Distributions        elif whence == 1:
50*e7776783SApple OSS Distributions            seekto += self.tell()
51*e7776783SApple OSS Distributions        elif whence == 2:
52*e7776783SApple OSS Distributions            seekto += self._end - self._start
53*e7776783SApple OSS Distributions        else:
54*e7776783SApple OSS Distributions            raise IOError("Invalid whence argument to seek: %r" % (whence,))
55*e7776783SApple OSS Distributions
56*e7776783SApple OSS Distributions        self._offset = seekto
57*e7776783SApple OSS Distributions        return seekto
58*e7776783SApple OSS Distributions
59*e7776783SApple OSS Distributions    def read(self, size=-1):
60*e7776783SApple OSS Distributions        if size < 0:
61*e7776783SApple OSS Distributions            return self.readall()
62*e7776783SApple OSS Distributions
63*e7776783SApple OSS Distributions        # Do not read past the end of the data range.
64*e7776783SApple OSS Distributions        read_size = min(size, self._end - (self._start + self._offset))
65*e7776783SApple OSS Distributions
66*e7776783SApple OSS Distributions        err = lldb.SBError()
67*e7776783SApple OSS Distributions        data = self._sbprocess.ReadMemory(self._start + self._offset, read_size, err)
68*e7776783SApple OSS Distributions
69*e7776783SApple OSS Distributions        # EOF on failure
70*e7776783SApple OSS Distributions        if not err.Success():
71*e7776783SApple OSS Distributions            return bytes()
72*e7776783SApple OSS Distributions
73*e7776783SApple OSS Distributions        self._offset += len(data)
74*e7776783SApple OSS Distributions        return bytes(data)
75*e7776783SApple OSS Distributions
76*e7776783SApple OSS Distributions    def readall(self):
77*e7776783SApple OSS Distributions        err = lldb.SBError()
78*e7776783SApple OSS Distributions        data = self._sbprocess.ReadMemory(self._start, self._end - self._start, err)
79*e7776783SApple OSS Distributions
80*e7776783SApple OSS Distributions        if not err.Success():
81*e7776783SApple OSS Distributions            return bytes()
82*e7776783SApple OSS Distributions
83*e7776783SApple OSS Distributions        return bytes(data)
84*e7776783SApple OSS Distributions
85*e7776783SApple OSS Distributions    def readinto(self, bytes):
86*e7776783SApple OSS Distributions        """ Reads data into existing object. """
87*e7776783SApple OSS Distributions        data = self.read(len(bytes))
88*e7776783SApple OSS Distributions        if data:
89*e7776783SApple OSS Distributions            bytes[:len(data)] = data
90*e7776783SApple OSS Distributions        return len(data)
91*e7776783SApple OSS Distributions
92*e7776783SApple OSS Distributions    def readlines(self, hint=-1):
93*e7776783SApple OSS Distributions        raise NotImplementedError("Can't read lines yet.")
94*e7776783SApple OSS Distributions
95*e7776783SApple OSS Distributions    def write(self, bytes):
96*e7776783SApple OSS Distributions        raise NotImplementedError("Can't write through LLDB yet.")
97