From 94ca494ba0ee5d3ae35c7addace9687553c1c80d Mon Sep 17 00:00:00 2001 From: Sergey Morozov Date: Wed, 21 Feb 2024 19:44:45 +0300 Subject: [PATCH] [feat] Added warning reports in SARIF. --- lib/Core/CodeEvents/ErrorEvent.h | 15 ++- lib/Core/ExecutionState.cpp | 2 +- lib/Core/ExecutionState.h | 2 +- lib/Core/Executor.cpp | 161 +++++++++++++++------------- lib/Core/Executor.h | 8 +- lib/Core/SpecialFunctionHandler.cpp | 39 +++---- 6 files changed, 123 insertions(+), 104 deletions(-) diff --git a/lib/Core/CodeEvents/ErrorEvent.h b/lib/Core/CodeEvents/ErrorEvent.h index eecc8935e20..bd7d93696e7 100644 --- a/lib/Core/CodeEvents/ErrorEvent.h +++ b/lib/Core/CodeEvents/ErrorEvent.h @@ -14,6 +14,8 @@ struct ErrorEvent : public CodeEvent { /// @brief ID for this error. const StateTerminationType ruleID; + const StateTerminationConfidenceCategory confidence; + /// @brief Message describing this error. const std::string message; @@ -23,14 +25,17 @@ struct ErrorEvent : public CodeEvent { const std::optional> source; ErrorEvent(const ref &source, const ref &sink, - StateTerminationType ruleID, const std::string &message) - : CodeEvent(EventKind::ERR, sink), ruleID(ruleID), message(message), - source(source) {} + StateTerminationType ruleID, + StateTerminationConfidenceCategory confidence, + const std::string &message) + : CodeEvent(EventKind::ERR, sink), ruleID(ruleID), confidence(confidence), + message(message), source(source) {} ErrorEvent(const ref &sink, StateTerminationType ruleID, + StateTerminationConfidenceCategory confidence, const std::string &message) - : CodeEvent(EventKind::ERR, sink), ruleID(ruleID), message(message), - source(std::nullopt) {} + : CodeEvent(EventKind::ERR, sink), ruleID(ruleID), confidence(confidence), + message(message), source(std::nullopt) {} std::string description() const override { return message; } diff --git a/lib/Core/ExecutionState.cpp b/lib/Core/ExecutionState.cpp index da945f7ccc3..64f6acdbd7b 100644 --- a/lib/Core/ExecutionState.cpp +++ b/lib/Core/ExecutionState.cpp @@ -165,7 +165,7 @@ ExecutionState::ExecutionState(const ExecutionState &state) stack(state.stack), stackBalance(state.stackBalance), incomingBBIndex(state.incomingBBIndex), lastBrConfidently(state.lastBrConfidently), - outOfMemoryMarkers(state.outOfMemoryMarkers), depth(state.depth), + nullPointerMarkers(state.nullPointerMarkers), depth(state.depth), level(state.level), addressSpace(state.addressSpace), constraints(state.constraints), eventsRecorder(state.eventsRecorder), targetForest(state.targetForest), pathOS(state.pathOS), diff --git a/lib/Core/ExecutionState.h b/lib/Core/ExecutionState.h index c593e2c05e3..76107ca2f2a 100644 --- a/lib/Core/ExecutionState.h +++ b/lib/Core/ExecutionState.h @@ -321,7 +321,7 @@ class ExecutionState { bool lastBrConfidently = true; /// @brief: TODO: - ImmutableList> outOfMemoryMarkers; + ImmutableList> nullPointerMarkers; /// @brief Exploration depth, i.e., number of times KLEE branched for this /// state diff --git a/lib/Core/Executor.cpp b/lib/Core/Executor.cpp index 6b3d2e6fc1d..1bf0b3def56 100644 --- a/lib/Core/Executor.cpp +++ b/lib/Core/Executor.cpp @@ -521,9 +521,9 @@ Executor::Executor(LLVMContext &ctx, const InterpreterOptions &opts, InterpreterHandler *ih) : Interpreter(opts), interpreterHandler(ih), searcher(nullptr), externalDispatcher(new ExternalDispatcher(ctx)), statsTracker(0), - pathWriter(0), symPathWriter(0), specialFunctionHandler(0), - timers{time::Span(TimerInterval)}, guidanceKind(opts.Guidance), - codeGraphInfo(new CodeGraphInfo()), + pathWriter(0), symPathWriter(0), + specialFunctionHandler(0), timers{time::Span(TimerInterval)}, + guidanceKind(opts.Guidance), codeGraphInfo(new CodeGraphInfo()), distanceCalculator(new DistanceCalculator(*codeGraphInfo)), targetCalculator(new TargetCalculator(*codeGraphInfo)), targetManager(new TargetManager(guidanceKind, *distanceCalculator, @@ -2753,8 +2753,12 @@ void Executor::executeInstruction(ExecutionState &state, KInstruction *ki) { branches.first->lastBrConfidently = false; branches.second->lastBrConfidently = false; } else { - (branches.first ? branches.first : branches.second)->lastBrConfidently = - true; + if (branches.first) { + branches.first->lastBrConfidently = true; + } + if (branches.second) { + branches.second->lastBrConfidently = true; + } } // NOTE: There is a hidden dependency here, markBranchVisited @@ -4026,11 +4030,10 @@ void Executor::executeInstruction(ExecutionState &state, KInstruction *ki) { if (iIdx >= vt->getNumElements()) { // Out of bounds write terminateStateOnProgramError( - state, - new ErrorEvent(locationOf(state), - StateTerminationType::BadVectorAccess, - "Out of bounds write when inserting element"), - StateTerminationConfidenceCategory::CONFIDENT); + state, new ErrorEvent(locationOf(state), + StateTerminationType::BadVectorAccess, + StateTerminationConfidenceCategory::CONFIDENT, + "Out of bounds write when inserting element")); return; } @@ -4071,11 +4074,10 @@ void Executor::executeInstruction(ExecutionState &state, KInstruction *ki) { if (iIdx >= vt->getNumElements()) { // Out of bounds read terminateStateOnProgramError( - state, - new ErrorEvent(locationOf(state), - StateTerminationType::BadVectorAccess, - "Out of bounds read when extracting element"), - StateTerminationConfidenceCategory::CONFIDENT); + state, new ErrorEvent(locationOf(state), + StateTerminationType::BadVectorAccess, + StateTerminationConfidenceCategory::CONFIDENT, + "Out of bounds read when extracting element")); return; } @@ -4979,8 +4981,9 @@ void Executor::terminateStateOnTargetError(ExecutionState &state, terminationType = StateTerminationType::User; } terminateStateOnProgramError( - state, new ErrorEvent(locationOf(state), terminationType, messaget), - StateTerminationConfidenceCategory::CONFIDENT); + state, + new ErrorEvent(locationOf(state), terminationType, + StateTerminationConfidenceCategory::CONFIDENT, messaget)); } void Executor::terminateStateOnError( @@ -5063,10 +5066,10 @@ void Executor::terminateStateOnExecError(ExecutionState &state, StateTerminationConfidenceCategory::CONFIDENT, ""); } -void Executor::terminateStateOnProgramError( - ExecutionState &state, const ref &reason, - StateTerminationConfidenceCategory confidence, const llvm::Twine &info, - const char *suffix) { +void Executor::terminateStateOnProgramError(ExecutionState &state, + const ref &reason, + const llvm::Twine &info, + const char *suffix) { assert(reason->ruleID > StateTerminationType::SOLVERERR && reason->ruleID <= StateTerminationType::PROGERR); ++stats::terminationProgramError; @@ -5085,8 +5088,8 @@ void Executor::terminateStateOnProgramError( } state.eventsRecorder.record(reason); - terminateStateOnError(state, reason->message, reason->ruleID, confidence, - info, suffix); + terminateStateOnError(state, reason->message, reason->ruleID, + reason->confidence, info, suffix); } void Executor::terminateStateOnSolverError(ExecutionState &state, @@ -5300,6 +5303,7 @@ void Executor::callExternalFunction(ExecutionState &state, KInstruction *target, e->getWidth() == Context::get().getPointerWidth()) { ref symExternCallsCanReturnNullExpr = makeMockValue(state, "symExternCallsCanReturnNull", Expr::Bool); + state.nullPointerMarkers.push_back(symExternCallsCanReturnNullExpr); e = SelectExpr::create( symExternCallsCanReturnNullExpr, ConstantExpr::alloc(0, Context::get().getPointerWidth()), e); @@ -5425,7 +5429,7 @@ void Executor::executeAlloc(ExecutionState &state, ref size, bool isLocal, makeMockValue(state, "symCheckOutOfMemory", Expr::Bool); address = SelectExpr::create(symCheckOutOfMemoryExpr, Expr::createPointer(0), address); - state.outOfMemoryMarkers.push_back(symCheckOutOfMemoryExpr); + state.nullPointerMarkers.push_back(symCheckOutOfMemoryExpr); } // state.addPointerResolution(address, mo); @@ -5471,9 +5475,10 @@ void Executor::executeFree(ExecutionState &state, ref address, *it->second, new ErrorEvent(new AllocEvent(mo->allocSite), locationOf(*it->second), StateTerminationType::Free, + rl.size() != 1 + ? StateTerminationConfidenceCategory::PROBABLY + : StateTerminationConfidenceCategory::CONFIDENT, "free of alloca"), - rl.size() != 1 ? StateTerminationConfidenceCategory::PROBABLY - : StateTerminationConfidenceCategory::CONFIDENT, getAddressInfo(*it->second, address)); } else if (mo->isGlobal) { if (rl.size() != 1) { @@ -5483,9 +5488,10 @@ void Executor::executeFree(ExecutionState &state, ref address, *it->second, new ErrorEvent(new AllocEvent(mo->allocSite), locationOf(*it->second), StateTerminationType::Free, + rl.size() != 1 + ? StateTerminationConfidenceCategory::PROBABLY + : StateTerminationConfidenceCategory::CONFIDENT, "free of global"), - rl.size() != 1 ? StateTerminationConfidenceCategory::PROBABLY - : StateTerminationConfidenceCategory::CONFIDENT, getAddressInfo(*it->second, address)); } else { it->second->removePointerResolutions(mo); @@ -5508,12 +5514,12 @@ ExecutionState *Executor::handleNullPointerException(ExecutionState &state, // If there are no markers on `malloc` returning nullptr, // then `confidence` depends on presence of `unbound` state. - if (!bound->outOfMemoryMarkers.empty()) { + if (!bound->nullPointerMarkers.empty()) { // bound constraints already contain `Expr::createIsZero()` std::vector markersArrays; - markersArrays.reserve(bound->outOfMemoryMarkers.size()); - findSymbolicObjects(bound->outOfMemoryMarkers.begin(), - bound->outOfMemoryMarkers.end(), markersArrays); + markersArrays.reserve(bound->nullPointerMarkers.size()); + findSymbolicObjects(bound->nullPointerMarkers.begin(), + bound->nullPointerMarkers.end(), markersArrays); // Do some iterations (2-3) to figure out if error is confident. ref allExcludedVectorsOfMarkers = Expr::createTrue(); @@ -5534,8 +5540,8 @@ ExecutionState *Executor::handleNullPointerException(ExecutionState &state, terminateStateOnProgramError( *bound, new ErrorEvent(locationOf(*bound), StateTerminationType::Ptr, - "memory error: null pointer exception"), - StateTerminationConfidenceCategory::CONFIDENT); + StateTerminationConfidenceCategory::CONFIDENT, + "memory error: null pointer exception")); convinced = true; break; } @@ -5550,7 +5556,7 @@ ExecutionState *Executor::handleNullPointerException(ExecutionState &state, // Exclude this combinations of markers ref conjExcludedVectorOfMarkers = Expr::createTrue(); - for (ref marker : bound->outOfMemoryMarkers) { + for (ref marker : bound->nullPointerMarkers) { conjExcludedVectorOfMarkers = AndExpr::create( conjExcludedVectorOfMarkers, EqExpr::create(marker, @@ -5567,10 +5573,9 @@ ExecutionState *Executor::handleNullPointerException(ExecutionState &state, ReachWithError::MayBeNullPointerException); terminateStateOnProgramError( - *bound, - new ErrorEvent(locationOf(*bound), StateTerminationType::Ptr, - "memory error: null pointer exception"), - StateTerminationConfidenceCategory::PROBABLY); + *bound, new ErrorEvent(locationOf(*bound), StateTerminationType::Ptr, + StateTerminationConfidenceCategory::PROBABLY, + "memory error: null pointer exception")); } } else { @@ -5582,10 +5587,10 @@ ExecutionState *Executor::handleNullPointerException(ExecutionState &state, terminateStateOnProgramError( *bound, new ErrorEvent(locationOf(*bound), StateTerminationType::Ptr, - "memory error: null pointer exception"), - branches.second != nullptr - ? StateTerminationConfidenceCategory::PROBABLY - : StateTerminationConfidenceCategory::CONFIDENT); + branches.second != nullptr + ? StateTerminationConfidenceCategory::PROBABLY + : StateTerminationConfidenceCategory::CONFIDENT, + "memory error: null pointer exception")); } return branches.second; @@ -5666,9 +5671,10 @@ bool Executor::resolveExact(ExecutionState &estate, ref address, terminateStateOnProgramError( *unbound, new ErrorEvent(locationOf(*unbound), StateTerminationType::Ptr, + !results.empty() + ? StateTerminationConfidenceCategory::PROBABLY + : StateTerminationConfidenceCategory::CONFIDENT, "memory error: invalid pointer: " + name), - !results.empty() ? StateTerminationConfidenceCategory::PROBABLY - : StateTerminationConfidenceCategory::CONFIDENT, getAddressInfo(*unbound, address)); } } @@ -5757,8 +5763,9 @@ void Executor::concretizeSize(ExecutionState &state, ref size, *hugeSize.second, new ErrorEvent(locationOf(*hugeSize.second), StateTerminationType::Model, + StateTerminationConfidenceCategory::CONFIDENT, "concretized symbolic size"), - StateTerminationConfidenceCategory::CONFIDENT, info.str()); + info.str()); } } } @@ -6475,8 +6482,8 @@ void Executor::executeMemoryOperation( *state, new ErrorEvent(new AllocEvent(mo->allocSite), locationOf(*state), StateTerminationType::ReadOnly, - "memory error: object read only"), - StateTerminationConfidenceCategory::CONFIDENT); + StateTerminationConfidenceCategory::CONFIDENT, + "memory error: object read only")); } else { wos->write(mo->getOffsetExpr(address), value); } @@ -6606,13 +6613,13 @@ void Executor::executeMemoryOperation( assert(branches.first); terminateStateOnProgramError( *branches.first, - new ErrorEvent(new AllocEvent(mo->allocSite), - locationOf(*branches.first), - StateTerminationType::ReadOnly, - "memory error: object read only"), - mayBeFalsePositive - ? StateTerminationConfidenceCategory::PROBABLY - : StateTerminationConfidenceCategory::CONFIDENT); + new ErrorEvent( + new AllocEvent(mo->allocSite), locationOf(*branches.first), + StateTerminationType::ReadOnly, + mayBeFalsePositive + ? StateTerminationConfidenceCategory::PROBABLY + : StateTerminationConfidenceCategory::CONFIDENT, + "memory error: object read only")); state = branches.second; } else { ref result = SelectExpr::create( @@ -6681,13 +6688,13 @@ void Executor::executeMemoryOperation( ConstantExpr::alloc(size, Context::get().getPointerWidth()), true); if (wos->readOnly) { terminateStateOnProgramError( - *bound, - new ErrorEvent(new AllocEvent(mo->allocSite), locationOf(*bound), - StateTerminationType::ReadOnly, - "memory error: object read only"), - mayBeFalsePositive - ? StateTerminationConfidenceCategory::PROBABLY - : StateTerminationConfidenceCategory::CONFIDENT); + *bound, new ErrorEvent( + new AllocEvent(mo->allocSite), locationOf(*bound), + StateTerminationType::ReadOnly, + mayBeFalsePositive + ? StateTerminationConfidenceCategory::PROBABLY + : StateTerminationConfidenceCategory::CONFIDENT, + "memory error: object read only")); } else { wos->write(mo->getOffsetExpr(address), value); } @@ -6748,9 +6755,10 @@ void Executor::executeMemoryOperation( *unbound, new ErrorEvent(new AllocEvent(baseObjectPair.first->allocSite), locationOf(*unbound), StateTerminationType::Ptr, - "memory error: out of bound pointer"), - mayBeFalsePositive ? StateTerminationConfidenceCategory::PROBABLY + mayBeFalsePositive + ? StateTerminationConfidenceCategory::PROBABLY : StateTerminationConfidenceCategory::CONFIDENT, + "memory error: out of bound pointer"), getAddressInfo(*unbound, address)); return; } @@ -6759,9 +6767,10 @@ void Executor::executeMemoryOperation( terminateStateOnProgramError( *unbound, new ErrorEvent(locationOf(*unbound), StateTerminationType::Ptr, - "memory error: out of bound pointer"), - mayBeFalsePositive ? StateTerminationConfidenceCategory::PROBABLY + mayBeFalsePositive + ? StateTerminationConfidenceCategory::PROBABLY : StateTerminationConfidenceCategory::CONFIDENT, + "memory error: out of bound pointer"), getAddressInfo(*unbound, address)); } } @@ -7413,21 +7422,25 @@ void Executor::getConstraintLog(const ExecutionState &state, std::string &res, } void Executor::addSARIFReport(const ExecutionState &state) { - ResultJson result{}; - - CodeFlowJson codeFlow = state.eventsRecorder.serialize(); - if (ref lastEvent = llvm::dyn_cast(state.eventsRecorder.last())) { + + ResultJson result{}; + + CodeFlowJson codeFlow = state.eventsRecorder.serialize(); + result.locations.push_back(lastEvent->serialize()); result.message = {Message{lastEvent->message}}; result.ruleId = {terminationTypeName(lastEvent->ruleID)}; - result.level = {"error"}; - } + result.level = {lastEvent->confidence == + StateTerminationConfidenceCategory::CONFIDENT + ? "error" + : "warning"}; - result.codeFlows.push_back(std::move(codeFlow)); + result.codeFlows.push_back(std::move(codeFlow)); - sarifReport.runs.back().results.push_back(std::move(result)); + sarifReport.runs.back().results.push_back(std::move(result)); + } } SarifReportJson Executor::getSARIFReport() const { return sarifReport; } diff --git a/lib/Core/Executor.h b/lib/Core/Executor.h index cae6c941e70..1b0ead16dca 100644 --- a/lib/Core/Executor.h +++ b/lib/Core/Executor.h @@ -633,10 +633,10 @@ class Executor : public Interpreter { /// Call error handler and terminate state in case of program errors /// (e.g. free()ing globals, out-of-bound accesses) - void terminateStateOnProgramError( - ExecutionState &state, const ref &reason, - StateTerminationConfidenceCategory confidence, - const llvm::Twine &longMessage = "", const char *suffix = nullptr); + void terminateStateOnProgramError(ExecutionState &state, + const ref &reason, + const llvm::Twine &longMessage = "", + const char *suffix = nullptr); void terminateStateOnTerminator(ExecutionState &state); diff --git a/lib/Core/SpecialFunctionHandler.cpp b/lib/Core/SpecialFunctionHandler.cpp index ec901904ef3..8431da83d30 100644 --- a/lib/Core/SpecialFunctionHandler.cpp +++ b/lib/Core/SpecialFunctionHandler.cpp @@ -32,8 +32,8 @@ #include "klee/klee.h" #include "klee/Support/CompilerWarning.h" -#include -#include +#include +#include DISABLE_WARNING_PUSH DISABLE_WARNING_DEPRECATED_DECLARATIONS #include "llvm/ADT/APFloat.h" @@ -348,8 +348,8 @@ void SpecialFunctionHandler::handleAbort(ExecutionState &state, executor.terminateStateOnProgramError( state, new ErrorEvent(executor.locationOf(state), StateTerminationType::Abort, - "abort failure"), - StateTerminationConfidenceCategory::CONFIDENT); + StateTerminationConfidenceCategory::CONFIDENT, + "abort failure")); } void SpecialFunctionHandler::handleExit(ExecutionState &state, @@ -378,11 +378,11 @@ void SpecialFunctionHandler::handleAssert(ExecutionState &state, executor.terminateStateOnProgramError( state, new ErrorEvent(executor.locationOf(state), StateTerminationType::Assert, + isAssertFailsConfidently(state) + ? StateTerminationConfidenceCategory::CONFIDENT + : StateTerminationConfidenceCategory::PROBABLY, "ASSERTION FAIL: " + - readStringAtAddress(state, arguments[0])), - isAssertFailsConfidently(state) - ? StateTerminationConfidenceCategory::CONFIDENT - : StateTerminationConfidenceCategory::PROBABLY); + readStringAtAddress(state, arguments[0]))); } void SpecialFunctionHandler::handleAssertFail( @@ -393,11 +393,11 @@ void SpecialFunctionHandler::handleAssertFail( executor.terminateStateOnProgramError( state, new ErrorEvent(executor.locationOf(state), StateTerminationType::Assert, + isAssertFailsConfidently(state) + ? StateTerminationConfidenceCategory::CONFIDENT + : StateTerminationConfidenceCategory::PROBABLY, "ASSERTION FAIL: " + - readStringAtAddress(state, arguments[0])), - isAssertFailsConfidently(state) - ? StateTerminationConfidenceCategory::CONFIDENT - : StateTerminationConfidenceCategory::PROBABLY); + readStringAtAddress(state, arguments[0]))); } void SpecialFunctionHandler::handleReportError( @@ -411,9 +411,9 @@ void SpecialFunctionHandler::handleReportError( state, new ErrorEvent(executor.locationOf(state), StateTerminationType::ReportError, + StateTerminationConfidenceCategory::CONFIDENT, readStringAtAddress(state, arguments[2])), - StateTerminationConfidenceCategory::CONFIDENT, "", - readStringAtAddress(state, arguments[3]).c_str()); + "", readStringAtAddress(state, arguments[3]).c_str()); } void SpecialFunctionHandler::handleNew(ExecutionState &state, @@ -856,8 +856,8 @@ void SpecialFunctionHandler::handleCheckMemoryAccess( executor.terminateStateOnProgramError( state, new ErrorEvent(executor.locationOf(state), StateTerminationType::Ptr, + StateTerminationConfidenceCategory::CONFIDENT, "check_memory_access: memory error"), - StateTerminationConfidenceCategory::CONFIDENT, executor.getAddressInfo(state, address)); } else { const MemoryObject *mo = state.addressSpace.findObject(idObject).first; @@ -866,10 +866,11 @@ void SpecialFunctionHandler::handleCheckMemoryAccess( if (!chk->isTrue()) { executor.terminateStateOnProgramError( state, - new ErrorEvent( - new AllocEvent(mo->allocSite), executor.locationOf(state), - StateTerminationType::Ptr, "check_memory_access: memory error"), - StateTerminationConfidenceCategory::CONFIDENT, + new ErrorEvent(new AllocEvent(mo->allocSite), + executor.locationOf(state), + StateTerminationType::Ptr, + StateTerminationConfidenceCategory::CONFIDENT, + "check_memory_access: memory error"), executor.getAddressInfo(state, address)); } }