src/simix/simcalls.py

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