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