2 # -*- coding: utf-8 -*-
4 # Copyright (c) 2014-2018. 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, thetype):
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)))
47 print (' return simcall_BODY_%s(%s);' % (self.name, "..."))
51 # smx_*.c void simcall_HANDLER_host_on(smx_simcall_t simcall,
53 if self.simcalls_pre is None:
54 self.simcalls_pre = set()
55 for fn in glob.glob('smx_*') + glob.glob('ActorImpl*') + glob.glob('../mc/*cpp') + glob.glob('../kernel/activity/*cpp'):
57 self.simcalls_pre |= set(re.findall(r'simcall_HANDLER_(.*?)\(', f.read()))
60 if self.name not in self.simcalls_pre:
61 print ('# ERROR: No function called simcall_HANDLER_%s' % self.name)
62 print ('# Add something like this to the relevant C file (like smx_io.c if it\'s an IO call):')
63 print ('%s simcall_HANDLER_%s(smx_simcall_t simcall%s)' % (self.res.rettype(), self.name, ''.
64 join(', %s %s' % (arg.rettype(), arg.name)for arg in self.args)))
66 print (' // Your code handling the simcall')
70 if self.name in self.simcalls_pre:
71 print ('# ERROR: You have a function called simcall_HANDLER_%s, but that simcall is not using any handler' % self.name)
72 print ('# Either change your simcall definition, or kill that function')
77 return ' SIMCALL_%s,' % (self.name.upper())
80 return ' "SIMCALL_%s",' % self.name.upper()
85 regex = re.compile(r"^boost::intrusive_ptr<(.*?)>(.*)$") # to compute the raw type
86 # Arguments getter/setters
87 for i in range(len(self.args)):
89 rawtype = regex.sub(r'\1*\2', arg.rettype())
90 res.append('static inline %s simcall_%s__get__%s(smx_simcall_t simcall)' % (
91 arg.rettype(), self.name, arg.name))
93 res.append(' return simgrid::simix::unmarshal<%s>(simcall->args[%i]);' % (arg.rettype(), i))
95 res.append('static inline %s simcall_%s__getraw__%s(smx_simcall_t simcall)' % (
96 rawtype, self.name, arg.name))
98 res.append(' return simgrid::simix::unmarshal_raw<%s>(simcall->args[%i]);' % (rawtype, i))
100 res.append('static inline void simcall_%s__set__%s(smx_simcall_t simcall, %s arg)' % (
101 self.name, arg.name, arg.rettype()))
103 res.append(' simgrid::simix::marshal<%s>(simcall->args[%i], arg);' % (arg.rettype(), i))
106 # Return value getter/setters
107 if self.res.type != 'void':
108 rawtype = regex.sub(r'\1*\2', self.res.rettype())
110 'static inline %s simcall_%s__get__result(smx_simcall_t simcall)' % (self.res.rettype(), self.name))
112 res.append(' return simgrid::simix::unmarshal<%s>(simcall->result);' % self.res.rettype())
114 res.append('static inline %s simcall_%s__getraw__result(smx_simcall_t simcall)' % (rawtype, self.name))
116 res.append(' return simgrid::simix::unmarshal_raw<%s>(simcall->result);' % rawtype)
119 'static inline void simcall_%s__set__result(smx_simcall_t simcall, %s result)' % (self.name, self.res.rettype()))
121 res.append(' simgrid::simix::marshal<%s>(simcall->result, result);' % (self.res.rettype()))
123 return '\n'.join(res)
127 args = [ "simgrid::simix::unmarshal<%s>(simcall->args[%d])" % (arg.rettype(), i)
128 for i, arg in enumerate(self.args) ]
129 res.append('case SIMCALL_%s:' % (self.name.upper()))
130 if self.need_handler:
131 call = "simcall_HANDLER_%s(simcall%s%s)" % (self.name,
132 ", " if len(args) > 0 else "",
135 call = "SIMIX_%s(%s)" % (self.name, ', '.join(args))
136 if self.call_kind == 'Func':
137 res.append(" simgrid::simix::marshal<%s>(simcall->result, %s);" % (self.res.rettype(), call))
139 res.append(" " + call + ";");
140 if self.call_kind != 'Blck':
141 res.append(' SIMIX_simcall_answer(simcall);')
142 res.append(' break;')
144 return '\n'.join(res)
149 'inline static %s simcall_BODY_%s(%s)' % (self.res.rettype(),
151 ', '.join('%s %s' % (arg.rettype(), arg.name) for arg in self.args)))
153 res.append(' if (0) /* Go to that function to follow the code flow through the simcall barrier */')
154 if self.need_handler:
155 res.append(' simcall_HANDLER_%s(%s);' % (self.name,
156 ', '.join(["&SIMIX_process_self()->simcall"] + [arg.name for arg in self.args])))
158 res.append(' SIMIX_%s(%s);' % (self.name,
159 ', '.join(arg.name for arg in self.args)))
160 res.append(' return simcall<%s%s>(SIMCALL_%s%s);' % (
162 "".join([ ", " + arg.rettype() for i, arg in enumerate(self.args) ]),
164 "".join([ ", " + arg.name for i, arg in enumerate(self.args) ])
167 return '\n'.join(res)
169 def handler_prototype(self):
170 if self.need_handler:
171 return "XBT_PRIVATE %s simcall_HANDLER_%s(smx_simcall_t simcall%s);" % (self.res.rettype() if self.call_kind == 'Func' else 'void',
173 ''.join(', %s %s' % (arg.rettype(), arg.name)
174 for i, arg in enumerate(self.args)))
182 simcalls_guarded = {}
183 for line in open(fn).read().split('\n'):
184 if line.startswith('##'):
186 simcalls_guarded[re.search(r'## *(.*)', line).group(1)] = resdi
187 if line.startswith('#') or not line:
190 r'^(\S+)\s+([^\)\(\s]+)\s*\(*(.*)\)\s*(\[\[.*\]\])?\s*;\s*?$', line)
192 ret, name, args, attrs = match.groups()
194 if not re.match(r"^\s*$", args):
195 for arg in re.split(",", args):
197 match = re.match(r"^(.*?)\s*?(\S+)$", arg)
198 t, n = match.groups()
201 sargs.append(Arg(n, t))
209 for attr in re.split(",", attrs):
212 elif attr == "nohandler":
215 assert False, "Unknown attribute %s in: %s" % (attr, line)
216 sim = Simcall(name, handler, Arg('result', ret), sargs, ans)
221 return simcalls, simcalls_guarded
227 '/**********************************************************************/\n')
229 '/* File generated by src/simix/simcalls.py from src/simix/simcalls.in */\n')
233 '/* DO NOT EVER CHANGE THIS FILE */\n')
237 '/* change simcalls specification in src/simix/simcalls.in */\n')
239 '/* Copyright (c) 2014-2018. The SimGrid Team. All rights reserved. */\n')
241 '/**********************************************************************/\n\n')
244 ' * Note that the name comes from http://en.wikipedia.org/wiki/Popping\n')
246 ' * Indeed, the control flow is doing a strange dance in there.\n')
249 ' * That\'s not about http://en.wikipedia.org/wiki/Poop, despite the odor :)\n')
254 def handle(fd, func, simcalls, guarded_simcalls):
257 fd.write('\n'.join(filter(nonempty, (func(simcall) for simcall in simcalls))))
259 for guard, ll in guarded_simcalls.items():
260 fd.write('\n#if %s\n' % (guard))
261 fd.write('\n'.join(func(simcall) for simcall in ll))
262 fd.write('\n#endif\n')
264 if __name__ == '__main__':
265 simcalls, simcalls_dict = parse('simcalls.in')
268 ok &= all(map(Simcall.check, simcalls))
269 for k, v in simcalls_dict.items():
270 ok &= all(map(Simcall.check, v))
271 # FIXME: we should not hide it
273 # print ("Some checks fail!")
277 # popping_accessors.hpp
279 fd = header('popping_accessors.hpp')
280 fd.write('#include "src/simix/popping_private.hpp"');
281 handle(fd, Simcall.accessors, simcalls, simcalls_dict)
283 "\n\n/* The prototype of all simcall handlers, automatically generated for you */\n\n")
284 handle(fd, Simcall.handler_prototype, simcalls, simcalls_dict)
290 fd = header("popping_enum.h")
292 fd.write(' * @brief All possible simcalls.\n')
294 fd.write('typedef enum {\n')
295 fd.write(' SIMCALL_NONE,\n')
297 handle(fd, Simcall.enum, simcalls, simcalls_dict)
300 fd.write(' NUM_SIMCALLS\n')
301 fd.write('} e_smx_simcall_t;\n')
305 # popping_generated.cpp
308 fd = header("popping_generated.cpp")
310 fd.write('#include "smx_private.hpp"\n')
311 fd.write('#include <xbt/base.h>\n')
312 fd.write('#if SIMGRID_HAVE_MC\n')
313 fd.write('#include "src/mc/mc_forward.hpp"\n')
315 fd.write('#include "src/kernel/activity/ConditionVariableImpl.hpp"\n')
316 fd.write('#include "src/simix/smx_host_private.hpp"\n')
317 fd.write('#include "src/simix/smx_synchro_private.hpp"\n')
320 fd.write('XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_popping);\n\n')
323 '/** @brief Simcalls\' names (generated from src/simix/simcalls.in) */\n')
324 fd.write('const char* simcall_names[] = {\n')
326 fd.write(' "SIMCALL_NONE",\n')
327 handle(fd, Simcall.string, simcalls, simcalls_dict)
331 fd.write('/** @private\n')
333 ' * @brief (in kernel mode) unpack the simcall and activate the handler\n')
335 fd.write(' * This function is generated from src/simix/simcalls.in\n')
338 'void SIMIX_simcall_handle(smx_simcall_t simcall, int value) {\n')
340 ' XBT_DEBUG("Handling simcall %p: %s", simcall, SIMIX_simcall_name(simcall->call));\n')
341 fd.write(' SIMCALL_SET_MC_VALUE(simcall, value);\n')
343 ' if (simcall->issuer->context->iwannadie)\n')
344 fd.write(' return;\n')
345 fd.write(' switch (simcall->call) {\n')
347 handle(fd, Simcall.case, simcalls, simcalls_dict)
349 fd.write(' case NUM_SIMCALLS:\n')
350 fd.write(' break;\n')
351 fd.write(' case SIMCALL_NONE:\n')
352 fd.write(' THROWF(arg_error,0,"Asked to do the noop syscall on %s@%s",\n')
353 fd.write(' simcall->issuer->name.c_str(),\n')
354 fd.write(' sg_host_get_name(simcall->issuer->host)\n')
356 fd.write(' break;\n')
357 fd.write(' default:\n')
358 fd.write(' THROW_IMPOSSIBLE;\n')
367 fd = header('popping_bodies.cpp')
368 fd.write('#include "smx_private.hpp"\n')
369 fd.write('#include "src/mc/mc_forward.hpp"\n')
370 fd.write('#include "src/simix/smx_synchro_private.hpp"\n')
371 fd.write('#include "xbt/ex.h"\n')
372 fd.write('#include <functional>\n')
373 fd.write('#include <simgrid/simix.hpp>\n')
375 fd.write("/** @cond */ // Please Doxygen, don't look at this\n")
377 template<class R, class... T>
378 inline static R simcall(e_smx_simcall_t call, T const&... t)
380 smx_actor_t self = SIMIX_process_self();
381 simgrid::simix::marshal(&self->simcall, call, t...);
382 if (self != simix_global->maestro_process) {
383 XBT_DEBUG("Yield process '%s' on simcall %s (%d)", self->name.c_str(),
384 SIMIX_simcall_name(self->simcall.call), (int)self->simcall.call);
385 SIMIX_process_yield(self);
387 SIMIX_simcall_handle(&self->simcall, 0);
389 return simgrid::simix::unmarshal<R>(self->simcall.result);
392 handle(fd, Simcall.body, simcalls, simcalls_dict)
393 fd.write(" /** @endcond */\n");