Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Kill popping_bodies.cpp
[simgrid.git] / src / simix / simcalls.py
index a0803c9..0671a0c 100755 (executable)
@@ -1,7 +1,7 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2014-2020. The SimGrid Team. All rights reserved.
+# Copyright (c) 2014-2022. The SimGrid Team. All rights reserved.
 
 # This program is free software; you can redistribute it and/or modify it
 # under the terms of the license (GNU LGPL) which comes with this package.
@@ -10,11 +10,12 @@ import re
 import glob
 import sys
 
-class Arg(object):
+class Arg:
 
     def __init__(self, name, thetype):
         self.name = name
         self.type = thetype
+        self.simcall_types = []
 
     def field(self):
         return self.simcall_types[self.type]
@@ -23,8 +24,7 @@ class Arg(object):
         return self.type
 
 
-class Simcall(object):
-    simcalls_body = None
+class Simcall:
     simcalls_pre = None
 
     def __init__(self, name, handler, res, args, call_kind):
@@ -35,21 +35,6 @@ class Simcall(object):
         self.call_kind = call_kind
 
     def check(self):
-        # libsmx.c  simcall_BODY_
-        if self.simcalls_body is None:
-            f = open('libsmx.cpp')
-            self.simcalls_body = set(re.findall(r'simcall_BODY_(.*?)\(', f.read()))
-            f.close()
-        if self.name not in self.simcalls_body:
-            print ('# ERROR: No function calling simcall_BODY_%s' % self.name)
-            print ('# Add something like this to libsmx.c:')
-            print ('%s simcall_%s(%s)' % (self.res.rettype(), self.name, ', '.
-                                          join('%s %s' % (arg.rettype(), arg.name) for arg in self.args)))
-            print ('{')
-            print ('  return simcall_BODY_%s(%s);' % (self.name, "..."))
-            print ('}')
-            return False
-
         # smx_*.c void simcall_HANDLER_host_on(smx_simcall_t simcall,
         # smx_host_t h)
         if self.simcalls_pre is None:
@@ -61,36 +46,35 @@ class Simcall(object):
                 f.close()
         if self.need_handler:
             if self.name not in self.simcalls_pre:
-                print ('# ERROR: No function called simcall_HANDLER_%s' % self.name)
-                print ('# Add something like this to the relevant C file (like smx_io.c if it\'s an IO call):')
-                print ('%s simcall_HANDLER_%s(smx_simcall_t simcall%s)' % (self.res.rettype(), self.name, ''.
-                                                                           join(', %s %s' % (arg.rettype(), arg.name)for arg in self.args)))
-                print ('{')
-                print ('  // Your code handling the simcall')
-                print ('}')
+                print('# ERROR: No function called simcall_HANDLER_%s' % self.name)
+                print('# Add something like this to the relevant C file (like smx_io.c if it\'s an IO call):')
+                print('%s simcall_HANDLER_%s(smx_simcall_t simcall%s)' % (self.res.rettype(), self.name, ''.
+                                                                          join(', %s %s' % (arg.rettype(), arg.name)for arg in self.args)))
+                print('{')
+                print('  // Your code handling the simcall')
+                print('}')
                 return False
         else:
             if self.name in self.simcalls_pre:
