Address PR274 - '[JIT] Programs cannot resolve the fstat function'
[oota-llvm.git] / 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 "Support/DynamicLinker.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 void *FunctionPointers[] = {
51   (void *) stat,
52   (void *) stat64,
53   (void *) fstat,
54   (void *) fstat64,
55   (void *) lstat,
56   (void *) lstat64,
57   (void *) atexit,
58   (void *) mknod
59 };
60
61 // NoopFn - Used if we have nothing else to call...
62 static void NoopFn() {}
63
64 // jit_exit - Used to intercept the "exit" library call.
65 static void jit_exit(int Status) {
66   runAtExitHandlers();   // Run atexit handlers...
67   exit(Status);
68 }
69
70 // jit_atexit - Used to intercept the "atexit" library call.
71 static int jit_atexit(void (*Fn)(void)) {
72   AtExitHandlers.push_back(Fn);    // Take note of atexit handler...
73   return 0;  // Always successful
74 }
75
76 //===----------------------------------------------------------------------===//
77 // 
78 /// getPointerToNamedFunction - This method returns the address of the specified
79 /// function by using the dynamic loader interface.  As such it is only useful 
80 /// for resolving library symbols, not code generated symbols.
81 ///
82 void *JIT::getPointerToNamedFunction(const std::string &Name) {
83   // Check to see if this is one of the functions we want to intercept...
84   if (Name == "exit") return (void*)&jit_exit;
85   if (Name == "atexit") return (void*)&jit_atexit;
86
87   // If it's an external function, look it up in the process image...
88   void *Ptr = GetAddressOfSymbol(Name);
89   if (Ptr == 0) {
90     std::cerr << "WARNING: Cannot resolve fn '" << Name
91               << "' using a dummy noop function instead!\n";
92     Ptr = (void*)NoopFn;
93   }
94   
95   return Ptr;
96 }