1 //===-- ModelInjector.h -----------------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 ///
10 /// \file
11 /// \brief This file defines the clang::ento::ModelInjector class which implements the
12 /// clang::CodeInjector interface. This class is responsible for injecting
13 /// function definitions that were synthesized from model files.
14 ///
15 /// Model files allow definitions of functions to be lazily constituted for functions
16 /// which lack bodies in the original source code.  This allows the analyzer
17 /// to more precisely analyze code that calls such functions, analyzing the
18 /// artificial definitions (which typically approximate the semantics of the
19 /// called function) when called by client code.  These definitions are
20 /// reconstituted lazily, on-demand, by the static analyzer engine.
21 ///
22 //===----------------------------------------------------------------------===//
23 
24 #ifndef LLVM_CLANG_SA_FRONTEND_MODELINJECTOR_H
25 #define LLVM_CLANG_SA_FRONTEND_MODELINJECTOR_H
26 
27 #include <map>
28 #include <vector>
29 #include <memory>
30 
31 #include "clang/Analysis/CodeInjector.h"
32 #include "llvm/ADT/IntrusiveRefCntPtr.h"
33 #include "llvm/ADT/StringMap.h"
34 
35 namespace clang {
36 
37 class CompilerInstance;
38 class ASTUnit;
39 class ASTReader;
40 class NamedDecl;
41 class Module;
42 
43 namespace ento {
44 class ModelInjector : public CodeInjector {
45 public:
46   ModelInjector(CompilerInstance &CI);
47   Stmt *getBody(const FunctionDecl *D);
48   Stmt *getBody(const ObjCMethodDecl *D);
49 
50 private:
51   /// \brief Synthesize a body for a declaration
52   ///
53   /// This method first looks up the appropriate model file based on the
54   /// model-path configuration option and the name of the declaration that is
55   /// looked up. If no model were synthesized yet for a function with that name
56   /// it will create a new compiler instance to parse the model file using the
57   /// ASTContext, Preprocessor, SourceManager of the original compiler instance.
58   /// The former resources are shared between the two compiler instance, so the
59   /// newly created instance have to "leak" these objects, since they are owned
60   /// by the original instance.
61   ///
62   /// The model-path should be either an absolute path or relative to the
63   /// working directory of the compiler.
64   void onBodySynthesis(const NamedDecl *D);
65 
66   CompilerInstance &CI;
67 
68   // FIXME: double memoization is redundant, with memoization both here and in
69   // BodyFarm.
70   llvm::StringMap<Stmt *> Bodies;
71 };
72 }
73 }
74 
75 #endif