Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
better handling of blocking simcalls in the generated popping
[simgrid.git] / src / simix / simcalls.py
index ccaa840..0861c1f 100755 (executable)
@@ -39,7 +39,7 @@ class Arg(object):
   def field(self):
     return self.simcall_types[self.type]
 
-  def ret(self):
+  def rettype(self):
     return '%s'%self.casted if self.casted else self.type
 
   def cast(self):
@@ -48,106 +48,84 @@ class Arg(object):
 class Simcall(object):
   simcalls_BODY = None
   simcalls_PRE = None
-  def __init__(self, name, res, args, has_answer=True):
+  def __init__(self, name, res, args, call_kind):
     self.name = name
     self.res = res
     self.args = args
-    self.has_answer = has_answer
+    self.call_kind = call_kind
 
   def check(self):
-    # smx_user.c  simcall_BODY_
-    # smx_*.c void SIMIX_pre_host_on(smx_simcall_t simcall, smx_host_t h)
-    self.check_body()
-    self.check_pre()
-
-  def check_body(self):
+      # libsmx.c  simcall_BODY_
       if self.simcalls_BODY is None:
-          f = open('smx_user.c')
+          f = open('libsmx.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()
-     ,self.name
-     ,', '.join('%s %s'%(arg.ret(), arg.name)
-                  for arg in self.args)
-     ,self.name
-     ,', '.join(arg.name for arg in self.args))
+          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 '  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:
+        self.simcalls_PRE = set()
+        for fn in glob.glob('smx_*') + glob.glob('../mc/*'):
+            f = open(fn)
+            self.simcalls_PRE |= set(re.findall('simcall_HANDLER_(.*?)\(', f.read()))
+            f.close()
+      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 '  // Your code handling the simcall'
+          print '}'
           return False
       return True
 
-  def check_pre(self):
-    if self.simcalls_PRE is None:
-      self.simcalls_PRE = set()
-      for fn in glob.glob('smx_*') + glob.glob('../mc/*'):
-        f = open(fn)
-        self.simcalls_PRE |= set(re.findall('SIMIX_pre_(.*?)\(', f.read()))
-        f.close()
-    if self.name not in self.simcalls_PRE:
-      print '# ERROR: No function called SIMIX_pre_%s'%self.name
-      print '# Add something like this to smx_.*.c:'
-      print '''%s SIMIX_pre_%s(smx_simcall_t simcall%s)
-{
-  // Your code handling the simcall
-}\n'''%(self.res.ret()
-       ,self.name
-       ,''.join(', %s %s'%(arg.ret(), arg.name)
-                  for arg in self.args))
-      return False
-    return True
-
   def enum(self):
-    return 'SIMCALL_%s,'%(self.name.upper())
+    return '  SIMCALL_%s,'%(self.name.upper())
 
   def string(self):
-    return '[SIMCALL_%s] = "SIMCALL_%s",'%(self.name.upper(), self.name.upper())       
-  
-  def result_getter_setter(self):
-    return '%s\n%s'%(self.result_getter(), self.result_setter())
-  
-  def result_getter(self):
-    return '' if self.res.type == 'void' else '''static inline %s simcall_%s__get__result(smx_simcall_t simcall){
-  return %s simcall->result.%s;
-}'''%(self.res.ret(), self.name, self.res.cast(), self.res.field())
-
-  def result_setter(self):
-    return '' if self.res.type == 'void' else '''static inline void simcall_%s__set__result(smx_simcall_t simcall, %s result){
-    simcall->result.%s = result;
-}'''%(self.name, self.res.type, self.res.field())
+    return '  [SIMCALL_%s] = "SIMCALL_%s",'%(self.name.upper(), self.name.upper())     
 
-  def args_getter_setter(self):
+  def accessors(self):
     res = []
+    res.append('')
+    # Arguments getter/setters
     for i in range(len(self.args)):
