CheckerContext.h revision 2f3017f9cbd3774f690c979410bfec38423d03af
16bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis//== CheckerContext.h - Context info for path-sensitive checkers--*- C++ -*--=// 26bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// 36bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// The LLVM Compiler Infrastructure 46bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// 56bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// This file is distributed under the University of Illinois Open Source 66bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// License. See LICENSE.TXT for details. 76bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// 86bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 96bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// 106bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// This file defines CheckerContext that provides contextual info for 116bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// path-sensitive checkers. 126bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// 136bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 146bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 156bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis#ifndef LLVM_CLANG_SA_CORE_PATHSENSITIVE_CHECKERCONTEXT 166bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis#define LLVM_CLANG_SA_CORE_PATHSENSITIVE_CHECKERCONTEXT 176bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 186bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 195ac1df3e15f91ed663826faec7efe2462c18d98cAnna Zaks 206bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidisnamespace clang { 216bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidisnamespace ento { 226bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 236bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidisclass CheckerContext { 246bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ExprEngine &Eng; 2557300760964904cc022a175643342f29f46b7e6bAnna Zaks /// The current exploded(symbolic execution) graph node. 266bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ExplodedNode *Pred; 2757300760964904cc022a175643342f29f46b7e6bAnna Zaks /// The flag is true if the (state of the execution) has been modified 2857300760964904cc022a175643342f29f46b7e6bAnna Zaks /// by the checker using this context. For example, a new transition has been 2957300760964904cc022a175643342f29f46b7e6bAnna Zaks /// added or a bug report issued. 3057300760964904cc022a175643342f29f46b7e6bAnna Zaks bool Changed; 3157300760964904cc022a175643342f29f46b7e6bAnna Zaks /// The tagged location, which is used to generate all new nodes. 323f5e8d87dbf449d8b39fe96068415428594d370eAnna Zaks const ProgramPoint Location; 333152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks NodeBuilder &NB; 34063e0887ad65d666d23ee3178436ad6507abbd1bAnna Zaks 356bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidispublic: 36514f2c9dcb9e04b52929c5b141a6fe88bd68b33fTed Kremenek /// If we are post visiting a call, this flag will be set if the 37514f2c9dcb9e04b52929c5b141a6fe88bd68b33fTed Kremenek /// call was inlined. In all other cases it will be false. 38514f2c9dcb9e04b52929c5b141a6fe88bd68b33fTed Kremenek const bool wasInlined; 39514f2c9dcb9e04b52929c5b141a6fe88bd68b33fTed Kremenek 408ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks CheckerContext(NodeBuilder &builder, 4118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExprEngine &eng, 4218c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *pred, 43514f2c9dcb9e04b52929c5b141a6fe88bd68b33fTed Kremenek const ProgramPoint &loc, 44514f2c9dcb9e04b52929c5b141a6fe88bd68b33fTed Kremenek bool wasInlined = false) 458ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks : Eng(eng), 4618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek Pred(pred), 4757300760964904cc022a175643342f29f46b7e6bAnna Zaks Changed(false), 483f5e8d87dbf449d8b39fe96068415428594d370eAnna Zaks Location(loc), 49514f2c9dcb9e04b52929c5b141a6fe88bd68b33fTed Kremenek NB(builder), 50514f2c9dcb9e04b52929c5b141a6fe88bd68b33fTed Kremenek wasInlined(wasInlined) { 51777d706547ebc751d998134774d9d5388fff8e02Anna Zaks assert(Pred->getState() && 52777d706547ebc751d998134774d9d5388fff8e02Anna Zaks "We should not call the checkers on an empty state."); 53777d706547ebc751d998134774d9d5388fff8e02Anna Zaks } 546bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 556bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis AnalysisManager &getAnalysisManager() { 566bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getAnalysisManager(); 576bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 586bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 596bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ConstraintManager &getConstraintManager() { 606bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getConstraintManager(); 616bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 626bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 636bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis StoreManager &getStoreManager() { 646bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getStoreManager(); 656bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 666bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 67255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek const AnalyzerOptions::ConfigTable &getConfig() const { 68255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek return Eng.getAnalysisManager().options.Config; 697b73e0832b20af1f43601a3d19e76d02d9f4dce5Ted Kremenek } 707b73e0832b20af1f43601a3d19e76d02d9f4dce5Ted Kremenek 71a2a860306e3697fcf7a12c5ba59551ca60578968Anna Zaks /// \brief Returns the previous node in the exploded graph, which includes 72a2a860306e3697fcf7a12c5ba59551ca60578968Anna Zaks /// the state of the program before the checker ran. Note, checkers should 73a2a860306e3697fcf7a12c5ba59551ca60578968Anna Zaks /// not retain the node in their state since the nodes might get invalidated. 7439ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks ExplodedNode *getPredecessor() { return Pred; } 758bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getState() const { return Pred->getState(); } 766bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 7757300760964904cc022a175643342f29f46b7e6bAnna Zaks /// \brief Check if the checker changed the state of the execution; ex: added 7857300760964904cc022a175643342f29f46b7e6bAnna Zaks /// a new transition or a bug report. 7957300760964904cc022a175643342f29f46b7e6bAnna Zaks bool isDifferent() { return Changed; } 8057300760964904cc022a175643342f29f46b7e6bAnna Zaks 815d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks /// \brief Returns the number of times the current block has been visited 825d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks /// along the analyzed path. 8366c486f275531df6362b3511fc3af6563561801bTed Kremenek unsigned blockCount() const { 8466c486f275531df6362b3511fc3af6563561801bTed Kremenek return NB.getContext().blockCount(); 85ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks } 865d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks 876bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ASTContext &getASTContext() { 886bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getContext(); 896bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 90461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks 914e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &getLangOpts() const { 924e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Eng.getContext().getLangOpts(); 93461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks } 94461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks 95eeea7c44a6986752fedee1ef1bcef855db373872Anna Zaks const LocationContext *getLocationContext() const { 9639ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks return Pred->getLocationContext(); 9739ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks } 9839ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks 99955cd444f445bcdbade1cdd3926254c8ee7890d8Anna Zaks const StackFrameContext *getStackFrame() const { 100955cd444f445bcdbade1cdd3926254c8ee7890d8Anna Zaks return Pred->getStackFrame(); 101c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks } 102c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks 10305fcbd3dc28f4cba4a6d33e7aeaabb5f6f7837e3Anna Zaks /// Returns true if the predecessor is within an inlined function/method. 10405fcbd3dc28f4cba4a6d33e7aeaabb5f6f7837e3Anna Zaks bool isWithinInlined() { 105dc601f4a9f69315521abddbca04d4652deee5fdbAnna Zaks return (getStackFrame()->getParent() != 0); 10605fcbd3dc28f4cba4a6d33e7aeaabb5f6f7837e3Anna Zaks } 10705fcbd3dc28f4cba4a6d33e7aeaabb5f6f7837e3Anna Zaks 1086bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis BugReporter &getBugReporter() { 1096bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getBugReporter(); 1106bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1116bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1126bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis SourceManager &getSourceManager() { 1136bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return getBugReporter().getSourceManager(); 1146bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1156bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1166bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis SValBuilder &getSValBuilder() { 1176bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getSValBuilder(); 1186bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1196bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1203f10e32b15e54f507aed90cb72d73c7acaa500bbAnna Zaks SymbolManager &getSymbolManager() { 1213f10e32b15e54f507aed90cb72d73c7acaa500bbAnna Zaks return getSValBuilder().getSymbolManager(); 1223f10e32b15e54f507aed90cb72d73c7acaa500bbAnna Zaks } 1233f10e32b15e54f507aed90cb72d73c7acaa500bbAnna Zaks 124eeea7c44a6986752fedee1ef1bcef855db373872Anna Zaks bool isObjCGCEnabled() const { 12517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return Eng.isObjCGCEnabled(); 12617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose } 12717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 1286a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ProgramStateManager &getStateManager() { 1296a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks return Eng.getStateManager(); 1306a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks } 1316a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks 132063e0887ad65d666d23ee3178436ad6507abbd1bAnna Zaks AnalysisDeclContext *getCurrentAnalysisDeclContext() const { 133063e0887ad65d666d23ee3178436ad6507abbd1bAnna Zaks return Pred->getLocationContext()->getAnalysisDeclContext(); 134063e0887ad65d666d23ee3178436ad6507abbd1bAnna Zaks } 135063e0887ad65d666d23ee3178436ad6507abbd1bAnna Zaks 1363d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks /// \brief If the given node corresponds to a PostStore program point, retrieve 1373d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks /// the location region as it was uttered in the code. 1383d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks /// 1393d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks /// This utility can be useful for generating extensive diagnostics, for 1403d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks /// example, for finding variables that the given symbol was assigned to. 1413d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks static const MemRegion *getLocationRegionIfPostStore(const ExplodedNode *N) { 1423d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks ProgramPoint L = N->getLocation(); 1433d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks if (const PostStore *PSL = dyn_cast<PostStore>(&L)) 1443d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks return reinterpret_cast<const MemRegion*>(PSL->getLocationValue()); 1453d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks return 0; 1463d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks } 1473d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks 148c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks /// \brief Get the value of arbitrary expressions at this point in the path. 149c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks SVal getSVal(const Stmt *S) const { 150c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks return getState()->getSVal(S, getLocationContext()); 151c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks } 152c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks 1530bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// \brief Generates a new transition in the program state graph 1540bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// (ExplodedGraph). Uses the default CheckerContext predecessor node. 1550bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// 156fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose /// @param State The state of the generated node. If not specified, the state 157fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose /// will not be changed, but the new node will have the checker's tag. 1580bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// @param Tag The tag is used to uniquely identify the creation site. If no 1590bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// tag is specified, a default tag, unique to the given checker, 1600bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// will be used. Tags are used to prevent states generated at 1610bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// different sites from caching out. 162fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose ExplodedNode *addTransition(ProgramStateRef State = 0, 1630bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks const ProgramPointTag *Tag = 0) { 164fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose return addTransitionImpl(State ? State : getState(), false, 0, Tag); 165063e0887ad65d666d23ee3178436ad6507abbd1bAnna Zaks } 166063e0887ad65d666d23ee3178436ad6507abbd1bAnna Zaks 1670bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// \brief Generates a new transition with the given predecessor. 1688ba721428af297e540fb40b176eeeea0ee010c1fAnna Zaks /// Allows checkers to generate a chain of nodes. 1690bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// 1700bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// @param State The state of the generated node. 1710bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// @param Pred The transition will be generated from the specified Pred node 1720bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// to the newly generated node. 1730bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks /// @param Tag The tag to uniquely identify the creation site. 1748bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *addTransition(ProgramStateRef State, 175fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose ExplodedNode *Pred, 176fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose const ProgramPointTag *Tag = 0) { 177fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose return addTransitionImpl(State, false, Pred, Tag); 1786bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1796bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 180fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose /// \brief Generate a sink node. Generating a sink stops exploration of the 1818ba721428af297e540fb40b176eeeea0ee010c1fAnna Zaks /// given path. 182fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose ExplodedNode *generateSink(ProgramStateRef State = 0, 183fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose ExplodedNode *Pred = 0, 184fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose const ProgramPointTag *Tag = 0) { 185fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose return addTransitionImpl(State ? State : getState(), true, Pred, Tag); 1866bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1876bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 188063e0887ad65d666d23ee3178436ad6507abbd1bAnna Zaks /// \brief Emit the diagnostics report. 189785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose void emitReport(BugReport *R) { 19057300760964904cc022a175643342f29f46b7e6bAnna Zaks Changed = true; 191785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose Eng.getBugReporter().emitReport(R); 1926bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1936bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 194b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks /// \brief Get the declaration of the called function (path-sensitive). 195b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks const FunctionDecl *getCalleeDecl(const CallExpr *CE) const; 196b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks 1970e12ebfd3ef9ad5d894466c6e4910ac5e6041034Anna Zaks /// \brief Get the name of the called function (path-sensitive). 1989b0c749a20d0f7d0e63441d76baa15def3f37fdbAnna Zaks StringRef getCalleeName(const FunctionDecl *FunDecl) const; 1999b0c749a20d0f7d0e63441d76baa15def3f37fdbAnna Zaks 2005ac1df3e15f91ed663826faec7efe2462c18d98cAnna Zaks /// \brief Get the identifier of the called function (path-sensitive). 2015ac1df3e15f91ed663826faec7efe2462c18d98cAnna Zaks const IdentifierInfo *getCalleeIdentifier(const CallExpr *CE) const { 2025ac1df3e15f91ed663826faec7efe2462c18d98cAnna Zaks const FunctionDecl *FunDecl = getCalleeDecl(CE); 2035ac1df3e15f91ed663826faec7efe2462c18d98cAnna Zaks if (FunDecl) 2045ac1df3e15f91ed663826faec7efe2462c18d98cAnna Zaks return FunDecl->getIdentifier(); 2055ac1df3e15f91ed663826faec7efe2462c18d98cAnna Zaks else 2065ac1df3e15f91ed663826faec7efe2462c18d98cAnna Zaks return 0; 2075ac1df3e15f91ed663826faec7efe2462c18d98cAnna Zaks } 2085ac1df3e15f91ed663826faec7efe2462c18d98cAnna Zaks 2099b0c749a20d0f7d0e63441d76baa15def3f37fdbAnna Zaks /// \brief Get the name of the called function (path-sensitive). 2109b0c749a20d0f7d0e63441d76baa15def3f37fdbAnna Zaks StringRef getCalleeName(const CallExpr *CE) const { 2119b0c749a20d0f7d0e63441d76baa15def3f37fdbAnna Zaks const FunctionDecl *FunDecl = getCalleeDecl(CE); 2129b0c749a20d0f7d0e63441d76baa15def3f37fdbAnna Zaks return getCalleeName(FunDecl); 2139b0c749a20d0f7d0e63441d76baa15def3f37fdbAnna Zaks } 2149b0c749a20d0f7d0e63441d76baa15def3f37fdbAnna Zaks 2152f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// \brief Returns true if the callee is an externally-visible function in the 2162f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// top-level namespace, such as \c malloc. 2172f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// 2182f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// If a name is provided, the function must additionally match the given 2192f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// name. 2202f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// 2212f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// Note that this deliberately excludes C++ library functions in the \c std 2222f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// namespace, but will include C library functions accessed through the 2232f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// \c std namespace. This also does not check if the function is declared 2242f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// as 'extern "C"', or if it uses C++ name mangling. 2252f3017f9cbd3774f690c979410bfec38423d03afJordan Rose static bool isCLibraryFunction(const FunctionDecl *FD, 2262f3017f9cbd3774f690c979410bfec38423d03afJordan Rose StringRef Name = StringRef()); 2270e12ebfd3ef9ad5d894466c6e4910ac5e6041034Anna Zaks 228461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks /// \brief Depending on wither the location corresponds to a macro, return 229461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks /// either the macro name or the token spelling. 230461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks /// 231461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks /// This could be useful when checkers' logic depends on whether a function 232461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks /// is called with a given macro argument. For example: 233461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks /// s = socket(AF_INET,..) 234461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks /// If AF_INET is a macro, the result should be treated as a source of taint. 235461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks /// 236461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks /// \sa clang::Lexer::getSpelling(), clang::Lexer::getImmediateMacroName(). 237461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks StringRef getMacroNameOrSpelling(SourceLocation &Loc); 238461af1e502c9bd88330bbf17d449a7593fc0d624Anna Zaks 2396bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidisprivate: 2408bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *addTransitionImpl(ProgramStateRef State, 24139ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks bool MarkAsSink, 24239ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks ExplodedNode *P = 0, 24339ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const ProgramPointTag *Tag = 0) { 244c8bb3befcad8cd8fc9556bc265289b07dc3c94c8Anna Zaks if (!State || (State == Pred->getState() && !Tag && !MarkAsSink)) 245df95d146c13cf02e106b32b01d147577d6d6b5a1Anna Zaks return Pred; 246df95d146c13cf02e106b32b01d147577d6d6b5a1Anna Zaks 24757300760964904cc022a175643342f29f46b7e6bAnna Zaks Changed = true; 248fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose const ProgramPoint &LocalLoc = (Tag ? Location.withTag(Tag) : Location); 249fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose if (!P) 250fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose P = Pred; 251fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose 252fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose ExplodedNode *node; 253fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose if (MarkAsSink) 254fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose node = NB.generateSink(LocalLoc, State, P); 255fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose else 256fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose node = NB.generateNode(LocalLoc, State, P); 2576bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return node; 2586bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 2596bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis}; 2606bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 26157300760964904cc022a175643342f29f46b7e6bAnna Zaks/// \brief A helper class which wraps a boolean value set to false by default. 26257300760964904cc022a175643342f29f46b7e6bAnna Zaksstruct DefaultBool { 26357300760964904cc022a175643342f29f46b7e6bAnna Zaks bool Val; 26457300760964904cc022a175643342f29f46b7e6bAnna Zaks DefaultBool() : Val(false) {} 26557300760964904cc022a175643342f29f46b7e6bAnna Zaks operator bool() const { return Val; } 26657300760964904cc022a175643342f29f46b7e6bAnna Zaks DefaultBool &operator=(bool b) { Val = b; return *this; } 26757300760964904cc022a175643342f29f46b7e6bAnna Zaks}; 26857300760964904cc022a175643342f29f46b7e6bAnna Zaks 2696bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis} // end GR namespace 2706bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 2716bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis} // end clang namespace 2726bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 2736bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis#endif 274