1 //===-- ModelInjector.h -----------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
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.
22 //===----------------------------------------------------------------------===//
24 #ifndef LLVM_CLANG_SA_FRONTEND_MODELINJECTOR_H
25 #define LLVM_CLANG_SA_FRONTEND_MODELINJECTOR_H
27 #include "clang/Analysis/CodeInjector.h"
28 #include "llvm/ADT/StringMap.h"
32 class CompilerInstance;
39 class ModelInjector : public CodeInjector {
41 ModelInjector(CompilerInstance &CI);
42 Stmt *getBody(const FunctionDecl *D) override;
43 Stmt *getBody(const ObjCMethodDecl *D) override;
46 /// \brief Synthesize a body for a declaration
48 /// This method first looks up the appropriate model file based on the
49 /// model-path configuration option and the name of the declaration that is
50 /// looked up. If no model were synthesized yet for a function with that name
51 /// it will create a new compiler instance to parse the model file using the
52 /// ASTContext, Preprocessor, SourceManager of the original compiler instance.
53 /// The former resources are shared between the two compiler instance, so the
54 /// newly created instance have to "leak" these objects, since they are owned
55 /// by the original instance.
57 /// The model-path should be either an absolute path or relative to the
58 /// working directory of the compiler.
59 void onBodySynthesis(const NamedDecl *D);
63 // FIXME: double memoization is redundant, with memoization both here and in
65 llvm::StringMap<Stmt *> Bodies;