lib/ExecutionEngine/JIT/Intercept.cpp

   1 //===-- Intercept.cpp - System function interception routines -------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // If a function call occurs to an external function, the JIT is designed to use
  11 // the dynamic loader interface to find a function to call.  This is useful for
  12 // calling system calls and library functions that are not available in LLVM.
  13 // Some system calls, however, need to be handled specially.  For this reason,
  14 // we intercept some of them here and use our own stubs to handle them.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "JIT.h"
  19 #include "llvm/System/DynamicLibrary.h"
  20 #include <iostream>
  21 #include <sys/stat.h>
  22 using namespace llvm;
  23
  24 // AtExitHandlers - List of functions to call when the program exits,
  25 // registered with the atexit() library function.
  26 static std::vector<void (*)()> AtExitHandlers;
  27
  28 /// runAtExitHandlers - Run any functions registered by the program's
  29 /// calls to atexit(3), which we intercept and store in
  30 /// AtExitHandlers.
  31 ///
  32 static void runAtExitHandlers() {
  33   while (!AtExitHandlers.empty()) {
  34     void (*Fn)() = AtExitHandlers.back();
  35     AtExitHandlers.pop_back();
  36     Fn();
  37   }
  38 }
  39
  40 //===----------------------------------------------------------------------===//
  41 // Function stubs that are invoked instead of certain library calls
  42 //===----------------------------------------------------------------------===//
  43
  44 // Force the following functions to be linked in to anything that uses the
  45 // JIT. This is a hack designed to work around the all-too-clever Glibc
  46 // strategy of making these functions work differently when inlined vs. when
  47 // not inlined, and hiding their real definitions in a separate archive file
  48 // that the dynamic linker can't see. For more info, search for
  49 // 'libc_nonshared.a' on Google, or read http://llvm.cs.uiuc.edu/PR274.
  50 #if defined(__linux__)
  51 void *FunctionPointers[] = {
  52   (void *) stat,
  53   (void *) fstat,
  54   (void *) lstat,
  55   (void *) stat64,
  56   (void *) fstat64,
  57   (void *) lstat64,
  58   (void *) atexit,
  59   (void *) mknod
  60 };
  61 #endif // __linux__
  62
  63 // __mainFunc - If the program does not have a linked in __main function, allow
  64 // it to run, but print a warning.
  65 static void __mainFunc() {
  66   fprintf(stderr, "WARNING: Program called __main but was not linked to "
  67           "libcrtend.a.\nThis probably won't hurt anything unless the "
  68           "program is written in C++.\n");
  69 }
  70
  71 // jit_exit - Used to intercept the "exit" library call.
  72 static void jit_exit(int Status) {
  73   runAtExitHandlers();   // Run atexit handlers...
  74   exit(Status);
  75 }
  76
  77 // jit_atexit - Used to intercept the "atexit" library call.
  78 static int jit_atexit(void (*Fn)(void)) {
  79   AtExitHandlers.push_back(Fn);    // Take note of atexit handler...
  80   return 0;  // Always successful
  81 }
  82
  83 //===----------------------------------------------------------------------===//
  84 //
  85 /// getPointerToNamedFunction - This method returns the address of the specified
  86 /// function by using the dynamic loader interface.  As such it is only useful
  87 /// for resolving library symbols, not code generated symbols.
  88 ///
  89 void *JIT::getPointerToNamedFunction(const std::string &Name) {
  90   // Check to see if this is one of the functions we want to intercept...
  91   if (Name == "exit") return (void*)&jit_exit;
  92   if (Name == "atexit") return (void*)&jit_atexit;
  93
  94   // If the program does not have a linked in __main function, allow it to run,
  95   // but print a warning.
  96   if (Name == "__main") return (void*)&__mainFunc;
  97
  98   // If it's an external function, look it up in the process image...
  99   void *Ptr = sys::DynamicLibrary::SearchForAddressOfSymbol(Name);
 100   if (Ptr) return Ptr;
 101
 102   // If this is darwin, it has some funky issues, try to solve them here.  Some
 103   // important symbols are marked 'private external' which doesn't allow
 104   // SearchForAddressOfSymbol to find them.  As such, we special case them here,
 105   // there is only a small handful of them.
 106 #ifdef __APPLE__
 107   {
 108     extern void *__ashldi3;    if (Name == "__ashldi3")    return &__ashldi3;
 109     extern void *__ashrdi3;    if (Name == "__ashrdi3")    return &__ashrdi3;
 110     extern void *__cmpdi2;     if (Name == "__cmpdi2")     return &__cmpdi2;
 111     extern void *__divdi3;     if (Name == "__divdi3")     return &__divdi3;
 112     extern void *__eprintf;    if (Name == "__eprintf")    return &__eprintf;
 113     extern void *__fixdfdi;    if (Name == "__fixdfdi")    return &__fixdfdi;
 114     extern void *__fixsfdi;    if (Name == "__fixsfdi")    return &__fixsfdi;
 115     extern void *__fixunsdfdi; if (Name == "__fixunsdfdi") return &__fixunsdfdi;
 116     extern void *__fixunssfdi; if (Name == "__fixunssfdi") return &__fixunssfdi;
 117     extern void *__floatdidf;  if (Name == "__floatdidf")  return &__floatdidf;
 118     extern void *__floatdisf;  if (Name == "__floatdisf")  return &__floatdisf;
 119     extern void *__lshrdi3;    if (Name == "__lshrdi3")    return &__lshrdi3;
 120     extern void *__moddi3;     if (Name == "__moddi3")     return &__moddi3;
 121     extern void *__udivdi3;    if (Name == "__udivdi3")    return &__udivdi3;
 122     extern void *__umoddi3;    if (Name == "__umoddi3")    return &__umoddi3;
 123   }
 124 #endif
 125
 126   std::cerr << "ERROR: Program used external function '" << Name
 127             << "' which could not be resolved!\n";
 128   abort();
 129   return 0;
 130 }