-                print (
+                print(
                     '# ERROR: You have a function called simcall_HANDLER_%s, but that simcall is not using any handler' %
                     self.name)
-                print ('# Either change your simcall definition, or kill that function')
+                print('# Either change your simcall definition, or kill that function')
                 return False
         return True
 
     def enum(self):
-        return '  SIMCALL_%s,' % (self.name.upper())
+        return '  %s,' % (self.name.upper())
 
     def string(self):
-        return '    "SIMCALL_%s",' % self.name.upper()
+        return '    "Simcall::%s",' % self.name.upper()
 
     def accessors(self):
         res = []
         res.append('')
         regex = re.compile(r"^boost::intrusive_ptr<(.*?)>(.*)$")  # to compute the raw type
         # Arguments getter/setters
-        for i in range(len(self.args)):
-            arg = self.args[i]
+        for i, arg in enumerate(self.args):
             rawtype = regex.sub(r'\1*\2', arg.rettype())
             res.append('static inline %s simcall_%s__get__%s(smx_simcall_t simcall)' % (
                 arg.rettype(), self.name, arg.name))
@@ -132,11 +116,11 @@ class Simcall(object):
         indent = '    '
         args = ["simgrid::simix::unmarshal<%s>(simcall_.args_[%d])" % (arg.rettype(), i)
                 for i, arg in enumerate(self.args)]
-        res.append(indent + 'case SIMCALL_%s:' % (self.name.upper()))
+        res.append(indent + 'case Simcall::%s:' % (self.name.upper()))
         if self.need_handler:
             call = "simcall_HANDLER_%s(&simcall_%s%s)" % (self.name,
-                                                        ", " if args else "",
-                                                        ', '.join(args))
+                                                          ", " if args else "",
+                                                          ', '.join(args))
         else:
             call = "SIMIX_%s(%s)" % (self.name, ', '.join(args))
         if self.call_kind == 'Func':
@@ -149,29 +133,6 @@ class Simcall(object):
         res.append('')
         return '\n'.join(res)
 
-    def body(self):
-        res = ['']
-        res.append(
-            'inline static %s simcall_BODY_%s(%s)' % (self.res.rettype(),
-                                                      self.name,
-                                                      ', '.join('%s %s' % (arg.rettype(), arg.name) for arg in self.args)))
-        res.append('{')
-        res.append('  if (false) /* Go to that function to follow the code flow through the simcall barrier */')
-        if self.need_handler:
-            res.append('    simcall_HANDLER_%s(%s);' % (self.name,
-                                                        ', '.join(["&SIMIX_process_self()->simcall_"] + [arg.name for arg in self.args])))
-        else:
-            res.append('    SIMIX_%s(%s);' % (self.name,
-                                              ', '.join(arg.name for arg in self.args)))
-        res.append('  return simcall<%s%s>(SIMCALL_%s%s);' % (
-            self.res.rettype(),
-            "".join([", " + arg.rettype() for i, arg in enumerate(self.args)]),
-            self.name.upper(),
-            "".join([", " + arg.name for i, arg in enumerate(self.args)])
-        ))
-        res.append('}')
-        return '\n'.join(res)
-
     def handler_prototype(self):
         if self.need_handler:
             return "XBT_PRIVATE %s simcall_HANDLER_%s(smx_simcall_t simcall%s);" % (self.res.rettype() if self.call_kind == 'Func' else 'void',
@@ -192,7 +153,7 @@ def parse(fn):
         if line.startswith('#') or not line:
             continue
         match = re.match(
-            r'^(\S+)\s+([^\)\(\s]+)\s*\(*(.*)\)\s*(\[\[.*\]\])?\s*;\s*?$', line)
+            r'^(\S+)\s+([^\)\(\s]+)\s*\(*(.*)\)\s*(\[\[.*\]\])?\s*;\s*$', line)
         if not match:
             raise AssertionError(line)
         ret, name, args, attrs = match.groups()
@@ -229,30 +190,19 @@ def parse(fn):
 
 def header(name):
     fd = open(name, 'w')
-    fd.write(
-        '/**********************************************************************/\n')
-    fd.write(
-        '/* File generated by src/simix/simcalls.py from src/simix/simcalls.in */\n')
-    fd.write(
-        '/*                                                                    */\n')
-    fd.write(
-        '/*                    DO NOT EVER CHANGE THIS FILE                    */\n')
-    fd.write(
-        '/*                                                                    */\n')
-    fd.write(
-        '/* change simcalls specification in src/simix/simcalls.in             */\n')
-    fd.write(
-        '/* Copyright (c) 2014-2020. The SimGrid Team. All rights reserved.    */\n')
-    fd.write(
-        '/**********************************************************************/\n\n')
+    fd.write('/**********************************************************************/\n')
+    fd.write('/* File generated by src/simix/simcalls.py from src/simix/simcalls.in */\n')
+    fd.write('/*                                                                    */\n')
+    fd.write('/*                    DO NOT EVER CHANGE THIS FILE                    */\n')
+    fd.write('/*                                                                    */\n')
+    fd.write('/* change simcalls specification in src/simix/simcalls.in             */\n')
+    fd.write('/* Copyright (c) 2014-2022. The SimGrid Team. All rights reserved.    */\n')
+    fd.write('/**********************************************************************/\n\n')
     fd.write('/*\n')
