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