Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2022.
[simgrid.git] / src / simix / simcalls.py
index ae5f79a..06b5b40 100755 (executable)
@@ -1,7 +1,7 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2014-2019. 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.
@@ -79,15 +79,15 @@ class Simcall(object):
         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
+        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]
@@ -95,17 +95,17 @@ class Simcall(object):
             res.append('static inline %s simcall_%s__get__%s(smx_simcall_t simcall)' % (
                 arg.rettype(), self.name, arg.name))
             res.append('{')
-            res.append('  return simgrid::simix::unmarshal<%s>(simcall->args[%i]);' % (arg.rettype(), i))
+            res.append('  return simgrid::simix::unmarshal<%s>(simcall->args_[%i]);' % (arg.rettype(), i))
             res.append('}')
             res.append('static inline %s simcall_%s__getraw__%s(smx_simcall_t simcall)' % (
                 rawtype, self.name, arg.name))
             res.append('{')
-            res.append('  return simgrid::simix::unmarshal_raw<%s>(simcall->args[%i]);' % (rawtype, i))
+            res.append('  return simgrid::simix::unmarshal_raw<%s>(simcall->args_[%i]);' % (rawtype, i))
             res.append('}')
             res.append('static inline void simcall_%s__set__%s(smx_simcall_t simcall, %s arg)' % (
                 self.name, arg.name, arg.rettype()))
             res.append('{')
-            res.append('  simgrid::simix::marshal<%s>(simcall->args[%i], arg);' % (arg.rettype(), i))
+            res.append('  simgrid::simix::marshal<%s>(simcall->args_[%i], arg);' % (arg.rettype(), i))
             res.append('}')
 
         # Return value getter/setters
@@ -114,37 +114,38 @@ class Simcall(object):
             res.append(
                 'static inline %s simcall_%s__get__result(smx_simcall_t simcall)' % (self.res.rettype(), self.name))
             res.append('{')
-            res.append('  return simgrid::simix::unmarshal<%s>(simcall->result);' % self.res.rettype())
+            res.append('  return simgrid::simix::unmarshal<%s>(simcall->result_);' % self.res.rettype())
             res.append('}')
             res.append('static inline %s simcall_%s__getraw__result(smx_simcall_t simcall)' % (rawtype, self.name))
             res.append('{')
-            res.append('  return simgrid::simix::unmarshal_raw<%s>(simcall->result);' % rawtype)
+            res.append('  return simgrid::simix::unmarshal_raw<%s>(simcall->result_);' % rawtype)
             res.append('}')
             res.append(
                 'static inline void simcall_%s__set__result(smx_simcall_t simcall, %s result)' % (self.name, self.res.rettype()))
             res.append('{')
-            res.append('  simgrid::simix::marshal<%s>(simcall->result, result);' % (self.res.rettype()))
+            res.append('  simgrid::simix::marshal<%s>(simcall->result_, result);' % (self.res.rettype()))
             res.append('}')
         return '\n'.join(res)
 
     def case(self):
         res = []
-        args = ["simgrid::simix::unmarshal<%s>(simcall->args[%d])" % (arg.rettype(), i)
+        indent = '    '
+        args = ["simgrid::simix::unmarshal<%s>(simcall_.args_[%d])" % (arg.rettype(), i)
                 for i, arg in enumerate(self.args)]
-        res.append('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 len(args) > 0 else "",
+            call = "simcall_HANDLER_%s(&simcall_%s%s)" % (self.name,
+                                                        ", " if args else "",
                                                         ', '.join(args))
         else:
             call = "SIMIX_%s(%s)" % (self.name, ', '.join(args))
         if self.call_kind == 'Func':
-            res.append("  simgrid::simix::marshal<%s>(simcall->result, %s);" % (self.res.rettype(), call))
+            res.append(indent + "  simgrid::simix::marshal<%s>(simcall_.result_, %s);" % (self.res.rettype(), call))
         else:
-            res.append("  " + call + ";")
+            res.append(indent + "  " + call + ";")
         if self.call_kind != 'Blck':
-            res.append('  SIMIX_simcall_answer(simcall);')
-        res.append('  break;')
+            res.append(indent + '  simcall_answer();')
+        res.append(indent + '  break;')
         res.append('')
         return '\n'.join(res)
 
@@ -155,14 +156,14 @@ class Simcall(object):
                                                       self.name,
                                                       ', '.join('%s %s' % (arg.rettype(), arg.name) for arg in self.args)))
         res.append('{')
