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