Newer
Older
################################################################################
# Copyright 2018-2020, Barcelona Supercomputing Center (BSC), Spain #
# Copyright 2015-2020, Johannes Gutenberg Universitaet Mainz, Germany #
# #
# This software was partially supported by the #
# EC H2020 funded project NEXTGenIO (Project ID: 671951, www.nextgenio.eu). #
# #
# This software was partially supported by the #
# ADA-FS project under the SPPEXA project funded by the DFG. #
# #
# SPDX-License-Identifier: MIT #
################################################################################
import ctypes
from marshmallow import Schema, fields, pre_load, post_load
from collections import namedtuple
class DIR_p(fields.Field):
"""Field that deserializes a ::DIR* return value"""
def _deserialize(self, value, attr, data, **kwargs):
return ctypes.c_void_p(value)
class Errno(fields.Field):
"""Field that deserialies an errno return value"""
def _deserialize(self, value, attr, data, **kwargs):
return int(value)
class ByteList(fields.Field):
"""Field that deserializes a list of bytes"""
def _deserialize(self, value, attr, data, **kwargs):
return bytes(value)
class StructTimespecSchema(Schema):
"""Schema that deserializes a struct timespec"""
tv_sec = fields.Integer(required=True)
tv_nsec = fields.Integer(required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('StructTimespec',
['tv_sec', 'tv_nsec'])(**data)
class StructStatSchema(Schema):
"""Schema that deserializes a struct stat"""
st_dev = fields.Integer(required=True)
st_ino = fields.Integer(required=True)
st_mode = fields.Integer(required=True)
st_nlink = fields.Integer(required=True)
st_uid = fields.Integer(required=True)
st_gid = fields.Integer(required=True)
st_rdev = fields.Integer(required=True)
st_size = fields.Integer(required=True)
st_blksize = fields.Integer(required=True)
st_blocks = fields.Integer(required=True)
st_atim = fields.Nested(StructTimespecSchema)
st_mtim = fields.Nested(StructTimespecSchema)
st_ctim = fields.Nested(StructTimespecSchema)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('StructStat',
['st_dev', 'st_ino', 'st_mode', 'st_nlink', 'st_uid',
'st_gid', 'st_rdev', 'st_size', 'st_blksize', 'st_blocks',
'st_atim', 'st_mtim', 'st_ctim'])(**data)
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
class StructStatxTimestampSchema(Schema):
"""Schema that deserializes a struct timespec"""
tv_sec = fields.Integer(required=True)
tv_nsec = fields.Integer(required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('StructStatxTimestampSchema',
['tv_sec', 'tv_nsec'])(**data)
class StructStatxSchema(Schema):
"""Schema that deserializes a struct stat"""
stx_mask = fields.Integer(required=True)
stx_blksize = fields.Integer(required=True)
stx_attributes = fields.Integer(required=True)
stx_nlink = fields.Integer(required=True)
stx_uid = fields.Integer(required=True)
stx_gid = fields.Integer(required=True)
stx_mode = fields.Integer(required=True)
stx_ino = fields.Integer(required=True)
stx_size = fields.Integer(required=True)
stx_blocks = fields.Integer(required=True)
stx_attributes_mask = fields.Integer(required=True)
stx_atime = fields.Nested(StructStatxTimestampSchema)
stx_btime = fields.Nested(StructStatxTimestampSchema)
stx_ctime = fields.Nested(StructStatxTimestampSchema)
stx_mtime = fields.Nested(StructStatxTimestampSchema)
stx_rdev_major = fields.Integer(required=True)
stx_rdev_minor = fields.Integer(required=True)
stx_dev_major = fields.Integer(required=True)
stx_dev_minor = fields.Integer(required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('StructStatx',
['stx_mask', 'stx_blksize', 'stx_attributes', 'stx_nlink', 'stx_uid',
'stx_gid', 'stx_mode', 'stx_ino', 'stx_size', 'stx_blocks', 'stx_attributes_mask',
'stx_atime', 'stx_btime', 'stx_ctime', 'stx_mtime', 'stx_rdev_major',
'stx_rdev_minor', 'stx_dev_major', 'stx_dev_minor'])(**data)
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
class DirentStruct(Schema):
"""Schema that deserializes a struct dirent"""
d_ino = fields.Integer(required=True)
d_off = fields.Integer(required=True)
d_reclen = fields.Integer(required=True)
d_type = fields.Integer(required=True)
d_name = fields.Str(required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('DirentStruct',
['d_ino', 'd_off', 'd_reclen', 'd_type', 'd_name'])(**data)
class MkdirOutputSchema(Schema):
"""Schema to deserialize the results of a mkdir() execution"""
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('MkdirReturn', ['retval', 'errno'])(**data)
class OpenOutputSchema(Schema):
"""Schema to deserialize the results of an open() execution"""
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('OpenReturn', ['retval', 'errno'])(**data)
class OpendirOutputSchema(Schema):
"""Schema to deserialize the results of an opendir() execution"""
dirp = DIR_p(required=True, allow_none=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('OpendirReturn', ['dirp', 'errno'])(**data)
class ReadOutputSchema(Schema):
"""Schema to deserialize the results of a read() execution"""
buf = ByteList(allow_none=True)
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('ReadReturn', ['buf', 'retval', 'errno'])(**data)
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
class PreadOutputSchema(Schema):
"""Schema to deserialize the results of a pread() execution"""
buf = ByteList(allow_none=True)
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('PReadReturn', ['buf', 'retval', 'errno'])(**data)
class ReadvOutputSchema(Schema):
"""Schema to deserialize the results of a read() execution"""
buf_0 = ByteList(allow_none=True)
buf_1 = ByteList(allow_none=True)
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('ReadvReturn', ['buf_0', 'buf_1', 'retval', 'errno'])(**data)
class PreadvOutputSchema(Schema):
"""Schema to deserialize the results of a read() execution"""
buf_0 = ByteList(allow_none=True)
buf_1 = ByteList(allow_none=True)
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('PReadvReturn', ['buf_0', 'buf_1', 'retval', 'errno'])(**data)
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
class ReaddirOutputSchema(Schema):
"""Schema to deserialize the results of a readdir() execution"""
dirents = fields.List(fields.Nested(DirentStruct), allow_none=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('ReaddirReturn', ['dirents', 'errno'])(**data)
class RmdirOutputSchema(Schema):
"""Schema to deserialize the results of an opendir() execution"""
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('RmdirReturn', ['retval', 'errno'])(**data)
class WriteOutputSchema(Schema):
"""Schema to deserialize the results of a write() execution"""
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('WriteReturn', ['retval', 'errno'])(**data)
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
class PwriteOutputSchema(Schema):
"""Schema to deserialize the results of a pwrite() execution"""
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('PWriteReturn', ['retval', 'errno'])(**data)
class WritevOutputSchema(Schema):
"""Schema to deserialize the results of a writev() execution"""
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('WritevReturn', ['retval', 'errno'])(**data)
class PwritevOutputSchema(Schema):
"""Schema to deserialize the results of a writev() execution"""
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('PWritevReturn', ['retval', 'errno'])(**data)
class StatOutputSchema(Schema):
"""Schema to deserialize the results of a stat() execution"""
retval = fields.Integer(required=True)
statbuf = fields.Nested(StructStatSchema, required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('StatReturn', ['retval', 'statbuf', 'errno'])(**data)
class StatxOutputSchema(Schema):
"""Schema to deserialize the results of a stat() execution"""
retval = fields.Integer(required=True)
statbuf = fields.Nested(StructStatxSchema, required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('StatxReturn', ['retval', 'statbuf', 'errno'])(**data)
class LseekOutputSchema(Schema):
"""Schema to deserialize the results of an open() execution"""
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('LseekReturn', ['retval', 'errno'])(**data)
class WriteReadOutputSchema(Schema):
"""Schema to deserialize the results of a write() execution"""
retval = fields.Integer(required=True)
errno = Errno(data_key='errnum', required=True)
@post_load
def make_object(self, data, **kwargs):
return namedtuple('WriteReadReturn', ['retval', 'errno'])(**data)
class IOParser:
OutputSchemas = {
'mkdir' : MkdirOutputSchema(),
'open' : OpenOutputSchema(),
'opendir' : OpendirOutputSchema(),
'read' : ReadOutputSchema(),
'pread' : PreadOutputSchema(),
'readv' : ReadvOutputSchema(),
'preadv' : PreadvOutputSchema(),
'readdir' : ReaddirOutputSchema(),
'rmdir' : RmdirOutputSchema(),
'write' : WriteOutputSchema(),
'pwrite' : PwriteOutputSchema(),
'writev' : WritevOutputSchema(),
'pwritev' : PwritevOutputSchema(),
'stat' : StatOutputSchema(),
'statx' : StatxOutputSchema(),
'lseek' : LseekOutputSchema(),
'write_read' : WriteReadOutputSchema(),
}
def parse(self, command, output):
if command in self.OutputSchemas:
return self.OutputSchemas[command].loads(output)
else:
raise ValueError(f"Unknown I/O command {cmd}")