2 # -*- coding: utf-8 -*-
4 # Copyright (c) 2014-2017. The SimGrid Team. All rights reserved.
6 # This program is free software; you can redistribute it and/or modify it
7 # under the terms of the license (GNU LGPL) which comes with this package.
14 def __init__(self, name, type):
19 return self.simcall_types[self.type]
24 class Simcall(object):
28 def __init__(self, name, handler, res, args, call_kind):
32 self.need_handler = handler
33 self.call_kind = call_kind
36 # libsmx.c simcall_BODY_
37 if self.simcalls_BODY is None:
38 f = open('libsmx.cpp')
39 self.simcalls_BODY = set(re.findall(r'simcall_BODY_(.*?)\(', f.read()))
41 if self.name not in self.simcalls_BODY:
42 print ('# ERROR: No function calling simcall_BODY_%s' % self.name)
43 print ('# Add something like this to libsmx.c:')
44 print ('%s simcall_%s(%s) {' % (self.res.rettype(), self.name, ', '.
45 join('%s %s' % (arg.rettype(), arg.name) for arg in self.args)))
46 print (' return simcall_BODY_%s(%s);' % (self.name, "..."))
50 # smx_*.c void simcall_HANDLER_host_on(smx_simcall_t simcall,
52 if self.simcalls_PRE is None:
53 self.simcalls_PRE = set()
54 for fn in glob.glob('smx_*') + glob.glob('ActorImpl*') + glob.glob('../mc/*cpp'):
56 self.simcalls_PRE |= set(re.findall(r'simcall_HANDLER_(.*?)\(', f.read()))
59 if self.name not in self.simcalls_PRE:
60 print ('# ERROR: No function called simcall_HANDLER_%s' % self.name)
61 print ('# Add something like this to the relevant C file (like smx_io.c if it\'s an IO call):')
62 print ('%s simcall_HANDLER_%s(smx_simcall_t simcall%s) {' % (self.res.rettype(), self.name, ''.
63 join(', %s %s' % (arg.rettype(), arg.name)for arg in self.args)))
64 print (' // Your code handling the simcall')
68 if self.name in self.simcalls_PRE:
69 print ('# ERROR: You have a function called simcall_HANDLER_%s, but that simcall is not using any handler' % self.name)
70 print ('# Either change your simcall definition, or kill that function')
75 return ' SIMCALL_%s,' % (self.name.upper())
78 return ' "SIMCALL_%s",' % self.name.upper()
83 # Arguments getter/setters
84 for i in range(len(self.args)):
86 res.append('static inline %s simcall_%s__get__%s(smx_simcall_t simcall) {' % (
87 arg.rettype(), self.name, arg.name))
89 ' return simgrid::simix::unmarshal<%s>(simcall->args[%i]);' % (arg.rettype(), i))
91 res.append('static inline void simcall_%s__set__%s(smx_simcall_t simcall, %s arg) {' % (
92 self.name, arg.name, arg.rettype()))
93 res.append(' simgrid::simix::marshal<%s>(simcall->args[%i], arg);' % (arg.rettype(), i))
96 # Return value getter/setters
97 if self.res.type != 'void':
99 'static inline %s simcall_%s__get__result(smx_simcall_t simcall){' % (self.res.rettype(), self.name))
100 res.append(' return simgrid::simix::unmarshal<%s>(simcall->result);' % self.res.rettype())
103 'static inline void simcall_%s__set__result(smx_simcall_t simcall, %s result){' % (self.name, self.res.rettype()))
104 res.append(' simgrid::simix::marshal<%s>(simcall->result, result);' % (self.res.rettype()))
106 return '\n'.join(res)
110 args = [ "simgrid::simix::unmarshal<%s>(simcall->args[%d])" % (arg.rettype(), i)
111 for i, arg in enumerate(self.args) ]
112 res.append('case SIMCALL_%s:' % (self.name.upper()))
113 if self.need_handler:
114 call = "simcall_HANDLER_%s(simcall%s%s)" % (self.name,
115 ", " if len(args) > 0 else "",
118 call = "SIMIX_%s(%s)" % (self.name, ', '.join(args))
119 if self.call_kind == 'Func':
120 res.append(" simgrid::simix::marshal<%s>(simcall->result, %s);" % (self.res.rettype(), call))
122 res.append(" " + call + ";");
123 if self.call_kind != 'Blck':
124 res.append(' SIMIX_simcall_answer(simcall);')
125 res.append(' break;')
127 return '\n'.join(res)
132 'inline static %s simcall_BODY_%s(%s) {' % (self.res.rettype(),
134 ', '.join('%s %s' % (arg.rettype(), arg.name) for arg in self.args)))
136 ' /* Go to that function to follow the code flow through the simcall barrier */')
137 if self.need_handler:
138 res.append(' if (0) simcall_HANDLER_%s(%s);' % (self.name,
139 ', '.join(["&SIMIX_process_self()->simcall"] + [arg.name for arg in self.args])))
141 res.append(' if (0) SIMIX_%s(%s);' % (self.name,
142 ', '.join(arg.name for arg in self.args)))
143 res.append(' return simcall<%s%s>(SIMCALL_%s%s);' % (
145 "".join([ ", " + arg.rettype() for i, arg in enumerate(self.args) ]),
147 "".join([ ", " + arg.name for i, arg in enumerate(self.args) ])
150 return '\n'.join(res)
152 def handler_prototype(self):
153 if self.need_handler:
154 return "XBT_PRIVATE %s simcall_HANDLER_%s(smx_simcall_t simcall%s);" % (self.res.rettype() if self.call_kind == 'Func' else 'void',
156 ''.join(', %s %s' % (arg.rettype(), arg.name)
157 for i, arg in enumerate(self.args)))
165 simcalls_guarded = {}
166 for line in open(fn).read().split('\n'):
167 if line.startswith('##'):
169 simcalls_guarded[re.search(r'## *(.*)', line).group(1)] = resdi
170 if line.startswith('#') or not line:
173 r'^(\S+)\s+([^\)\(\s]+)\s*\(*(.*)\)\s*(\[\[.*\]\])?\s*;\s*?$', line)
175 ret, name, args, attrs = match.groups()
177 if not re.match(r"^\s*$", args):
178 for arg in re.split(",", args):
180 match = re.match(r"^(.*?)\s*?(\S+)$", arg)
181 t, n = match.groups()
184 sargs.append(Arg(n, t))
192 for attr in re.split(",", attrs):
195 elif attr == "nohandler":
198 assert False, "Unknown attribute %s in: %s" % (attr, line)
199 sim = Simcall(name, handler, Arg('result', ret), sargs, ans)
204 return simcalls, simcalls_guarded
210 '/**********************************************************************/\n')
212 '/* File generated by src/simix/simcalls.py from src/simix/simcalls.in */\n')
216 '/* DO NOT EVER CHANGE THIS FILE */\n')
220 '/* change simcalls specification in src/simix/simcalls.in */\n')
222 '/**********************************************************************/\n\n')
225 ' * Note that the name comes from http://en.wikipedia.org/wiki/Popping\n')
227 ' * Indeed, the control flow is doing a strange dance in there.\n')
230 ' * That\'s not about http://en.wikipedia.org/wiki/Poop, despite the odor :)\n')
235 def handle(fd, func, simcalls, guarded_simcalls):
238 fd.write('\n'.join(filter(nonempty, (func(simcall) for simcall in simcalls))))
240 for guard, list in guarded_simcalls.items():
241 fd.write('\n#if %s\n' % (guard))
242 fd.write('\n'.join(func(simcall) for simcall in list))
243 fd.write('\n#endif\n')
245 if __name__ == '__main__':
247 simcalls, simcalls_dict = parse('simcalls.in')
250 ok &= all(map(Simcall.check, simcalls))
251 for k, v in simcalls_dict.items():
252 ok &= all(map(Simcall.check, v))
253 # FIXME: we should not hide it
255 # print ("Some checks fail!")
259 # smx_popping_accessors.c
261 fd = header('popping_accessors.h')
262 fd.write('#include "src/simix/popping_private.h"');
263 handle(fd, Simcall.accessors, simcalls, simcalls_dict)
265 "\n\n/* The prototype of all simcall handlers, automatically generated for you */\n\n")
266 handle(fd, Simcall.handler_prototype, simcalls, simcalls_dict)
272 fd = header("popping_enum.h")
274 fd.write(' * @brief All possible simcalls.\n')
276 fd.write('typedef enum {\n')
277 fd.write(' SIMCALL_NONE,\n')
279 handle(fd, Simcall.enum, simcalls, simcalls_dict)
281 fd.write(' NUM_SIMCALLS\n')
282 fd.write('} e_smx_simcall_t;\n')
286 # smx_popping_generated.cpp
289 fd = header("popping_generated.cpp")
291 fd.write('#include <xbt/base.h>\n')
292 fd.write('#include "smx_private.h"\n')
293 fd.write('#if HAVE_MC\n')
294 fd.write('#include "src/mc/mc_forward.hpp"\n')
297 fd.write('XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_popping);\n\n')
300 '/** @brief Simcalls\' names (generated from src/simix/simcalls.in) */\n')
301 fd.write('const char* simcall_names[] = {\n')
303 fd.write(' "SIMCALL_NONE",\n')
304 handle(fd, Simcall.string, simcalls, simcalls_dict)
308 fd.write('/** @private\n')
310 ' * @brief (in kernel mode) unpack the simcall and activate the handler\n')
312 fd.write(' * This function is generated from src/simix/simcalls.in\n')
315 'void SIMIX_simcall_handle(smx_simcall_t simcall, int value) {\n')
317 ' XBT_DEBUG("Handling simcall %p: %s", simcall, SIMIX_simcall_name(simcall->call));\n')
318 fd.write(' SIMCALL_SET_MC_VALUE(simcall, value);\n')
320 ' if (simcall->issuer->context->iwannadie && simcall->call != SIMCALL_PROCESS_CLEANUP)\n')
321 fd.write(' return;\n')
322 fd.write(' switch (simcall->call) {\n')
324 handle(fd, Simcall.case, simcalls, simcalls_dict)
326 fd.write(' case NUM_SIMCALLS:\n')
327 fd.write(' break;\n')
328 fd.write(' case SIMCALL_NONE:\n')
329 fd.write(' THROWF(arg_error,0,"Asked to do the noop syscall on %s@%s",\n')
330 fd.write(' simcall->issuer->name.c_str(),\n')
331 fd.write(' sg_host_get_name(simcall->issuer->host)\n')
333 fd.write(' break;\n')
341 # smx_popping_bodies.cpp
343 fd = header('popping_bodies.cpp')
344 fd.write('#include <functional>\n')
345 fd.write('#include "smx_private.h"\n')
346 fd.write('#include "src/mc/mc_forward.hpp"\n')
347 fd.write('#include "xbt/ex.h"\n')
348 fd.write('#include <simgrid/simix.hpp>\n')
349 fd.write("/** @cond */ // Please Doxygen, don't look at this\n")
351 template<class R, class... T>
352 inline static R simcall(e_smx_simcall_t call, T const&... t)
354 smx_actor_t self = SIMIX_process_self();
355 simgrid::simix::marshal(&self->simcall, call, t...);
356 if (self != simix_global->maestro_process) {
357 XBT_DEBUG("Yield process '%s' on simcall %s (%d)", self->name.c_str(),
358 SIMIX_simcall_name(self->simcall.call), (int)self->simcall.call);
359 SIMIX_process_yield(self);
361 SIMIX_simcall_handle(&self->simcall, 0);
363 return simgrid::simix::unmarshal<R>(self->simcall.result);
366 handle(fd, Simcall.body, simcalls, simcalls_dict)
367 fd.write("/** @endcond */\n");