src/simix/simcalls.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 # Copyright (c) 2014. The SimGrid Team.
   5 # All rights reserved.
   6
   7 # This program is free software; you can redistribute it and/or modify it
   8 # under the terms of the license (GNU LGPL) which comes with this package.
   9
  10 import re, glob
  11
  12 types = [('TCHAR', 'char', 'c')
  13         ,('TSTRING', 'const char*', 'cc')
  14         ,('TINT', 'int', 'i')
  15         ,('TLONG', 'long', 'l')
  16         ,('TUCHAR', 'unsigned char', 'uc')
  17         ,('TUSHORT', 'unsigned short', 'us')
  18         ,('TUINT', 'unsigned int', 'ui')
  19         ,('TULONG', 'unsigned long', 'ul')
  20         ,('TFLOAT', 'float', 'f')
  21         ,('TDOUBLE', 'double', 'd')
  22         ,('TDPTR', 'void*', 'dp')
  23         ,('TFPTR', 'FPtr', 'fp')
  24         ,('TCPTR', 'const void*', 'cp')
  25         ,('TSIZE', 'size_t', 'sz')
  26         ,('TSGSIZE', 'sg_size_t', 'sgsz')
  27         ,('TVOID', 'void', '')
  28         ,('TDSPEC', 'void*', 'dp')
  29         ,('TFSPEC', 'FPtr', 'fp')]
  30
  31 class Arg(object):
  32   simcall_types = {k:v for _,k,v in types}
  33   def __init__(self, name, type, casted=None):
  34     self.name = name
  35     self.type = type
  36     self.casted = casted
  37     assert type in self.simcall_types, '%s not in (%s)'%(type, ', '.join(self.simcall_types.keys()))
  38
  39   def field(self):
  40     return self.simcall_types[self.type]
  41
  42   def ret(self):
  43     return '%s'%self.casted if self.casted else self.type
  44
  45   def cast(self):
  46     return '(%s)'%self.casted if self.casted else ''
  47
  48 class Simcall(object):
  49   simcalls_BODY = None
  50   simcalls_PRE = None
  51   def __init__(self, name, res, args, has_answer=True):
  52     self.name = name
  53     self.res = res
  54     self.args = args
  55     self.has_answer = has_answer
  56
  57   def check(self):
  58     # smx_user.c  simcall_BODY_
  59     # smx_*.c void SIMIX_pre_host_on(smx_simcall_t simcall, smx_host_t h)
  60     self.check_body()
  61     self.check_pre()
  62
  63   def check_body(self):
  64     if self.simcalls_BODY is None:
  65       f = open('smx_user.c')
  66       self.simcalls_BODY = set(re.findall('simcall_BODY_(.*?)\(', f.read()))
  67       f.close()
  68     if self.name not in self.simcalls_BODY:
  69       print '# ERROR: No function calling simcall_BODY_%s'%self.name
  70       print '# Add something like this to smx_user.c:'
  71       print '''%s simcall_%s(%s)
  72 {
  73   return simcall_BODY_%s(%s);
  74 }\n'''%(self.res.ret()
  75      ,self.name
  76      ,', '.join('%s %s'%(arg.ret(), arg.name)
  77                   for arg in self.args)
  78      ,self.name
  79      ,', '.join(arg.name for arg in self.args))
  80       return False
  81     return True
  82
  83   def check_pre(self):
  84     if self.simcalls_PRE is None:
  85       self.simcalls_PRE = set()
  86       for fn in glob.glob('smx_*') + glob.glob('../mc/*'):
  87         f = open(fn)
  88         self.simcalls_PRE |= set(re.findall('SIMIX_pre_(.*?)\(', f.read()))
  89         f.close()
  90     if self.name not in self.simcalls_PRE:
  91       print '# ERROR: No function called SIMIX_pre_%s'%self.name
  92       print '# Add something like this to smx_.*.c:'
  93       print '''%s SIMIX_pre_%s(smx_simcall_t simcall%s)
  94 {
  95   // Your code handling the simcall
  96 }\n'''%(self.res.ret()
  97        ,self.name
  98        ,''.join(', %s %s'%(arg.ret(), arg.name)
  99                   for arg in self.args))
 100       return False
 101     return True
 102
 103   def enum(self):
 104     return 'SIMCALL_%s,'%(self.name.upper())
 105
 106   def string(self):
 107     return '[SIMCALL_%s] = "SIMCALL_%s",'%(self.name.upper(), self.name.upper())
 108
 109   def result_getter_setter(self):
 110     return '%s\n%s'%(self.result_getter(), self.result_setter())
 111
 112   def result_getter(self):
 113     return '' if self.res.type == 'void' else '''static inline %s simcall_%s__get__result(smx_simcall_t simcall){
 114   return %s simcall->result.%s;
 115 }'''%(self.res.ret(), self.name, self.res.cast(), self.res.field())
 116
 117   def result_setter(self):
 118     return '' if self.res.type == 'void' else '''static inline void simcall_%s__set__result(smx_simcall_t simcall, %s result){
 119     simcall->result.%s = result;
 120 }'''%(self.name, self.res.type, self.res.field())
 121
 122   def args_getter_setter(self):
 123     res = []
 124     for i in range(len(self.args)):
 125       res.append(self.arg_getter(i))
 126       res.append(self.arg_setter(i))
 127     return '\n'.join(res)
 128
 129   def arg_getter(self, i):
 130     arg = self.args[i]
 131     return '''static inline %s simcall_%s__get__%s(smx_simcall_t simcall){
 132   return %s simcall->args[%i].%s;
 133 }'''%(arg.ret(), self.name, arg.name, arg.cast(), i, arg.field())
 134
 135   def arg_setter(self, i):
 136     arg = self.args[i]
 137     return '''static inline void simcall_%s__set__%s(smx_simcall_t simcall, %s arg){
 138     simcall->args[%i].%s = arg;
 139 }'''%(self.name, arg.name, arg.type, i, arg.field())
 140
 141   def case(self):
 142     return '''case SIMCALL_%s:
 143       %sSIMIX_pre_%s(simcall %s);
 144       %sbreak;
 145 '''%(self.name.upper(),
 146      'simcall->result.%s = '%self.res.field() if self.res.type != 'void' and self.has_answer else ' ',
 147      self.name,
 148      ''.join(', %s simcall->args[%d].%s'%(arg.cast(), i, arg.field())
 149              for i, arg in enumerate(self.args)),
 150      'SIMIX_simcall_answer(simcall);\n      ' if self.has_answer else ' ')
 151
 152   def body(self):
 153     return '''  inline static %s simcall_BODY_%s(%s) {
 154     smx_process_t self = SIMIX_process_self();
 155     self->simcall.call = SIMCALL_%s;
 156     memset(&self->simcall.result, 0, sizeof(self->simcall.result));
 157     memset(self->simcall.args, 0, sizeof(self->simcall.args));
 158 %s
 159     if (self != simix_global->maestro_process) {
 160       XBT_DEBUG("Yield process '%%s' on simcall %%s (%%d)", self->name,
 161                 SIMIX_simcall_name(self->simcall.call), (int)self->simcall.call);
 162       SIMIX_process_yield(self);
 163     } else {
 164       SIMIX_simcall_pre(&self->simcall, 0);
 165     }
 166     %s
 167   }'''%(self.res.ret()
 168        ,self.name
 169        ,', '.join('%s %s'%(arg.ret(), arg.name)
 170                   for arg in self.args)
 171        ,self.name.upper()
 172        ,'\n'.join('    self->simcall.args[%d].%s = (%s) %s;'%(i, arg.field(), arg.type, arg.name)
 173                   for i, arg in enumerate(self.args))
 174        ,'' if self.res.type == 'void' else 'return self->simcall.result.%s;'%self.res.field())
 175
 176 def parse(fn):
 177   res = []
 178   resdi = None
 179   resd = {}
 180   for line in open(fn).read().split('\n'):
 181     if line.startswith('##'):
 182       resdi = []
 183       resd[re.search(r'## *(.*)', line).group(1)] = resdi
 184     if line.startswith('#') or not line:
 185       continue
 186     match = re.match(r'(\S*?) *(\S*?) *\((.*?)(?:, *(.*?))?\) *(.*)', line)
 187     assert match, line
 188     name, ans, rest, resc, args = match.groups()
 189     sargs = []
 190     for n,t,c in re.findall(r'\((.*?), *(.*?)(?:, *(.*?))?\)', args):
 191       sargs.append(Arg(n,t,c))
 192     sim = Simcall(name, Arg('result', rest, resc), sargs, ans == 'True')
 193     if resdi is None:
 194       res.append(sim)
 195     else:
 196       resdi.append(sim)
 197   return res, resd
 198
 199 def write(fn, func, scs, scd):
 200   f = open(fn, 'w')
 201   f.write('/*********************************************\n')
 202   f.write(' * File Generated by src/simix/simcalls.py   *\n')
 203   f.write(' *                from src/simix/simcalls.in *\n')
 204   f.write(' * Do not modify this file, add new simcalls *\n')
 205   f.write(' * in src/simix/simcalls.in                  *\n')
 206   f.write(' *********************************************/\n\n')
 207   f.write('\n'.join(func(sc) for sc in scs))
 208   for k, v in scd.items():
 209     f.write('\n#ifdef %s\n%s\n#endif\n'%(k, '\n'.join(func(sc) for sc in v)))
 210   f.close()
 211
 212 if __name__=='__main__':
 213   import sys
 214   simcalls, simcalls_dict = parse('simcalls.in')
 215
 216   ok = True
 217   ok &= all(map(Simcall.check, simcalls))
 218   for k,v in simcalls_dict.items():
 219     ok &= all(map(Simcall.check, v))
 220   #if not ok:
 221   #  sys.exit(1)
 222
 223   write('simcalls_generated_enum.h', Simcall.enum, simcalls, simcalls_dict)
 224   write('simcalls_generated_string.c', Simcall.string, simcalls, simcalls_dict)
 225   write('simcalls_generated_res_getter_setter.h', Simcall.result_getter_setter, simcalls, simcalls_dict)
 226   write('simcalls_generated_args_getter_setter.h', Simcall.args_getter_setter, simcalls, simcalls_dict)
 227   write('simcalls_generated_case.c', Simcall.case, simcalls, simcalls_dict)
 228   write('simcalls_generated_body.c', Simcall.body, simcalls, simcalls_dict)