summaryrefslogtreecommitdiff
path: root/test/ninep.py
blob: ac4e146b58e14db0e62adef87344d5c00774d702 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
#!/usr/bin/env python3
import json
import os
import socket
import struct


def string(value):
    data = value.encode() if isinstance(value, str) else value
    return struct.pack('<H', len(data)) + data


class Client:
    def __init__(self, address, timeout=5, msize=8192):
        tcp = isinstance(address, tuple)
        family = (socket.AF_INET6 if ':' in address[0] else socket.AF_INET) if tcp else socket.AF_UNIX
        self.socket = socket.socket(family)
        self.socket.settimeout(timeout)
        if tcp:
            self.socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
        self.tag = 0
        self.fid = 1
        self.msize = msize
        try:
            self.socket.connect(address if tcp else os.fspath(address))
            reply = self.rpc(100, struct.pack('<I', self.msize) + string('9P2000'), tag=65535)
            self.msize = min(self.msize, struct.unpack_from('<I', reply)[0])
            if self.msize < 256 or reply[4:] != string('9P2000'):
                raise OSError('unsupported 9P version or message size')
            attached = self.rpc(104, struct.pack('<II', 1, 0xffffffff) + string('pardes') + string(''))
            if len(attached) != 13:
                raise OSError('invalid attach qid')
        except BaseException:
            self.socket.close()
            raise

    def __enter__(self):
        return self

    def __exit__(self, *args):
        self.socket.close()

    def receive(self, count):
        data = bytearray()
        while len(data) < count:
            chunk = self.socket.recv(count - len(data))
            if not chunk:
                raise EOFError('9P peer closed the connection')
            data.extend(chunk)
        return bytes(data)

    def rpc(self, kind, payload, tag=None):
        if tag is None:
            self.tag = (self.tag + 1) % 65535
            tag = self.tag
        packet = struct.pack('<IBH', 7 + len(payload), kind, tag) + payload
        if len(packet) > self.msize:
            raise ValueError('request exceeds negotiated message size')
        self.socket.sendall(packet)
        size, answer, received_tag = struct.unpack('<IBH', self.receive(7))
        if not 7 <= size <= self.msize or received_tag != tag:
            raise OSError('invalid 9P reply header')
        reply = self.receive(size - 7)
        if answer == 107:
            length = struct.unpack_from('<H', reply)[0]
            raise OSError(reply[2:2 + length].decode(errors='replace'))
        if answer != kind + 1:
            raise OSError(f'expected reply {kind + 1}, received {answer}')
        return reply

    def open(self, path, mode=0):
        names = [part for part in os.fspath(path).split('/') if part]
        self.fid += 1
        fid = self.fid
        oldfid = 1
        try:
            for start in range(0, max(1, len(names)), 16):
                part = names[start:start + 16]
                reply = self.rpc(110, struct.pack('<IIH', oldfid, fid, len(part)) +
                                 b''.join(string(name) for name in part))
                walked = struct.unpack_from('<H', reply)[0]
                if len(reply) != 2 + 13 * walked:
                    raise OSError('invalid walk qids')
                if walked != len(part):
                    raise FileNotFoundError(path)
                oldfid = fid
            if len(self.rpc(112, struct.pack('<IB', fid, mode))) != 17:
                raise OSError('invalid open reply')
            return fid
        except BaseException:
            try:
                self.close(fid)
            except OSError:
                pass
            raise

    def close(self, fid):
        self.rpc(120, struct.pack('<I', fid))

    def create(self, path, name, perm=0o777, mode=0):
        """Tcreate `name` in the directory `path`; returns the new qid."""
        fid = self.walk(path)
        try:
            reply = self.rpc(114, struct.pack('<I', fid) + string(name) +
                             struct.pack('<IB', perm, mode))
            if len(reply) != 17:
                raise OSError('invalid create reply')
            return reply[:13]
        finally:
            self.close(fid)

    def mkdir(self, path, name):
        return self.create(path, name, 0x80000000 | 0o777)

    def remove(self, path):
        """Tremove, which clunks the fid whether or not it succeeds."""
        self.rpc(122, struct.pack('<I', self.walk(path)))

    def read_fid(self, fid, offset=0, count=None):
        count = min(count if count is not None else self.msize - 11, self.msize - 11)
        reply = self.rpc(116, struct.pack('<IQI', fid, offset, count))
        size = struct.unpack_from('<I', reply)[0]
        if size != len(reply) - 4 or size > count:
            raise OSError('invalid 9P read length')
        return reply[4:]

    def read(self, path):
        fid = self.open(path)
        try:
            data = bytearray()
            while chunk := self.read_fid(fid, len(data)):
                data.extend(chunk)
            return bytes(data)
        finally:
            self.close(fid)

    def screen(self):
        return json.loads(self.read('/screen'))

    def walk(self, path):
        names = [part for part in os.fspath(path).split('/') if part]
        self.fid += 1
        fid = self.fid
        oldfid = 1
        try:
            for start in range(0, max(1, len(names)), 16):
                part = names[start:start + 16]
                reply = self.rpc(110, struct.pack('<IIH', oldfid, fid, len(part)) +
                                 b''.join(string(name) for name in part))
                if struct.unpack_from('<H', reply)[0] != len(part):
                    raise FileNotFoundError(path)
                oldfid = fid
            return fid
        except BaseException:
            try:
                self.close(fid)
            except OSError:
                pass
            raise

    def stat(self, path):
        """Tstat without an open: {'name', 'mode', 'length', 'mtime', 'qid'}."""
        fid = self.walk(path)
        try:
            reply = self.rpc(124, struct.pack('<I', fid))
        finally:
            self.close(fid)
        size = struct.unpack_from('<H', reply, 2)[0]
        record = reply[4:4 + size]
        qid = record[6:19]
        mode, _, mtime, length = struct.unpack_from('<IIIQ', record, 19)
        name_len = struct.unpack_from('<H', record, 39)[0]
        name = record[41:41 + name_len].decode()
        return {'name': name, 'mode': mode & 0o777, 'dir': bool(mode & 0x80000000),
                'length': length, 'mtime': mtime, 'qid': qid}

    def write(self, path, data, truncate=False):
        fid = self.open(path, 1 | (16 if truncate else 0))
        try:
            offset = 0
            while offset < len(data):
                chunk = data[offset:offset + self.msize - 23]
                reply = self.rpc(118, struct.pack('<IQI', fid, offset, len(chunk)) + chunk)
                count = struct.unpack('<I', reply)[0]
                if not 0 < count <= len(chunk):
                    raise OSError('invalid 9P write length')
                offset += count
        finally:
            self.close(fid)

    def list(self, path='/'):
        data = self.read(path)
        names = []
        offset = 0
        while offset < len(data):
            size = struct.unpack_from('<H', data, offset)[0]
            if size < 47 or offset + size + 2 > len(data):
                raise OSError('invalid 9P directory entry')
            length = struct.unpack_from('<H', data, offset + 41)[0]
            if 43 + length > size + 2:
                raise OSError('invalid directory name length')
            names.append(data[offset + 43:offset + 43 + length].decode())
            offset += size + 2
        return names