Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
c25d5192f2535db76b8a33f5cd79711539594605
[simgrid.git] / src / simix / simcalls.py
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3
4 # Copyright (c) 2014-2019. The SimGrid Team. All rights reserved.
5
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.
8
9 import re
10 import glob
11
12
13 class Arg(object):
14
15     def __init__(self, name, thetype):
16         self.name = name
17         self.type = thetype
18
19     def field(self):
20         return self.simcall_types[self.type]
21
22     def rettype(self):
23         return self.type
24
25
26 class Simcall(object):
27     simcalls_body = None
28     simcalls_pre = None
29
30     def __init__(self, name, handler, res, args, call_kind):
31         self.name = name
32         self.res = res
33         self.args = args
34         self.need_handler = handler
35         self.call_kind = call_kind
36
37     def check(self):
38         # libsmx.c  simcall_BODY_
39         if self.simcalls_body is None:
40             f = open('libsmx.cpp')
41             self.simcalls_body = set(re.findall(r'simcall_BODY_(.*?)\(', f.read()))
42             f.close()
43         if self.name not in self.simcalls_body:
44             print ('# ERROR: No function calling simcall_BODY_%s' % self.name)
45             print ('# Add something like this to libsmx.c:')
46             print ('%s simcall_%s(%s)' % (self.res.rettype(), self.name, ', '.
47                                           join('%s %s' % (arg.rettype(), arg.name) for arg in self.args)))
48             print ('{')
49             print ('  return simcall_BODY_%s(%s);' % (self.name, "..."))
50             print ('}')
51             return False
52
53         # smx_*.c void simcall_HANDLER_host_on(smx_simcall_t simcall,
54         # smx_host_t h)
55         if self.simcalls_pre is None:
56             self.simcalls_pre = set()
57             for fn in glob.glob('smx_*') + glob.glob('ActorImpl*') + \
58                     glob.glob('../mc/*cpp') + glob.glob('../kernel/activity/*cpp'):
59                 f = open(fn)
60                 self.simcalls_pre |= set(re.findall(r'simcall_HANDLER_(.*?)\(', f.read()))
61                 f.close()
62         if self.need_handler:
63             if self.name not in self.simcalls_pre:
64                 print ('# ERROR: No function called simcall_HANDLER_%s' % self.name)
65                 print ('# Add something like this to the relevant C file (like smx_io.c if it\'s an IO call):')
66                 print ('%s simcall_HANDLER_%s(smx_simcall_t simcall%s)' % (self.res.rettype(), self.name, ''.
67                                                                            join(', %s %s' % (arg.rettype(), arg.name)for arg in self.args)))
68                 print ('{')
69                 print ('  // Your code handling the simcall')
70                 print ('}')
71                 return False
72         else:
73             if self.name in self.simcalls_pre:
74                 print (
75                     '# ERROR: You have a function called simcall_HANDLER_%s, but that simcall is not using any handler' %
76                     self.name)
77                 print ('# Either change your simcall definition, or kill that function')
78                 return False
79         return True
80
81     def enum(self):
82         return '  SIMCALL_%s,' % (self.name.upper())
83
84     def string(self):
85         return '    "SIMCALL_%s",' % self.name.upper()
86
87     def accessors(self):
88         res = []
89         res.append('')
90         regex = re.compile(r"^boost::intrusive_ptr<(.*?)>(.*)$")  # ┬áto compute the raw type
91         # Arguments getter/setters
92         for i in range(len(self.args)):
93             arg = self.args[i]
94             rawtype = regex.sub(r'\1*\2', arg.rettype())
95             res.append('static inline %s simcall_%s__get__%s(smx_simcall_t simcall)' % (
96                 arg.rettype(), self.name, arg.name))
97             res.append('{')
98             res.append('  return simgrid::simix::unmarshal<%s>(simcall->args[%i]);' % (arg.rettype(), i))
99             res.append('}')
100             res.append('static inline %s simcall_%s__getraw__%s(smx_simcall_t simcall)' % (
101                 rawtype, self.name, arg.name))
102             res.append('{')
103             res.append('  return simgrid::simix::unmarshal_raw<%s>(simcall->args[%i]);' % (rawtype, i))
104             res.append('}')
105             res.append('static inline void simcall_%s__set__%s(smx_simcall_t simcall, %s arg)' % (
106                 self.name, arg.name, arg.rettype()))
107             res.append('{')
108             res.append('  simgrid::simix::marshal<%s>(simcall->args[%i], arg);' % (arg.rettype(), i))
109             res.append('}')
110
111         # Return value getter/setters
112         if self.res.type != 'void':
113             rawtype = regex.sub(r'\1*\2', self.res.rettype())
114             res.append(
115                 'static inline %s simcall_%s__get__result(smx_simcall_t simcall)' % (self.res.rettype(), self.name))
116             res.append('{')
117             res.append('  return simgrid::simix::unmarshal<%s>(simcall->result);' % self.res.rettype())
118             res.append('}')
119             res.append('static inline %s simcall_%s__getraw__result(smx_simcall_t simcall)' % (rawtype, self.name))
120             res.append('{')
121             res.append('  return simgrid::simix::unmarshal_raw<%s>(simcall->result);' % rawtype)
122             res.append('}')
123             res.append(
124                 'static inline void simcall_%s__set__result(smx_simcall_t simcall, %s result)' % (self.name, self.res.rettype()))
125             res.append('{')
126             res.append('  simgrid::simix::marshal<%s>(simcall->result, result);' % (self.res.rettype()))
127             res.append('}')
128         return '\n'.join(res)
129
130     def case(self):
131         res = []
132         args = ["simgrid::simix::unmarshal<%s>(simcall->args[%d])" % (arg.rettype(), i)
133                 for i, arg in enumerate(self.args)]
134         res.append('case SIMCALL_%s:' % (self.name.upper()))
135         if self.need_handler:
136             call = "simcall_HANDLER_%s(simcall%s%s)" % (self.name,
137                                                         ", " if len(args) > 0 else "",
138                                                         ', '.join(args))
139         else:
140             call = "SIMIX_%s(%s)" % (self.name, ', '.join(args))
141         if self.call_kind == 'Func':
142             res.append("  simgrid::simix::marshal<%s>(simcall->result, %s);" % (self.res.rettype(), call))
143         else:
144             res.append("  " + call + ";")
145         if self.call_kind != 'Blck':
146             res.append('  SIMIX_simcall_answer(simcall);')
147         res.append('  break;')
148         res.append('')
149         return '\n'.join(res)
150
151     def body(self):
152         res = ['']
153         res.append(
154             'inline static %s simcall_BODY_%s(%s)' % (self.res.rettype(),
155                                                       self.name,
156                                                       ', '.join('%s %s' % (arg.rettype(), arg.name) for arg in self.args)))
157         res.append('{')
158         res.append('  if (0) /* Go to that function to follow the code flow through the simcall barrier */')
159         if self.need_handler:
160             res.append('    simcall_HANDLER_%s(%s);' % (self.name,
161                                                         ', '.join(["&SIMIX_process_self()->simcall"] + [arg.name for arg in self.args])))
162         else:
163             res.append('    SIMIX_%s(%s);' % (self.name,
164                                               ', '.join(arg.name for arg in self.args)))
165         res.append('  return simcall<%s%s>(SIMCALL_%s%s);' % (
166             self.res.rettype(),
167             "".join([", " + arg.rettype() for i, arg in enumerate(self.args)]),
168             self.name.upper(),
169             "".join([", " + arg.name for i, arg in enumerate(self.args)])
170         ))
171         res.append('}')
172         return '\n'.join(res)
173
174     def handler_prototype(self):
175         if self.need_handler:
176             return "XBT_PRIVATE %s simcall_HANDLER_%s(smx_simcall_t simcall%s);" % (self.res.rettype() if self.call_kind == 'Func' else 'void',
177                                                                                     self.name,
178                                                                                     ''.join(', %s %s' % (arg.rettype(), arg.name)
179                                                                                             for i, arg in enumerate(self.args)))
180         else:
181             return ""
182
183
184 def parse(fn):
185     simcalls = []
186     resdi = None
187     simcalls_guarded = {}
188     for line in open(fn).read().split('\n'):
189         if line.startswith('##'):
190             resdi = []
191             simcalls_guarded[re.search(r'## *(.*)', line).group(1)] = resdi
192         if line.startswith('#') or not line:
193             continue
194         match = re.match(
195             r'^(\S+)\s+([^\)\(\s]+)\s*\(*(.*)\)\s*(\[\[.*\]\])?\s*;\s*?$', line)
196         assert match, line
197         ret, name, args, attrs = match.groups()
198         sargs = []
199         if not re.match(r"^\s*$", args):
200             for arg in re.split(",", args):
201                 args = args.strip()
202                 match = re.match(r"^(.*?)\s*?(\S+)$", arg)
203                 t, n = match.groups()
204                 t = t.strip()
205                 n = n.strip()
206                 sargs.append(Arg(n, t))
207         if ret == "void":
208             ans = "Proc"
209         else:
210             ans = "Func"
211         handler = True
212         if attrs:
213             attrs = attrs[2:-2]
214             for attr in re.split(",", attrs):
215                 if attr == "block":
216                     ans = "Blck"
217                 elif attr == "nohandler":
218                     handler = False
219                 else:
220                     assert False, "Unknown attribute %s in: %s" % (attr, line)
221         sim = Simcall(name, handler, Arg('result', ret), sargs, ans)
222         if resdi is None:
223             simcalls.append(sim)
224         else:
225             resdi.append(sim)
226     return simcalls, simcalls_guarded
227
228
229 def header(name):
230     fd = open(name, 'w')
231     fd.write(
232         '/**********************************************************************/\n')
233     fd.write(
234         '/* File generated by src/simix/simcalls.py from src/simix/simcalls.in */\n')
235     fd.write(
236         '/*                                                                    */\n')
237     fd.write(
238         '/*                    DO NOT EVER CHANGE THIS FILE                    */\n')
239     fd.write(
240         '/*                                                                    */\n')
241     fd.write(
242         '/* change simcalls specification in src/simix/simcalls.in             */\n')
243     fd.write(
244         '/* Copyright (c) 2014-2019. The SimGrid Team. All rights reserved.    */\n')
245     fd.write(
246         '/**********************************************************************/\n\n')
247     fd.write('/*\n')
248     fd.write(
249         ' * Note that the name comes from http://en.wikipedia.org/wiki/Popping\n')
250     fd.write(
251         ' * Indeed, the control flow is doing a strange dance in there.\n')
252     fd.write(' *\n')
253     fd.write(
254         ' * That\'s not about http://en.wikipedia.org/wiki/Poop, despite the odor :)\n')
255     fd.write(' */\n\n')
256     return fd
257
258
259 def handle(fd, func, simcalls, guarded_simcalls):
260     def nonempty(e):
261         return e != ''
262     fd.write('\n'.join(filter(nonempty, (func(simcall) for simcall in simcalls))))
263
264     for guard, ll in guarded_simcalls.items():
265         fd.write('\n#if %s\n' % (guard))
266         fd.write('\n'.join(func(simcall) for simcall in ll))
267         fd.write('\n#endif\n')
268
269
270 if __name__ == '__main__':
271     simcalls, simcalls_dict = parse('simcalls.in')
272
273     ok = True
274     ok &= all(map(Simcall.check, simcalls))
275     for k, v in simcalls_dict.items():
276         ok &= all(map(Simcall.check, v))
277     # FIXME: we should not hide it
278     # if not ok:
279     #  print ("Some checks fail!")
280     #  sys.exit(1)
281
282     #
283     # popping_accessors.hpp
284     #
285     fd = header('popping_accessors.hpp')
286     fd.write('#include "src/simix/popping_private.hpp"')
287     handle(fd, Simcall.accessors, simcalls, simcalls_dict)
288     fd.write(
289         "\n\n/* The prototype of all simcall handlers, automatically generated for you */\n\n")
290     handle(fd, Simcall.handler_prototype, simcalls, simcalls_dict)
291     fd.close()
292
293     #
294     # popping_enum.h
295     #
296     fd = header("popping_enum.h")
297     fd.write('/**\n')
298     fd.write(' * @brief All possible simcalls.\n')
299     fd.write(' */\n')
300     fd.write('typedef enum {\n')
301     fd.write('  SIMCALL_NONE,\n')
302
303     handle(fd, Simcall.enum, simcalls, simcalls_dict)
304
305     fd.write('\n')
306     fd.write('  NUM_SIMCALLS\n')
307     fd.write('} e_smx_simcall_t;\n')
308     fd.close()
309
310     #
311     # popping_generated.cpp
312     #
313
314     fd = header("popping_generated.cpp")
315
316     fd.write('#include "smx_private.hpp"\n')
317     fd.write('#include <xbt/base.h>\n')
318     fd.write('#if SIMGRID_HAVE_MC\n')
319     fd.write('#include "src/mc/mc_forward.hpp"\n')
320     fd.write('#endif\n')
321     fd.write('#include "src/kernel/activity/ConditionVariableImpl.hpp"\n')
322
323     fd.write('\n')
324     fd.write('XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_popping);\n\n')
325
326     fd.write(
327         '/** @brief Simcalls\' names (generated from src/simix/simcalls.in) */\n')
328     fd.write('const char* simcall_names[] = {\n')
329
330     fd.write('    "SIMCALL_NONE",\n')
331     handle(fd, Simcall.string, simcalls, simcalls_dict)
332
333     fd.write('\n};\n\n')
334
335     fd.write('/** @private\n')
336     fd.write(
337         ' * @brief (in kernel mode) unpack the simcall and activate the handler\n')
338     fd.write(' *\n')
339     fd.write(' * This function is generated from src/simix/simcalls.in\n')
340     fd.write(' */\n')
341     fd.write(
342         'void SIMIX_simcall_handle(smx_simcall_t simcall, int value) {\n')
343     fd.write(
344         '  XBT_DEBUG("Handling simcall %p: %s", simcall, SIMIX_simcall_name(simcall->call));\n')
345     fd.write('  SIMCALL_SET_MC_VALUE(simcall, value);\n')
346     fd.write(
347         '  if (simcall->issuer->context_->iwannadie)\n')
348     fd.write('    return;\n')
349     fd.write('  switch (simcall->call) {\n')
350
351     handle(fd, Simcall.case, simcalls, simcalls_dict)
352
353     fd.write('    case NUM_SIMCALLS:\n')
354     fd.write('      break;\n')
355     fd.write('    case SIMCALL_NONE:\n')
356     fd.write('      THROWF(arg_error, 0, "Asked to do the noop syscall on %s@%s", simcall->issuer->get_cname(),\n')
357     fd.write('             sg_host_get_name(simcall->issuer->get_host()));\n')
358     fd.write('    default:\n')
359     fd.write('      THROW_IMPOSSIBLE;\n')
360     fd.write('  }\n')
361     fd.write('}\n')
362
363     fd.close()
364
365     #
366     # popping_bodies.cpp
367     #
368     fd = header('popping_bodies.cpp')
369     fd.write('#include "smx_private.hpp"\n')
370     fd.write('#include "src/mc/mc_forward.hpp"\n')
371     fd.write('#include "xbt/ex.h"\n')
372     fd.write('#include <functional>\n')
373     fd.write('#include <simgrid/simix.hpp>\n')
374
375     fd.write("/** @cond */ // Please Doxygen, don't look at this\n")
376     fd.write('''
377 template<class R, class... T>
378 inline static R simcall(e_smx_simcall_t call, T const&... t)
379 {
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->get_cname(), SIMIX_simcall_name(self->simcall.call),
384               (int)self->simcall.call);
385     self->yield();
386   } else {
387     SIMIX_simcall_handle(&self->simcall, 0);
388   }
389   return simgrid::simix::unmarshal<R>(self->simcall.result);
390 }
391 ''')
392     handle(fd, Simcall.body, simcalls, simcalls_dict)
393     fd.write(" /** @endcond */\n")
394     fd.close()