-      res.append(self.arg_getter(i))
-      res.append(self.arg_setter(i))
+        arg = self.args[i]
+        res.append('static inline %s simcall_%s__get__%s(smx_simcall_t simcall) {'%(arg.rettype(), self.name, arg.name))
+        res.append('  return %s simcall->args[%i].%s;'%(arg.cast(), i, arg.field()))
+        res.append('}')
+        res.append('static inline void simcall_%s__set__%s(smx_simcall_t simcall, %s arg) {'%(self.name, arg.name, arg.type))
+        res.append('    simcall->args[%i].%s = arg;'%(i, arg.field()))
+        res.append('}')
+      
+    # Return value getter/setters
+    if self.res.type != 'void':
+        res.append('static inline %s simcall_%s__get__result(smx_simcall_t simcall){'%(self.res.rettype(), self.name))
+        res.append('    return %s simcall->result.%s;'%(self.res.cast(), self.res.field()))
+        res.append('}')
+        res.append('static inline void simcall_%s__set__result(smx_simcall_t simcall, %s result){'%(self.name, self.res.type,))
+        res.append('    simcall->result.%s = result;'%(self.res.field()))
+        res.append('}')
     return '\n'.join(res)
 
-  def arg_getter(self, i):
-    arg = self.args[i]
-    return '''static inline %s simcall_%s__get__%s(smx_simcall_t simcall){
-  return %s simcall->args[%i].%s;
-}'''%(arg.ret(), self.name, arg.name, arg.cast(), i, arg.field())
-
-  def arg_setter(self, i):
-    arg = self.args[i]
-    return '''static inline void simcall_%s__set__%s(smx_simcall_t simcall, %s arg){
-    simcall->args[%i].%s = arg;
-}'''%(self.name, arg.name, arg.type, i, arg.field())
-
   def case(self):
     return '''case SIMCALL_%s:
-      %sSIMIX_pre_%s(simcall %s);
+      %ssimcall_HANDLER_%s(simcall %s);
       %sbreak;  
 '''%(self.name.upper(), 
-     'simcall->result.%s = '%self.res.field() if self.res.type != 'void' and self.has_answer else ' ',
+     'simcall->result.%s = '%self.res.field() if self.call_kind == 'Func' else ' ',
      self.name,
      ''.join(', %s simcall->args[%d].%s'%(arg.cast(), i, arg.field()) 
              for i, arg in enumerate(self.args)),
-     'SIMIX_simcall_answer(simcall);\n      ' if self.has_answer else ' ')
+     'SIMIX_simcall_answer(simcall);\n      ' if self.call_kind != 'Blck' else ' ')
 
   def body(self):
     return '''  
@@ -155,7 +133,7 @@ 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);
+    if (0) simcall_HANDLER_%s(%s);
     /* end of the guide intended to the poor programmer wanting to go from MSG to Surf */
 
     self->simcall.call = SIMCALL_%s;
@@ -167,12 +145,12 @@ inline static %s simcall_BODY_%s(%s) {
                 SIMIX_simcall_name(self->simcall.call), (int)self->simcall.call);
       SIMIX_process_yield(self);
     } else {
-      SIMIX_simcall_enter(&self->simcall, 0);
+      SIMIX_simcall_handle(&self->simcall, 0);
     }    
     %s
-  }'''%(self.res.ret()
+  }'''%(self.res.rettype()
        ,self.name
-       ,', '.join('%s %s'%(arg.ret(), arg.name)
+       ,', '.join('%s %s'%(arg.rettype(), arg.name)
                   for arg in self.args)
        ,self.name
        ,', '.join(["&self->simcall"]+ [arg.name for arg in self.args])
@@ -180,6 +158,10 @@ inline static %s simcall_BODY_%s(%s) {
        ,'\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 handler_prototype(self):
+      return "%s simcall_HANDLER_%s(smx_simcall_t simcall%s);"%(self.res.rettype() if self.call_kind == 'Func' else 'void', self.name, ''.join(', %s %s'%(arg.rettype(), arg.name) 
+             for i, arg in enumerate(self.args)))
 
 def parse(fn):
   simcalls = []
@@ -193,25 +175,34 @@ def parse(fn):
       continue
     match = re.match(r'(\S*?) *(\S*?) *\((.*?)(?:, *(.*?))?\) *(.*)', line)
     assert match, line
-    name, ans, rest, resc, args = match.groups()
+    ans, name, rest, resc, args = match.groups()
+    assert (ans == 'Proc' or ans == 'Func' or ans == 'Blck'),"Invalid call type: '%s'. Faulty line:\n%s\n"%(ans,line)
     sargs = []
     for n,t,c in re.findall(r'\((.*?), *(.*?)(?:, *(.*?))?\)', args):
       sargs.append(Arg(n,t,c))
-    sim = Simcall(name, Arg('result', rest, resc), sargs, ans == 'True')
+    sim = Simcall(name, Arg('result', rest, resc), sargs, ans)
     if resdi is None:
       simcalls.append(sim)
     else:
       resdi.append(sim)
   return simcalls, simcalls_guarded
 
-def header(fd):
+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('/* 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')
+    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')
+    return fd
 
 def handle(fd,func, simcalls, guarded_simcalls):
     fd.write('\n'.join(func(simcall) for simcall in simcalls))
@@ -220,14 +211,6 @@ def handle(fd,func, simcalls, guarded_simcalls):
         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
   simcalls, simcalls_dict = parse('simcalls.in')
@@ -241,38 +224,43 @@ if __name__=='__main__':
   #  print ("Some checks fail!")
   #  sys.exit(1)
 
-  write('simcalls_generated_enum.h', Simcall.enum, simcalls, simcalls_dict,"""
-/**
- * @brief All possible simcalls.
- */
-typedef enum {
-SIMCALL_NONE,
-  ""","""
-SIMCALL_NEW_API_INIT,
-NUM_SIMCALLS
-} e_smx_simcall_t;
-  """)
-  
-  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)
+  ###
+  ### smx_popping_accessors.c
+  ###
+  fd = header('popping_accessors.h')
+  handle(fd, Simcall.accessors, simcalls, simcalls_dict)
+  fd.write("\n\n/* The prototype of all simcall handlers, automatically generated for you */\n\n")
+  handle(fd, Simcall.handler_prototype, simcalls, simcalls_dict)
+  fd.close()
+
+  ###
+  ### smx_popping_enum.c
+  ###
+  fd = header("popping_enum.h")
+  fd.write('/**\n')
+  fd.write(' * @brief All possible simcalls.\n')
+  fd.write(' */\n')
+  fd.write('typedef enum {\n')
+  fd.write('  SIMCALL_NONE,\n')
   
+  handle(fd, Simcall.enum, simcalls, simcalls_dict)
   
+  fd.write('  NUM_SIMCALLS\n')
+  fd.write('} e_smx_simcall_t;\n')
+  fd.close()
+
+  ###
+  ### smx_popping_generated.c
+  ###
   
-  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 = header("popping_generated.c")
   
   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('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')
@@ -288,7 +276,7 @@ NUM_SIMCALLS
   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('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 && simcall->call != SIMCALL_PROCESS_CLEANUP)\n');
@@ -306,15 +294,17 @@ NUM_SIMCALLS
   fd.write('          );\n');
   fd.write('      break;\n');
   fd.write('\n');
-  fd.write('    /* ****************************************************************************************** */\n');
-  fd.write('    /* TUTORIAL: New API                                                                        */\n');
-  fd.write('    /* ****************************************************************************************** */\n');
-  fd.write('    case SIMCALL_NEW_API_INIT:\n');
-  fd.write('      SIMIX_pre_new_api_fct(simcall);\n');
-  fd.write('      break;\n');
   fd.write('  }\n');
   fd.write('}\n');
   
   fd.close()
   
-  write('simcalls_generated_body.c', Simcall.body, simcalls, simcalls_dict)
+  ###
+  ### smx_popping_bodies.c
+  ###
+  fd = header('popping_bodies.c')
+  fd.write('#include "smx_private.h"\n')
+  fd.write('#include "mc/mc_interface.h"\n')
+  fd.write('#include "xbt/ex.h"\n')
+  handle(fd, Simcall.body, simcalls, simcalls_dict)
+  fd.close()