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