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