23 using namespace clang;
29 enum Kind { Opened, Closed, OpenFailed, Escaped } K;
32 StreamState(
Kind k,
const Stmt *s) : K(k), S(s) {}
34 bool isOpened()
const {
return K == Opened; }
35 bool isClosed()
const {
return K == Closed; }
40 return K == X.K && S == X.S;
43 static StreamState getOpened(
const Stmt *s) {
return StreamState(Opened, s); }
44 static StreamState getClosed(
const Stmt *s) {
return StreamState(Closed, s); }
45 static StreamState getOpenFailed(
const Stmt *s) {
46 return StreamState(OpenFailed, s);
48 static StreamState getEscaped(
const Stmt *s) {
49 return StreamState(Escaped, s);
52 void Profile(llvm::FoldingSetNodeID &
ID)
const {
58 class StreamChecker :
public Checker<eval::Call,
59 check::DeadSymbols > {
60 mutable IdentifierInfo *II_fopen, *II_tmpfile, *II_fclose, *II_fread,
62 *II_fseek, *II_ftell, *II_rewind, *II_fgetpos, *II_fsetpos,
63 *II_clearerr, *II_feof, *II_ferror, *II_fileno;
64 mutable std::unique_ptr<BuiltinBug> BT_nullfp, BT_illegalwhence,
65 BT_doubleclose, BT_ResourceLeak;
69 : II_fopen(nullptr), II_tmpfile(nullptr), II_fclose(nullptr),
70 II_fread(nullptr), II_fwrite(nullptr), II_fseek(nullptr),
71 II_ftell(nullptr), II_rewind(nullptr), II_fgetpos(nullptr),
72 II_fsetpos(nullptr), II_clearerr(nullptr), II_feof(nullptr),
73 II_ferror(nullptr), II_fileno(nullptr) {}
75 bool evalCall(
const CallExpr *CE, CheckerContext &C)
const;
76 void checkDeadSymbols(SymbolReaper &SymReaper, CheckerContext &C)
const;
79 void Fopen(CheckerContext &C,
const CallExpr *CE)
const;
80 void Tmpfile(CheckerContext &C,
const CallExpr *CE)
const;
81 void Fclose(CheckerContext &C,
const CallExpr *CE)
const;
82 void Fread(CheckerContext &C,
const CallExpr *CE)
const;
83 void Fwrite(CheckerContext &C,
const CallExpr *CE)
const;
84 void Fseek(CheckerContext &C,
const CallExpr *CE)
const;
85 void Ftell(CheckerContext &C,
const CallExpr *CE)
const;
86 void Rewind(CheckerContext &C,
const CallExpr *CE)
const;
87 void Fgetpos(CheckerContext &C,
const CallExpr *CE)
const;
88 void Fsetpos(CheckerContext &C,
const CallExpr *CE)
const;
89 void Clearerr(CheckerContext &C,
const CallExpr *CE)
const;
90 void Feof(CheckerContext &C,
const CallExpr *CE)
const;
91 void Ferror(CheckerContext &C,
const CallExpr *CE)
const;
92 void Fileno(CheckerContext &C,
const CallExpr *CE)
const;
94 void OpenFileAux(CheckerContext &C,
const CallExpr *CE)
const;
97 CheckerContext &C)
const;
99 CheckerContext &C)
const;
107 bool StreamChecker::evalCall(
const CallExpr *CE, CheckerContext &C)
const {
134 II_clearerr = &Ctx.
Idents.
get(
"clearerr");
202 void StreamChecker::Fopen(CheckerContext &C,
const CallExpr *CE)
const {
206 void StreamChecker::Tmpfile(CheckerContext &C,
const CallExpr *CE)
const {
210 void StreamChecker::OpenFileAux(CheckerContext &C,
const CallExpr *CE)
const {
212 SValBuilder &svalBuilder = C.getSValBuilder();
213 const LocationContext *LCtx = C.getPredecessor()->getLocationContext();
214 DefinedSVal RetVal = svalBuilder.conjureSymbolVal(
nullptr, CE, LCtx,
216 .castAs<DefinedSVal>();
217 state = state->BindExpr(CE, C.getLocationContext(), RetVal);
219 ConstraintManager &CM = C.getConstraintManager();
223 std::tie(stateNotNull, stateNull) = CM.assumeDual(state, RetVal);
225 if (
SymbolRef Sym = RetVal.getAsSymbol()) {
228 stateNotNull->set<StreamMap>(Sym,StreamState::getOpened(CE));
230 stateNull->set<StreamMap>(Sym, StreamState::getOpenFailed(CE));
232 C.addTransition(stateNotNull);
233 C.addTransition(stateNull);
237 void StreamChecker::Fclose(CheckerContext &C,
const CallExpr *CE)
const {
240 C.addTransition(state);
243 void StreamChecker::Fread(CheckerContext &C,
const CallExpr *CE)
const {
245 if (!CheckNullStream(C.getSVal(CE->
getArg(3)), state, C))
249 void StreamChecker::Fwrite(CheckerContext &C,
const CallExpr *CE)
const {
251 if (!CheckNullStream(C.getSVal(CE->
getArg(3)), state, C))
255 void StreamChecker::Fseek(CheckerContext &C,
const CallExpr *CE)
const {
257 if (!(state = CheckNullStream(C.getSVal(CE->
getArg(0)), state, C)))
260 SVal Whence = state->getSVal(CE->
getArg(2), C.getLocationContext());
266 int64_t x = CI->getValue().getSExtValue();
267 if (x >= 0 && x <= 2)
270 if (ExplodedNode *N = C.generateNonFatalErrorNode(state)) {
271 if (!BT_illegalwhence)
272 BT_illegalwhence.reset(
273 new BuiltinBug(
this,
"Illegal whence argument",
274 "The whence argument to fseek() should be " 275 "SEEK_SET, SEEK_END, or SEEK_CUR."));
276 C.emitReport(llvm::make_unique<BugReport>(
277 *BT_illegalwhence, BT_illegalwhence->getDescription(), N));
281 void StreamChecker::Ftell(CheckerContext &C,
const CallExpr *CE)
const {
283 if (!CheckNullStream(C.getSVal(CE->
getArg(0)), state, C))
287 void StreamChecker::Rewind(CheckerContext &C,
const CallExpr *CE)
const {
289 if (!CheckNullStream(C.getSVal(CE->
getArg(0)), state, C))
293 void StreamChecker::Fgetpos(CheckerContext &C,
const CallExpr *CE)
const {
295 if (!CheckNullStream(C.getSVal(CE->
getArg(0)), state, C))
299 void StreamChecker::Fsetpos(CheckerContext &C,
const CallExpr *CE)
const {
301 if (!CheckNullStream(C.getSVal(CE->
getArg(0)), state, C))
305 void StreamChecker::Clearerr(CheckerContext &C,
const CallExpr *CE)
const {
307 if (!CheckNullStream(C.getSVal(CE->
getArg(0)), state, C))
311 void StreamChecker::Feof(CheckerContext &C,
const CallExpr *CE)
const {
313 if (!CheckNullStream(C.getSVal(CE->
getArg(0)), state, C))
317 void StreamChecker::Ferror(CheckerContext &C,
const CallExpr *CE)
const {
319 if (!CheckNullStream(C.getSVal(CE->
getArg(0)), state, C))
323 void StreamChecker::Fileno(CheckerContext &C,
const CallExpr *CE)
const {
325 if (!CheckNullStream(C.getSVal(CE->
getArg(0)), state, C))
330 CheckerContext &C)
const {
335 ConstraintManager &CM = C.getConstraintManager();
337 std::tie(stateNotNull, stateNull) = CM.assumeDual(state, *DV);
339 if (!stateNotNull && stateNull) {
340 if (ExplodedNode *N = C.generateErrorNode(stateNull)) {
342 BT_nullfp.reset(
new BuiltinBug(
this,
"NULL stream pointer",
343 "Stream pointer might be NULL."));
344 C.emitReport(llvm::make_unique<BugReport>(
345 *BT_nullfp, BT_nullfp->getDescription(), N));
354 CheckerContext &C)
const {
359 const StreamState *SS = state->get<StreamMap>(Sym);
367 if (SS->isClosed()) {
368 ExplodedNode *N = C.generateErrorNode();
371 BT_doubleclose.reset(
new BuiltinBug(
372 this,
"Double fclose",
"Try to close a file Descriptor already" 373 " closed. Cause undefined behaviour."));
374 C.emitReport(llvm::make_unique<BugReport>(
375 *BT_doubleclose, BT_doubleclose->getDescription(), N));
381 return state->set<StreamMap>(Sym, StreamState::getClosed(CE));
384 void StreamChecker::checkDeadSymbols(SymbolReaper &SymReaper,
385 CheckerContext &C)
const {
389 const StreamMapTy &Map = state->get<StreamMap>();
390 for (
const auto &I: Map) {
392 const StreamState &SS = I.second;
393 if (!SymReaper.isDead(Sym) || !SS.isOpened())
396 ExplodedNode *N = C.generateErrorNode();
400 if (!BT_ResourceLeak)
401 BT_ResourceLeak.reset(
402 new BuiltinBug(
this,
"Resource Leak",
403 "Opened File never closed. Potential Resource leak."));
404 C.emitReport(llvm::make_unique<BugReport>(
405 *BT_ResourceLeak, BT_ResourceLeak->getDescription(), N));
409 void ento::registerStreamChecker(CheckerManager &mgr) {
410 mgr.registerChecker<StreamChecker>();
Represents a function declaration or definition.
Expr * getArg(unsigned Arg)
getArg - Return the specified argument.
bool operator==(CanQual< T > x, CanQual< U > y)
const SymExpr * SymbolRef
Stmt - This represents one statement.
IntrusiveRefCntPtr< const ProgramState > ProgramStateRef
constexpr XRayInstrMask Function
IdentifierInfo * getIdentifier() const
Get the identifier that names this declaration, if there is one.
One of these records is kept for each identifier that is lexed.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
i32 captured_struct **param SharedsTy A type which contains references the shared variables *param Shareds Context with the list of shared variables from the p *TaskFunction *param Data Additional data for task generation like final * state
IdentifierInfo & get(StringRef Name)
Return the identifier token info for the specified named identifier.
#define REGISTER_MAP_WITH_PROGRAMSTATE(Name, Key, Value)
Declares an immutable map of type NameTy, suitable for placement into the ProgramState.
Dataflow Directional Tag Classes.
X
Add a minimal nested name specifier fixit hint to allow lookup of a tag name from an outer enclosing ...
CallExpr - Represents a function call (C99 6.5.2.2, C++ [expr.call]).