-        res.append('  if (0) /* Go to that function to follow the code flow through the simcall barrier */')
+        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])))
+                                                        ', '.join(["&simgrid::kernel::actor::ActorImpl::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);' % (
+        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(),
@@ -177,8 +178,7 @@ class Simcall(object):
                                                                                     self.name,
                                                                                     ''.join(', %s %s' % (arg.rettype(), arg.name)
                                                                                             for i, arg in enumerate(self.args)))
-        else:
-            return ""
+        return ""
 
 
 def parse(fn):
@@ -193,7 +193,8 @@ def parse(fn):
             continue
         match = re.match(
             r'^(\S+)\s+([^\)\(\s]+)\s*\(*(.*)\)\s*(\[\[.*\]\])?\s*;\s*?$', line)
-        assert match, line
+        if not match:
+            raise AssertionError(line)
         ret, name, args, attrs = match.groups()
         sargs = []
         if not re.match(r"^\s*$", args):
@@ -217,7 +218,7 @@ def parse(fn):
                 elif attr == "nohandler":
                     handler = False
                 else:
-                    assert False, "Unknown attribute %s in: %s" % (attr, line)
+                    raise AssertionError("Unknown attribute %s in: %s" % (attr, line))
         sim = Simcall(name, handler, Arg('result', ret), sargs, ans)
         if resdi is None:
             simcalls.append(sim)
@@ -228,30 +229,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-2019. 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
 
@@ -264,8 +254,9 @@ def handle(fd, func, simcalls, guarded_simcalls):
     for guard, ll in guarded_simcalls.items():
         fd.write('\n#if %s\n' % (guard))
         fd.write('\n'.join(func(simcall) for simcall in ll))
-        fd.write('\n#endif\n')
+        fd.write('\n#endif')
 
+    fd.write('\n')
 
 if __name__ == '__main__':
     simcalls, simcalls_dict = parse('simcalls.in')
@@ -285,25 +276,29 @@ if __name__ == '__main__':
     fd.write('#include "src/simix/popping_private.hpp"')
     handle(fd, Simcall.accessors, simcalls, simcalls_dict)
     fd.write(
-        "\n\n/* The prototype of all simcall handlers, automatically generated for you */\n\n")
+        "\n/* The prototype of all simcall handlers, automatically generated for you */\n\n")
     handle(fd, Simcall.handler_prototype, simcalls, simcalls_dict)
     fd.close()
 
     #
-    # popping_enum.h
+    # popping_enum.hpp
     #
-    fd = header("popping_enum.h")
+    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('typedef enum {\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('};\n')
     fd.write('\n')
-    fd.write('  NUM_SIMCALLS\n')
-    fd.write('} e_smx_simcall_t;\n')
+    fd.write('constexpr int NUM_SIMCALLS = ' + str(1 + len(simcalls)) + ';\n')
+    fd.write('} // namespace simix\n')
+    fd.write('} // namespace simgrid\n')
     fd.close()
 
     #
@@ -312,48 +307,51 @@ 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(
-        '/** @brief Simcalls\' names (generated from src/simix/simcalls.in) */\n')
-    fd.write('const char* 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\n')
+    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 SIMIX_simcall_handle(smx_simcall_t simcall, 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 (simcall->issuer->context_->iwannadie)\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('  simcall_.mc_value_ = times_considered;\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')
+    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('      THROWF(arg_error, 0, "Asked to do the noop syscall on %s@%s", simcall->issuer->get_cname(),\n')
-    fd.write('             sg_host_get_name(simcall->issuer->get_host()));\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')
     fd.write('    default:\n')
     fd.write('      THROW_IMPOSSIBLE;\n')
     fd.write('  }\n')
@@ -365,7 +363,8 @@ if __name__ == '__main__':
     # popping_bodies.cpp
     #
     fd = header('popping_bodies.cpp')
-    fd.write('#include "smx_private.hpp"\n')
+    fd.write('#include "src/kernel/EngineImpl.hpp"\n')
+    fd.write('#include "src/kernel/actor/ActorImpl.hpp"\n')
     fd.write('#include "src/mc/mc_forward.hpp"\n')
     fd.write('#include "xbt/ex.h"\n')
     fd.write('#include <functional>\n')
@@ -376,21 +375,22 @@ if __name__ == '__main__':
     fd.write('''
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
 
+using simgrid::simix::Simcall;
+
 template<class R, class... T>
-inline static R simcall(e_smx_simcall_t call, T const&... t)
+inline static R simcall(Simcall call, T const&... t)
 {
-  smx_actor_t self = SIMIX_process_self();
-  simgrid::simix::marshal(&self->simcall, call, t...);
-  if (self != simix_global->maestro_process) {
-    XBT_DEBUG("Yield process '%s' on simcall %s (%d)", self->get_cname(), SIMIX_simcall_name(self->simcall.call),
-              (int)self->simcall.call);
+  auto self = simgrid::kernel::actor::ActorImpl::self();
+  simgrid::simix::marshal(&self->simcall_, call, t...);
+  if (not simgrid::kernel::EngineImpl::get_instance()->is_maestro(self)) {
+    XBT_DEBUG("Yield process '%s' on simcall %s", self->get_cname(), SIMIX_simcall_name(self->simcall_));
     self->yield();
   } else {
-    SIMIX_simcall_handle(&self->simcall, 0);
+    self->simcall_handle(0);
   }
-  return simgrid::simix::unmarshal<R>(self->simcall.result);
+  return simgrid::simix::unmarshal<R>(self->simcall_.result_);
 }
 ''')
     handle(fd, Simcall.body, simcalls, simcalls_dict)
-    fd.write(" /** @endcond */\n")
+    fd.write("/** @endcond */\n")
     fd.close()