-    fd.write(
-        ' * Note that the name comes from http://en.wikipedia.org/wiki/Popping\n')
-    fd.write(
-        ' * Indeed, the control flow is doing a strange dance in there.\n')
+    fd.write(' * Note that the name comes from http://en.wikipedia.org/wiki/Popping\n')
+    fd.write(' * Indeed, the control flow is doing a strange dance in there.\n')
     fd.write(' *\n')
-    fd.write(
-        ' * That\'s not about http://en.wikipedia.org/wiki/Poop, despite the odor :)\n')
+    fd.write(' * That\'s not about http://en.wikipedia.org/wiki/Poop, despite the odor :)\n')
     fd.write(' */\n\n')
     return fd
 
@@ -269,42 +219,36 @@ def handle(fd, func, simcalls, guarded_simcalls):
 
     fd.write('\n')
 
-if __name__ == '__main__':
+def main():
     simcalls, simcalls_dict = parse('simcalls.in')
 
     ok = True
     ok &= all(map(Simcall.check, simcalls))
-    for k, v in simcalls_dict.items():
+    for _k, v in simcalls_dict.items():
         ok &= all(map(Simcall.check, v))
     if not ok:
-      print ("Some checks fail!")
-      sys.exit(1)
-
-    #
-    # popping_accessors.hpp
-    #
-    fd = header('popping_accessors.hpp')
-    fd.write('#include "src/simix/popping_private.hpp"')
-    handle(fd, Simcall.accessors, simcalls, simcalls_dict)
-    fd.write(
-        "\n/* The prototype of all simcall handlers, automatically generated for you */\n\n")
-    handle(fd, Simcall.handler_prototype, simcalls, simcalls_dict)
-    fd.close()
+        print("Some checks fail!")
+        sys.exit(1)
 
     #
     # popping_enum.hpp
     #
     fd = header("popping_enum.hpp")
+    fd.write('namespace simgrid {\n')
+    fd.write('namespace simix {\n')
     fd.write('/**\n')
     fd.write(' * @brief All possible simcalls.\n')
     fd.write(' */\n')
-    fd.write('enum e_smx_simcall_t {\n')
-    fd.write('  SIMCALL_NONE,\n')
+    fd.write('enum class Simcall {\n')
+    fd.write('  NONE,\n')
 
     handle(fd, Simcall.enum, simcalls, simcalls_dict)
 
-    fd.write('  NUM_SIMCALLS\n')
     fd.write('};\n')
+    fd.write('\n')
+    fd.write('constexpr int NUM_SIMCALLS = ' + str(1 + len(simcalls)) + ';\n')
+    fd.write('} // namespace simix\n')
+    fd.write('} // namespace simgrid\n')
     fd.close()
 
     #
@@ -313,46 +257,47 @@ if __name__ == '__main__':
 
     fd = header("popping_generated.cpp")
 
-    fd.write('#include "smx_private.hpp"\n')
+    fd.write('#include <simgrid/config.h>\n')
+    fd.write('#include <simgrid/host.h>\n')
     fd.write('#include <xbt/base.h>\n')
     fd.write('#if SIMGRID_HAVE_MC\n')
     fd.write('#include "src/mc/mc_forward.hpp"\n')
     fd.write('#endif\n')
     fd.write('#include "src/kernel/activity/ConditionVariableImpl.hpp"\n')
+    fd.write('#include "src/kernel/actor/SimcallObserver.hpp"\n')
+    fd.write('#include "src/kernel/context/Context.hpp"\n')
 
     fd.write('\n')
-    fd.write('XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_popping);\n\n')
+    fd.write('XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);\n\n')
 
