lib/ExecutionEngine/Interpreter/ExternalFunctions.cpp

   1 //===-- ExternalMethods.cpp - Implement External Methods ------------------===//
   2 //
   3 //  This file contains both code to deal with invoking "external" methods, but
   4 //  also contains code that implements "exported" external methods.
   5 //
   6 //  External methods in LLI are implemented by dlopen'ing the lli executable and
   7 //  using dlsym to look op the methods that we want to invoke.  If a method is
   8 //  found, then the arguments are mangled and passed in to the function call.
   9 //
  10 //===----------------------------------------------------------------------===//
  11
  12 #include "Interpreter.h"
  13 #include "llvm/DerivedTypes.h"
  14 #include <map>
  15 #include <dlfcn.h>
  16 #include <link.h>
  17 #include <math.h>
  18 #include <stdio.h>
  19
  20 typedef GenericValue (*ExFunc)(MethodType *, const vector<GenericValue> &);
  21 static map<const Method *, ExFunc> Functions;
  22 static map<string, ExFunc> FuncNames;
  23
  24 static Interpreter *TheInterpreter;
  25
  26 // getCurrentExecutablePath() - Return the directory that the lli executable
  27 // lives in.
  28 //
  29 string Interpreter::getCurrentExecutablePath() const {
  30   Dl_info Info;
  31   if (dladdr(&TheInterpreter, &Info) == 0) return "";
  32
  33   string LinkAddr(Info.dli_fname);
  34   unsigned SlashPos = LinkAddr.rfind('/');
  35   if (SlashPos != string::npos)
  36     LinkAddr.resize(SlashPos);    // Trim the executable name off...
  37
  38   return LinkAddr;
  39 }
  40
  41
  42 static char getTypeID(const Type *Ty) {
  43   switch (Ty->getPrimitiveID()) {
  44   case Type::VoidTyID:    return 'V';
  45   case Type::BoolTyID:    return 'o';
  46   case Type::UByteTyID:   return 'B';
  47   case Type::SByteTyID:   return 'b';
  48   case Type::UShortTyID:  return 'S';
  49   case Type::ShortTyID:   return 's';
  50   case Type::UIntTyID:    return 'I';
  51   case Type::IntTyID:     return 'i';
  52   case Type::ULongTyID:   return 'L';
  53   case Type::LongTyID:    return 'l';
  54   case Type::FloatTyID:   return 'F';
  55   case Type::DoubleTyID:  return 'D';
  56   case Type::PointerTyID: return 'P';
  57   case Type::MethodTyID:  return 'M';
  58   case Type::StructTyID:  return 'T';
  59   case Type::ArrayTyID:   return 'A';
  60   case Type::OpaqueTyID:  return 'O';
  61   default: return 'U';
  62   }
  63 }
  64
  65 static ExFunc lookupMethod(const Method *M) {
  66   // Function not found, look it up... start by figuring out what the
  67   // composite function name should be.
  68   string ExtName = "lle_";
  69   const MethodType *MT = M->getMethodType();
  70   for (unsigned i = 0; const Type *Ty = MT->getContainedType(i); ++i)
  71     ExtName += getTypeID(Ty);
  72   ExtName += "_" + M->getName();
  73
  74   //cout << "Tried: '" << ExtName << "'\n";
  75   ExFunc FnPtr = FuncNames[ExtName];
  76   if (FnPtr == 0)
  77     FnPtr = (ExFunc)dlsym(RTLD_DEFAULT, ExtName.c_str());
  78   if (FnPtr == 0)
  79     FnPtr = FuncNames["lle_X_"+M->getName()];
  80   if (FnPtr == 0)  // Try calling a generic function... if it exists...
  81     FnPtr = (ExFunc)dlsym(RTLD_DEFAULT, ("lle_X_"+M->getName()).c_str());
  82   if (FnPtr != 0)
  83     Functions.insert(make_pair(M, FnPtr));  // Cache for later
  84   return FnPtr;
  85 }
  86
  87 GenericValue Interpreter::callExternalMethod(Method *M,
  88                                          const vector<GenericValue> &ArgVals) {
  89   TheInterpreter = this;
  90
  91   // Do a lookup to see if the method is in our cache... this should just be a
  92   // defered annotation!
  93   map<const Method *, ExFunc>::iterator FI = Functions.find(M);
  94   ExFunc Fn = (FI == Functions.end()) ? lookupMethod(M) : FI->second;
  95   if (Fn == 0) {
  96     cout << "Tried to execute an unknown external method: "
  97          << M->getType()->getDescription() << " " << M->getName() << endl;
  98     return GenericValue();
  99   }
 100
 101   // TODO: FIXME when types are not const!
 102   GenericValue Result = Fn(const_cast<MethodType*>(M->getMethodType()),ArgVals);
 103   return Result;
 104 }
 105
 106
 107 //===----------------------------------------------------------------------===//
 108 //  Methods "exported" to the running application...
 109 //
 110 extern "C" {  // Don't add C++ manglings to llvm mangling :)
 111
 112 // Implement void printstr([ubyte {x N}] *)
 113 GenericValue lle_VP_printstr(MethodType *M, const vector<GenericValue> &ArgVal){
 114   assert(ArgVal.size() == 1 && "printstr only takes one argument!");
 115   cout << (char*)ArgVal[0].PointerVal;
 116   return GenericValue();
 117 }
 118
 119 // Implement 'void print(X)' for every type...
 120 GenericValue lle_X_print(MethodType *M, const vector<GenericValue> &ArgVals) {
 121   assert(ArgVals.size() == 1 && "generic print only takes one argument!");
 122
 123   Interpreter::print(M->getParamTypes()[0], ArgVals[0]);
 124   return GenericValue();
 125 }
 126
 127 // Implement 'void printVal(X)' for every type...
 128 GenericValue lle_X_printVal(MethodType *M, const vector<GenericValue> &ArgVal) {
 129   assert(ArgVal.size() == 1 && "generic print only takes one argument!");
 130
 131   // Specialize print([ubyte {x N} ] *) and print(sbyte *)
 132   if (PointerType *PTy = dyn_cast<PointerType>(M->getParamTypes()[0].get()))
 133     if (PTy->getValueType() == Type::SByteTy ||
 134         isa<ArrayType>(PTy->getValueType())) {
 135       return lle_VP_printstr(M, ArgVal);
 136     }
 137
 138   Interpreter::printValue(M->getParamTypes()[0], ArgVal[0]);
 139   return GenericValue();
 140 }
 141
 142 // Implement 'void printString(X)'
 143 // Argument must be [ubyte {x N} ] * or sbyte *
 144 GenericValue lle_X_printString(MethodType *M, const vector<GenericValue> &ArgVal) {
 145   assert(ArgVal.size() == 1 && "generic print only takes one argument!");
 146   return lle_VP_printstr(M, ArgVal);
 147 }
 148
 149 // Implement 'void print<TYPE>(X)' for each primitive type or pointer type
 150 #define PRINT_TYPE_FUNC(TYPENAME,TYPEID) \
 151   GenericValue lle_X_print##TYPENAME(MethodType *M,\
 152                                      const vector<GenericValue> &ArgVal) {\
 153     assert(ArgVal.size() == 1 && "generic print only takes one argument!");\
 154     assert(M->getParamTypes()[0].get()->getPrimitiveID() == Type::##TYPEID);\
 155     Interpreter::printValue(M->getParamTypes()[0], ArgVal[0]);\
 156     return GenericValue();\
 157   }
 158
 159 PRINT_TYPE_FUNC(SByte,   SByteTyID)
 160 PRINT_TYPE_FUNC(UByte,   UByteTyID)
 161 PRINT_TYPE_FUNC(Short,   ShortTyID)
 162 PRINT_TYPE_FUNC(UShort,  UShortTyID)
 163 PRINT_TYPE_FUNC(Int,     IntTyID)
 164 PRINT_TYPE_FUNC(UInt,    UIntTyID)
 165 PRINT_TYPE_FUNC(Long,    LongTyID)
 166 PRINT_TYPE_FUNC(ULong,   ULongTyID)
 167 PRINT_TYPE_FUNC(Float,   FloatTyID)
 168 PRINT_TYPE_FUNC(Double,  DoubleTyID)
 169 PRINT_TYPE_FUNC(Pointer, PointerTyID)
 170
 171
 172 // void "putchar"(sbyte)
 173 GenericValue lle_Vb_putchar(MethodType *M, const vector<GenericValue> &Args) {
 174   cout << Args[0].SByteVal;
 175   return GenericValue();
 176 }
 177
 178 // int "putchar"(int)
 179 GenericValue lle_ii_putchar(MethodType *M, const vector<GenericValue> &Args) {
 180   cout << ((char)Args[0].IntVal) << flush;
 181   return Args[0];
 182 }
 183
 184 // void "putchar"(ubyte)
 185 GenericValue lle_VB_putchar(MethodType *M, const vector<GenericValue> &Args) {
 186   cout << Args[0].SByteVal << flush;
 187   return Args[0];
 188 }
 189
 190 // void "__main"()
 191 GenericValue lle_V___main(MethodType *M, const vector<GenericValue> &Args) {
 192   return GenericValue();
 193 }
 194
 195 // void "exit"(int)
 196 GenericValue lle_X_exit(MethodType *M, const vector<GenericValue> &Args) {
 197   TheInterpreter->exitCalled(Args[0]);
 198   return GenericValue();
 199 }
 200
 201 // void *malloc(uint)
 202 GenericValue lle_X_malloc(MethodType *M, const vector<GenericValue> &Args) {
 203   assert(Args.size() == 1 && "Malloc expects one argument!");
 204   GenericValue GV;
 205   GV.PointerVal = (PointerTy)malloc(Args[0].UIntVal);
 206   return GV;
 207 }
 208
 209 // void free(void *)
 210 GenericValue lle_X_free(MethodType *M, const vector<GenericValue> &Args) {
 211   assert(Args.size() == 1);
 212   free((void*)Args[0].PointerVal);
 213   return GenericValue();
 214 }
 215
 216 // int atoi(char *)
 217 GenericValue lle_X_atoi(MethodType *M, const vector<GenericValue> &Args) {
 218   assert(Args.size() == 1);
 219   GenericValue GV;
 220   GV.IntVal = atoi((char*)Args[0].PointerVal);
 221   return GV;
 222 }
 223
 224 // double pow(double, double)
 225 GenericValue lle_X_pow(MethodType *M, const vector<GenericValue> &Args) {
 226   assert(Args.size() == 2);
 227   GenericValue GV;
 228   GV.DoubleVal = pow(Args[0].DoubleVal, Args[1].DoubleVal);
 229   return GV;
 230 }
 231
 232 // double sqrt(double)
 233 GenericValue lle_X_sqrt(MethodType *M, const vector<GenericValue> &Args) {
 234   assert(Args.size() == 1);
 235   GenericValue GV;
 236   GV.DoubleVal = sqrt(Args[0].DoubleVal);
 237   return GV;
 238 }
 239
 240 // double log(double)
 241 GenericValue lle_X_log(MethodType *M, const vector<GenericValue> &Args) {
 242   assert(Args.size() == 1);
 243   GenericValue GV;
 244   GV.DoubleVal = log(Args[0].DoubleVal);
 245   return GV;
 246 }
 247
 248 // double floor(double)
 249 GenericValue lle_X_floor(MethodType *M, const vector<GenericValue> &Args) {
 250   assert(Args.size() == 1);
 251   GenericValue GV;
 252   GV.DoubleVal = floor(Args[0].DoubleVal);
 253   return GV;
 254 }
 255
 256 // double drand48()
 257 GenericValue lle_X_drand48(MethodType *M, const vector<GenericValue> &Args) {
 258   assert(Args.size() == 0);
 259   GenericValue GV;
 260   GV.DoubleVal = drand48();
 261   return GV;
 262 }
 263
 264 // long lrand48()
 265 GenericValue lle_X_lrand48(MethodType *M, const vector<GenericValue> &Args) {
 266   assert(Args.size() == 0);
 267   GenericValue GV;
 268   GV.IntVal = lrand48();
 269   return GV;
 270 }
 271
 272 // void srand48(long)
 273 GenericValue lle_X_srand48(MethodType *M, const vector<GenericValue> &Args) {
 274   assert(Args.size() == 1);
 275   srand48(Args[0].IntVal);
 276   return GenericValue();
 277 }
 278
 279 // void srand(uint)
 280 GenericValue lle_X_srand(MethodType *M, const vector<GenericValue> &Args) {
 281   assert(Args.size() == 1);
 282   srand(Args[0].UIntVal);
 283   return GenericValue();
 284 }
 285
 286 // int printf(sbyte *, ...) - a very rough implementation to make output useful.
 287 GenericValue lle_X_printf(MethodType *M, const vector<GenericValue> &Args) {
 288   const char *FmtStr = (const char *)Args[0].PointerVal;
 289   unsigned ArgNo = 1;
 290
 291   // printf should return # chars printed.  This is completely incorrect, but
 292   // close enough for now.
 293   GenericValue GV; GV.IntVal = strlen(FmtStr);
 294   while (1) {
 295     switch (*FmtStr) {
 296     case 0: return GV;             // Null terminator...
 297     default:                       // Normal nonspecial character
 298       cout << *FmtStr++;
 299       break;
 300     case '\\': {                   // Handle escape codes
 301       char Buffer[3];
 302       Buffer[0] = *FmtStr++;
 303       Buffer[1] = *FmtStr++;
 304       Buffer[2] = 0;
 305       cout << Buffer;
 306       break;
 307     }
 308     case '%': {                    // Handle format specifiers
 309       char FmtBuf[100] = "", Buffer[1000] = "";
 310       char *FB = FmtBuf;
 311       *FB++ = *FmtStr++;
 312       char Last = *FB++ = *FmtStr++;
 313       unsigned HowLong = 0;
 314       while (Last != 'c' && Last != 'd' && Last != 'i' && Last != 'u' &&
 315              Last != 'o' && Last != 'x' && Last != 'X' && Last != 'e' &&
 316              Last != 'E' && Last != 'g' && Last != 'G' && Last != 'f' &&
 317              Last != 'p' && Last != 's' && Last != '%') {
 318         if (Last == 'l' || Last == 'L') HowLong++;  // Keep track of l's
 319         Last = *FB++ = *FmtStr++;
 320       }
 321       *FB = 0;
 322
 323       switch (Last) {
 324       case '%':
 325         sprintf(Buffer, FmtBuf); break;
 326       case 'c':
 327         sprintf(Buffer, FmtBuf, Args[ArgNo++].SByteVal); break;
 328       case 'd': case 'i':
 329       case 'u': case 'o':
 330       case 'x': case 'X':
 331         if (HowLong == 2)
 332           sprintf(Buffer, FmtBuf, Args[ArgNo++].ULongVal);
 333         else
 334           sprintf(Buffer, FmtBuf, Args[ArgNo++].IntVal); break;
 335       case 'e': case 'E': case 'g': case 'G': case 'f':
 336         sprintf(Buffer, FmtBuf, Args[ArgNo++].DoubleVal); break;
 337       case 'p':
 338         sprintf(Buffer, FmtBuf, (void*)Args[ArgNo++].PointerVal); break;
 339       case 's':
 340         sprintf(Buffer, FmtBuf, (char*)Args[ArgNo++].PointerVal); break;
 341       default:  cout << "<unknown printf code '" << *FmtStr << "'!>";
 342         ArgNo++; break;
 343       }
 344       cout << Buffer;
 345       }
 346       break;
 347     }
 348   }
 349 }
 350
 351 } // End extern "C"
 352
 353
 354 void Interpreter::initializeExternalMethods() {
 355   FuncNames["lle_VP_printstr"] = lle_VP_printstr;
 356   FuncNames["lle_X_print"] = lle_X_print;
 357   FuncNames["lle_X_printVal"] = lle_X_printVal;
 358   FuncNames["lle_X_printString"] = lle_X_printString;
 359   FuncNames["lle_X_printUByte"] = lle_X_printUByte;
 360   FuncNames["lle_X_printSByte"] = lle_X_printSByte;
 361   FuncNames["lle_X_printUShort"] = lle_X_printUShort;
 362   FuncNames["lle_X_printShort"] = lle_X_printShort;
 363   FuncNames["lle_X_printInt"] = lle_X_printInt;
 364   FuncNames["lle_X_printUInt"] = lle_X_printUInt;
 365   FuncNames["lle_X_printLong"] = lle_X_printLong;
 366   FuncNames["lle_X_printULong"] = lle_X_printULong;
 367   FuncNames["lle_X_printFloat"] = lle_X_printFloat;
 368   FuncNames["lle_X_printDouble"] = lle_X_printDouble;
 369   FuncNames["lle_X_printPointer"] = lle_X_printPointer;
 370   FuncNames["lle_Vb_putchar"]     = lle_Vb_putchar;
 371   FuncNames["lle_ii_putchar"]     = lle_ii_putchar;
 372   FuncNames["lle_VB_putchar"]     = lle_VB_putchar;
 373   FuncNames["lle_V___main"]       = lle_V___main;
 374   FuncNames["lle_X_exit"]         = lle_X_exit;
 375   FuncNames["lle_X_malloc"]       = lle_X_malloc;
 376   FuncNames["lle_X_free"]         = lle_X_free;
 377   FuncNames["lle_X_atoi"]         = lle_X_atoi;
 378   FuncNames["lle_X_pow"]          = lle_X_pow;
 379   FuncNames["lle_X_log"]          = lle_X_log;
 380   FuncNames["lle_X_floor"]        = lle_X_floor;
 381   FuncNames["lle_X_srand"]        = lle_X_srand;
 382   FuncNames["lle_X_drand48"]      = lle_X_drand48;
 383   FuncNames["lle_X_srand48"]      = lle_X_srand48;
 384   FuncNames["lle_X_lrand48"]      = lle_X_lrand48;
 385   FuncNames["lle_X_sqrt"]         = lle_X_sqrt;
 386   FuncNames["lle_X_printf"]       = lle_X_printf;
 387 }