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