Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove the 'TUTORIAL: New API' chunks
[simgrid.git] / src / simix / simcalls.py
index 570815e..7781eb3 100755 (executable)
@@ -1,8 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2014. The SimGrid Team.
-# All rights reserved.
+# Copyright (c) 2014. 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.
@@ -62,14 +61,14 @@ class Simcall(object):
     self.check_pre()
 
   def check_body(self):
-    if self.simcalls_BODY is None:
-      f = open('smx_user.c')
-      self.simcalls_BODY = set(re.findall('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 smx_user.c:'
-      print '''%s simcall_%s(%s)
+      if self.simcalls_BODY is None:
+          f = open('smx_user.c')
+          self.simcalls_BODY = set(re.findall('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 smx_user.c:'
+          print '''%s simcall_%s(%s)
 {
   return simcall_BODY_%s(%s);
 }\n'''%(self.res.ret()
@@ -78,8 +77,8 @@ class Simcall(object):
                   for arg in self.args)
      ,self.name
      ,', '.join(arg.name for arg in self.args))
-      return False
-    return True
+          return False
+      return True
 
   def check_pre(self):
     if self.simcalls_PRE is None:
@@ -151,8 +150,14 @@ class Simcall(object):
      'SIMIX_simcall_answer(simcall);\n      ' if self.has_answer else ' ')
 
   def body(self):
-    return '''  inline static %s simcall_BODY_%s(%s) {
+    return '''  
+inline static %s simcall_BODY_%s(%s) {
     smx_process_t self = SIMIX_process_self();
+
+    /* Go to that function to follow the code flow through the simcall barrier */
+    if (0) SIMIX_pre_%s(%s);
+    /* end of the guide intended to the poor programmer wanting to go from MSG to Surf */
+
     self->simcall.call = SIMCALL_%s;
     memset(&self->simcall.result, 0, sizeof(self->simcall.result));
     memset(self->simcall.args, 0, sizeof(self->simcall.args));
@@ -162,26 +167,28 @@ class Simcall(object):
                 SIMIX_simcall_name(self->simcall.call), (int)self->simcall.call);
       SIMIX_process_yield(self);
     } else {
-      SIMIX_simcall_pre(&self->simcall, 0);
+      SIMIX_simcall_enter(&self->simcall, 0);
     }    
     %s
   }'''%(self.res.ret()
        ,self.name
        ,', '.join('%s %s'%(arg.ret(), arg.name)
                   for arg in self.args)
+       ,self.name
+       ,', '.join(["&self->simcall"]+ [arg.name for arg in self.args])
        ,self.name.upper()
        ,'\n'.join('    self->simcall.args[%d].%s = (%s) %s;'%(i, arg.field(), arg.type, arg.name)
                   for i, arg in enumerate(self.args))
        ,'' if self.res.type == 'void' else 'return self->simcall.result.%s;'%self.res.field())
 
 def parse(fn):
-  res = []
+  simcalls = []
   resdi = None
-  resd = {}
+  simcalls_guarded = {}
   for line in open(fn).read().split('\n'):
     if line.startswith('##'):
       resdi = []
-      resd[re.search(r'## *(.*)', line).group(1)] = resdi
+      simcalls_guarded[re.search(r'## *(.*)', line).group(1)] = resdi
     if line.startswith('#') or not line:
       continue
     match = re.match(r'(\S*?) *(\S*?) *\((.*?)(?:, *(.*?))?\) *(.*)', line)
@@ -192,23 +199,34 @@ def parse(fn):
       sargs.append(Arg(n,t,c))
     sim = Simcall(name, Arg('result', rest, resc), sargs, ans == 'True')
     if resdi is None:
-      res.append(sim)
+      simcalls.append(sim)
     else:
       resdi.append(sim)
-  return res, resd
-
-def write(fn, func, scs, scd):
-  f = open(fn, 'w')
-  f.write('/*********************************************\n')
-  f.write(' * File Generated by src/simix/simcalls.py   *\n')
-  f.write(' *                from src/simix/simcalls.in *\n')
-  f.write(' * Do not modify this file, add new simcalls *\n')
-  f.write(' * in src/simix/simcalls.in                  *\n')  
-  f.write(' *********************************************/\n\n')
-  f.write('\n'.join(func(sc) for sc in scs))
-  for k, v in scd.items():
-    f.write('\n#ifdef %s\n%s\n#endif\n'%(k, '\n'.join(func(sc) for sc in v)))
-  f.close()
+  return simcalls, simcalls_guarded
+
+def header(fd):
+    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('/**********************************************************************/\n\n')
+
+def handle(fd,func, simcalls, guarded_simcalls):
+    fd.write('\n'.join(func(simcall) for simcall in simcalls))
+    for guard, list in guarded_simcalls.items():
+        fd.write('\n#ifdef %s\n'%(guard))
+        fd.write('\n'.join(func(simcall) for simcall in list))
+        fd.write('\n#endif\n')
+
+def write(fn, func, simcalls, scd,pre="",post=""):
+    fd = open(fn, 'w')
+    header(fd)
+    fd.write(pre)
+    handle(fd, func, simcalls, scd)
+    fd.write(post)
+    fd.close()
 
 if __name__=='__main__':
   import sys
@@ -218,12 +236,94 @@ if __name__=='__main__':
   ok &= all(map(Simcall.check, simcalls))
   for k,v in simcalls_dict.items():
     ok &= all(map(Simcall.check, v))
+  # FIXME: we should not hide it
   #if not ok:
+  #  print ("Some checks fail!")
   #  sys.exit(1)
 
-  write('simcalls_generated_enum.h', Simcall.enum, simcalls, simcalls_dict)
-  write('simcalls_generated_string.c', Simcall.string, simcalls, simcalls_dict)
   write('simcalls_generated_res_getter_setter.h', Simcall.result_getter_setter, simcalls, simcalls_dict)
   write('simcalls_generated_args_getter_setter.h', Simcall.args_getter_setter, simcalls, simcalls_dict)
-  write('simcalls_generated_case.c', Simcall.case, simcalls, simcalls_dict)
+  
+  
+  fd = open("smx_popping_generated.h", 'w')
+  header(fd)
+  fd.write("""
+/*
+ * Note that the name comes from http://en.wikipedia.org/wiki/Popping 
+ * Indeed, the control flow is doing a strange dance in there.
+ *
+ * That\'s not about http://en.wikipedia.org/wiki/Poop, despite the odor :)
+ */
+
+/**
+ * @brief All possible simcalls.
+ */
+typedef enum {
+SIMCALL_NONE,
+  """)
+  
+  handle(fd, Simcall.enum, simcalls, simcalls_dict)
+  
+  fd.write("""
+NUM_SIMCALLS
+} e_smx_simcall_t;
+  """)
+
+  
+  fd.close()
+
+  
+  fd = open("smx_popping_generated.c", 'w')
+  header(fd)
+  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(' *\n')
+  fd.write(' * That\'s not about http://en.wikipedia.org/wiki/Poop, despite the odor :)\n')
+  fd.write(' */\n\n')
+  
+  fd.write('#include "smx_private.h"\n');
+  fd.write('#ifdef HAVE_MC\n');
+  fd.write('#include "mc/mc_private.h"\n');
+  fd.write('#endif\n');
+  fd.write('\n');
+  fd.write('XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_smurf);\n\n');
+  
+  fd.write('/** @brief Simcalls\' names (generated from src/simix/simcalls.in) */\n')
+  fd.write('const char* simcall_names[] = {\n')
+
+  handle(fd, Simcall.string, simcalls, simcalls_dict)
+
+  fd.write('[SIMCALL_NONE] = "NONE"\n')
+  fd.write('};\n\n')
+
+
+  fd.write('/**\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_enter(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 && simcall->call != SIMCALL_PROCESS_CLEANUP)\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('      THROWF(arg_error,0,"Asked to do the noop syscall on %s@%s",\n');
+  fd.write('          SIMIX_process_get_name(simcall->issuer),\n');
+  fd.write('          SIMIX_host_get_name(SIMIX_process_get_host(simcall->issuer))\n');
+  fd.write('          );\n');
+  fd.write('      break;\n');
+  fd.write('\n');
+  fd.write('  }\n');
+  fd.write('}\n');
+  
+  fd.close()
+  
   write('simcalls_generated_body.c', Simcall.body, simcalls, simcalls_dict)