-    fd.write(
-        '/** @brief Simcalls\' names (generated from src/simix/simcalls.in) */\n')
-    fd.write('constexpr std::array<const char*, NUM_SIMCALLS> simcall_names{{\n')
+    fd.write('using simgrid::simix::Simcall;')
+    fd.write('\n')
+    fd.write('/** @brief Simcalls\' names (generated from src/simix/simcalls.in) */\n')
+    fd.write('constexpr std::array<const char*, simgrid::simix::NUM_SIMCALLS> simcall_names{{\n')
 
-    fd.write('    "SIMCALL_NONE",\n')
+    fd.write('    "Simcall::NONE",\n')
     handle(fd, Simcall.string, simcalls, simcalls_dict)
 
     fd.write('}};\n\n')
 
     fd.write('/** @private\n')
-    fd.write(
-        ' * @brief (in kernel mode) unpack the simcall and activate the handler\n')
+    fd.write(' * @brief (in kernel mode) unpack the simcall and activate the handler\n')
     fd.write(' *\n')
     fd.write(' * This function is generated from src/simix/simcalls.in\n')
     fd.write(' */\n')
-    fd.write(
-        'void simgrid::kernel::actor::ActorImpl::simcall_handle(int value) {\n')
-    fd.write(
-        '  XBT_DEBUG("Handling simcall %p: %s", &simcall_, SIMIX_simcall_name(simcall_.call_));\n')
-    fd.write('  SIMCALL_SET_MC_VALUE(simcall_, value);\n')
-    fd.write(
-        '  if (context_->wannadie())\n')
+    fd.write('void simgrid::kernel::actor::ActorImpl::simcall_handle(int times_considered)\n')
+    fd.write('{\n')
+    fd.write('  XBT_DEBUG("Handling simcall %p: %s", &simcall_, SIMIX_simcall_name(simcall_));\n')
+    fd.write('  if (simcall_.observer_ != nullptr)\n')
+    fd.write('    simcall_.observer_->prepare(times_considered);\n')
+
+    fd.write('  if (context_->wannadie())\n')
     fd.write('    return;\n')
     fd.write('  switch (simcall_.call_) {\n')
 
     handle(fd, Simcall.case, simcalls, simcalls_dict)
 
-    fd.write('    case NUM_SIMCALLS:\n')
-    fd.write('      break;\n')
-    fd.write('    case SIMCALL_NONE:\n')
+    fd.write('    case Simcall::NONE:\n')
     fd.write('      throw std::invalid_argument(simgrid::xbt::string_printf("Asked to do the noop syscall on %s@%s",\n')
     fd.write('                                                              get_cname(),\n')
     fd.write('                                                              sg_host_get_name(get_host())));\n')
@@ -363,36 +308,5 @@ if __name__ == '__main__':
 
     fd.close()
 
-    #
-    # popping_bodies.cpp
-    #
-    fd = header('popping_bodies.cpp')
-    fd.write('#include "smx_private.hpp"\n')
-    fd.write('#include "src/mc/mc_forward.hpp"\n')
-    fd.write('#include "xbt/ex.h"\n')
-    fd.write('#include <functional>\n')
-    fd.write('#include <simgrid/simix.hpp>\n')
-    fd.write('#include <xbt/log.h>\n')
-
-    fd.write("/** @cond */ // Please Doxygen, don't look at this\n")
-    fd.write('''
-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
-
-template<class R, class... T>
-inline static R simcall(e_smx_simcall_t call, T const&... t)
-{
-  smx_actor_t self = SIMIX_process_self();
-  simgrid::simix::marshal(&self->simcall_, call, t...);
-  if (self != simix_global->maestro_) {
-    XBT_DEBUG("Yield process '%s' on simcall %s (%d)", self->get_cname(), SIMIX_simcall_name(self->simcall_.call_),
-              (int)self->simcall_.call_);
-    self->yield();
-  } else {
-    self->simcall_handle(0);
-  }
-  return simgrid::simix::unmarshal<R>(self->simcall_.result_);
-}
-''')
-    handle(fd, Simcall.body, simcalls, simcalls_dict)
-    fd.write("/** @endcond */\n")
-    fd.close()
+if __name__ == '__main__':
+    main()