fix tests and format

Author: ladisgin

CMakeLists.txt

@@ -305,7 +305,7 @@ endif()
 ################################################################################
 # Detect SQLite3
 ################################################################################
-find_package(SQLite3 REQUIRED)
+find_package(SQLite3)
 if (NOT SQLite3_FOUND)
   message( FATAL_ERROR "SQLite3 not found, please install" )
 endif()
@@ -665,6 +665,8 @@ option(ENABLE_XML_ANNOTATION "Enable XML annotation" ON)
 
 if (ENABLE_XML_ANNOTATION)
   message(STATUS "XML annotation is enabled")
+  file(COPY "${CMAKE_SOURCE_DIR}/submodules/pugiconfig.hpp"
+          DESTINATION "${CMAKE_SOURCE_DIR}/submodules/pugixml/src")
   include_directories("${CMAKE_SOURCE_DIR}/submodules/pugixml/src")
 else()
   message(STATUS "XML annotation is disabled")

include/klee/Module/Annotation.h

@@ -66,17 +66,17 @@ bool operator==(const Ptr &first, const Ptr &second);
 
 // Annotation format: https://github.com/UnitTestBot/klee/discussions/92
 struct Annotation {
-
-  bool operator==(const Annotation &other) const;
-
   std::string functionName;
   std::vector<Statement::Ptr> returnStatements;
   std::vector<std::vector<Statement::Ptr>> argsStatements;
   std::set<Statement::Property> properties;
+
+  bool operator==(const Annotation &other) const;
 };
 
 using AnnotationsMap = std::map<std::string, Annotation>;
 
+AnnotationsMap parseAnnotationsJson(const json &annotationsJson);
 AnnotationsMap parseAnnotations(const std::string &path, const llvm::Module *m);
 } // namespace klee
 

lib/Core/CMakeLists.txt

@@ -45,10 +45,8 @@ target_link_libraries(kleeCore PRIVATE
   kleeSupport
 )
 
-find_package(SQLite3 REQUIRED)
-
 llvm_config(kleeCore "${USE_LLVM_SHARED}" core executionengine mcjit native support)
-target_link_libraries(kleeCore PRIVATE sqlite3)
+target_link_libraries(kleeCore PRIVATE ${SQLite3_LIBRARIES})
 target_include_directories(kleeCore PRIVATE ${KLEE_INCLUDE_DIRS} ${LLVM_INCLUDE_DIRS} ${SQLite3_INCLUDE_DIRS})
 target_compile_options(kleeCore PRIVATE ${KLEE_COMPONENT_CXX_FLAGS})
 target_compile_definitions(kleeCore PRIVATE ${KLEE_COMPONENT_CXX_DEFINES})

lib/Core/ExecutionState.cpp

@@ -26,7 +26,6 @@ DISABLE_WARNING_DEPRECATED_DECLARATIONS
 #include "llvm/IR/Function.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/raw_ostream.h"
-#include "klee/Support/ErrorHandling.h"
 DISABLE_WARNING_POP
 
 #include <cassert>

lib/Core/Executor.cpp

@@ -581,9 +581,10 @@ Executor::setModule(std::vector<std::unique_ptr<llvm::Module>> &userModules,
     // TODO: move this to function
     std::map<std::string, llvm::Type *> externals =
         getAllExternals(ignoredExternals);
-    MockBuilder builder(kmodule->module.get(), opts.MainCurrentName,
-                        opts.MainNameAfterMock, externals, opts.AnnotationsFile);
-    std::unique_ptr<llvm::Module> mockModule = builder.build();
+    MockBuilder mockBuilder(kmodule->module.get(), opts.MainCurrentName,
+                            opts.MainNameAfterMock, externals,
+                            opts.AnnotationsFile);
+    std::unique_ptr<llvm::Module> mockModule = mockBuilder.build();
     if (!mockModule) {
       klee_error("Unable to generate mocks");
     }
@@ -597,7 +598,7 @@ Executor::setModule(std::vector<std::unique_ptr<llvm::Module>> &userModules,
 
     std::vector<std::unique_ptr<llvm::Module>> mockModules;
     mockModules.push_back(std::move(mockModule));
-    kmodule->link(mockModules, 0);
+    kmodule->link(mockModules, 1);
 
     for (auto &global : kmodule->module->globals()) {
       if (global.isDeclaration()) {

lib/Core/MockBuilder.cpp

@@ -1,10 +1,12 @@
 #include "klee/Core/MockBuilder.h"
 
+#include "klee/Config/Version.h"
 #include "klee/Module/Annotation.h"
 #include "klee/Support/ErrorHandling.h"
+
 #include "llvm/IR/IRBuilder.h"
 #include "llvm/IR/Module.h"
-#include <llvm/Support/raw_ostream.h>
+#include "llvm/Support/raw_ostream.h"
 
 #include <memory>
 #include <utility>
@@ -98,8 +100,19 @@ void MockBuilder::buildExternalGlobalsDefinitions() {
   }
 }
 
-// TODO: discuss should we annotate not external function
 void MockBuilder::buildExternalFunctionsDefinitions() {
+  bool mockAllAnnotation = true;
+
+  if (mockAllAnnotation) {
+    for (const auto &i : annotations) {
+      llvm::Function *func = userModule->getFunction(i.first);
+      auto ext = externals.find(i.first);
+      if (ext == externals.end()) {
+        externals[i.first] = func->getType();
+      }
+    }
+  }
+
   for (const auto &it : externals) {
     if (!it.second->isFunctionTy()) {
       continue;
@@ -133,7 +146,9 @@ void MockBuilder::buildExternalFunctionsDefinitions() {
                                                annotation.returnStatements);
       buildAnnotationForExternalFunctionProperties(func, annotation.properties);
     } else {
-      buildAnnotationForExternalFunctionReturn(func, {});
+      // Default annotation for externals return
+      buildAnnotationForExternalFunctionReturn(
+          func, {std::make_shared<Statement::InitNull>()});
     }
   }
 }
@@ -172,7 +187,8 @@ MockBuilder::goByOffset(llvm::Value *value,
       if (!current->getType()->isPointerTy()) {
         klee_error("Incorrect annotation offset.");
       }
-      current = builder->CreateLoad(current);
+      current = builder->CreateLoad(current->getType()->getPointerElementType(),
+                                    current);
     } else if (inst == "&") {
       auto addr = builder->CreateAlloca(current->getType());
       current = builder->CreateStore(current, addr);
@@ -236,7 +252,15 @@ bool tryAlign(llvm::Function *func,
   }
 
   for (size_t i = 0, j = 0; j < func->arg_size() && i < statements.size();) {
-    while (isCorrectStatements(statements[i], func->getArg(j))) {
+    while (true) {
+#if LLVM_VERSION_CODE >= LLVM_VERSION(10, 0)
+      auto arg = func->getArg(j);
+#else
+      auto arg = &func->arg_begin()[j];
+#endif
+      if (isCorrectStatements(statements[i], arg)) {
+        break;
+      }
       res.emplace_back();
       j++;
       if (j >= func->arg_size()) {
@@ -264,7 +288,11 @@ void MockBuilder::buildAnnotationForExternalFunctionArgs(
     return;
   }
   for (size_t i = 0; i < statements.size(); i++) {
+#if LLVM_VERSION_CODE >= LLVM_VERSION(10, 0)
     const auto arg = func->getArg(i);
+#else
+    const auto arg = &func->arg_begin()[i];
+#endif
     for (const auto &statement : statements[i]) {
       llvm::Value *elem = goByOffset(arg, statement->offset);
       switch (statement->getKind()) {
@@ -288,7 +316,7 @@ void MockBuilder::buildAnnotationForExternalFunctionArgs(
             mockModule->getContext(), derefCondName, newFunc);
         llvm::BasicBlock *contBB = llvm::BasicBlock::Create(
             mockModule->getContext(), "continue_" + derefCondName);
-        auto brValue = builder->CreateLoad(derefCond);
+        auto brValue = builder->CreateLoad(intType, derefCond);
         builder->CreateCondBr(brValue, derefBB, contBB);
 
         builder->SetInsertPoint(derefBB);
@@ -320,7 +348,8 @@ void MockBuilder::buildAnnotationForExternalFunctionReturn(
   auto *loadInst =
       builder->CreateLoad(func->getReturnType(), mockReturnValue, retName);
 
-  bool initNull = false;
+  // For non pointer type do nothing, same as InitNull
+  bool initNull = !returnType->isPointerTy();
 
   for (const auto &statement : statements) {
     switch (statement->getKind()) {
@@ -329,9 +358,6 @@ void MockBuilder::buildAnnotationForExternalFunctionReturn(
                    func->getName().str().c_str());
       break;
     case Statement::Kind::InitNull: {
-      if (!returnType->isPointerTy()) {
-        klee_error("incorrect type for InitNull");
-      }
       initNull = true;
       break;
     }

lib/Core/SpecialFunctionHandler.cpp

@@ -957,10 +957,8 @@ void SpecialFunctionHandler::handleMakeMock(ExecutionState &state,
     return;
   }
 
-
   KFunction *kf = target->parent->parent;
 
-
   Executor::ExactResolutionList rl;
   executor.resolveExact(state, arguments[0],
                         executor.typeSystemManager->getUnknownType(), rl,
@@ -998,8 +996,9 @@ void SpecialFunctionHandler::handleMakeMock(ExecutionState &state,
         klee_error("klee_make_mock is not allowed when mock strategy is none");
         break;
       case MockStrategy::Naive:
-        source = SourceBuilder::mockNaive(executor.kmodule.get(), *kf->function,
-                                          executor.updateNameVersion(state, name));
+        source =
+            SourceBuilder::mockNaive(executor.kmodule.get(), *kf->function,
+                                     executor.updateNameVersion(state, name));
         break;
       case MockStrategy::Deterministic:
         std::vector<ref<Expr>> args(kf->numArgs);
@@ -1010,10 +1009,11 @@ void SpecialFunctionHandler::handleMakeMock(ExecutionState &state,
                                                   *kf->function, args);
         break;
       }
-      executor.executeMakeSymbolic(state, mo, old->getDynamicType(), source, false);
+      executor.executeMakeSymbolic(state, mo, old->getDynamicType(), source,
+                                   false);
     } else {
-      executor.terminateStateOnUserError(
-          *s, "Wrong size given to klee_make_mock");
+      executor.terminateStateOnUserError(*s,
+                                         "Wrong size given to klee_make_mock");
     }
   }
 }

lib/Module/Annotation.cpp

@@ -96,7 +96,8 @@ inline Statement::Kind stringToKind(const std::string &str) {
 }
 
 Ptr stringToKindPtr(const std::string &str) {
-  switch (stringToKind(toLower(str))) {
+  std::string statementStr = toLower(str.substr(0, str.find(':')));
+  switch (stringToKind(statementStr)) {
   case Statement::Kind::Unknown:
     return std::make_shared<Unknown>(str);
   case Statement::Kind::Deref:
@@ -287,6 +288,9 @@ AnnotationsMap parseAnnotationsXml(const pugi::xml_document &annotationsXml,
 
 AnnotationsMap parseAnnotations(const std::string &path,
                                 const llvm::Module *m) {
+  if (path.empty()) {
+    return {};
+  }
   std::ifstream annotationsFile(path);
   if (!annotationsFile.good()) {
     klee_error("Annotation: Opening %s failed.", path.c_str());

submodules/pugiconfig.hpp

@@ -0,0 +1,81 @@
+/**
+ * pugixml parser - version 1.13
+ * --------------------------------------------------------
+ * Copyright (C) 2006-2022, by Arseny Kapoulkine (arseny.kapoulkine@gmail.com)
+ * Report bugs and download new versions at https://pugixml.org/
+ *
+ * This library is distributed under the MIT License. See notice at the end
+ * of this file.
+ *
+ * This work is based on the pugxml parser, which is:
+ * Copyright (C) 2003, by Kristen Wegner (kristen@tima.net)
+ */
+
+#ifndef HEADER_PUGICONFIG_HPP
+#define HEADER_PUGICONFIG_HPP
+
+// Uncomment this to enable wchar_t mode
+// #define PUGIXML_WCHAR_MODE
+
+// Uncomment this to enable compact mode
+// #define PUGIXML_COMPACT
+
+// Uncomment this to disable XPath
+// #define PUGIXML_NO_XPATH
+
+// Uncomment this to disable STL
+// #define PUGIXML_NO_STL
+
+// Uncomment this to disable exceptions
+#define PUGIXML_NO_EXCEPTIONS
+
+// Set this to control attributes for public classes/functions, i.e.:
+// to export all public symbols from DLL
+// #define PUGIXML_API __declspec(dllexport)
+// to import all classes from DLL
+// #define PUGIXML_CLASS __declspec(dllimport)
+// to set calling conventions to all public functions to fastcall
+// #define PUGIXML_FUNCTION __fastcall
+// In absence of PUGIXML_CLASS/PUGIXML_FUNCTION definitions PUGIXML_API
+// is used instead
+
+// Tune these constants to adjust memory-related behavior
+// #define PUGIXML_MEMORY_PAGE_SIZE 32768
+// #define PUGIXML_MEMORY_OUTPUT_STACK 10240
+// #define PUGIXML_MEMORY_XPATH_PAGE_SIZE 4096
+
+// Tune this constant to adjust max nesting for XPath queries
+// #define PUGIXML_XPATH_DEPTH_LIMIT 1024
+
+// Uncomment this to switch to header-only version
+// #define PUGIXML_HEADER_ONLY
+
+// Uncomment this to enable long long support
+// #define PUGIXML_HAS_LONG_LONG
+
+#endif
+
+/**
+ * Copyright (c) 2006-2022 Arseny Kapoulkine
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */

test/Feature/MockPointersDeterministic.c

@@ -5,8 +5,8 @@
 // RUN: %klee --solver-backend=z3 --output-dir=%t.klee-out-1 --skip-not-lazy-initialized --external-calls=all --mock-strategy=deterministic %t.bc 2>&1 | FileCheck %s -check-prefix=CHECK-1
 // CHECK-1: memory error: null pointer exception
 // CHECK-1: KLEE: done: completed paths = 1
-// CHECK-1: KLEE: done: partially completed paths = 2
-// CHECK-1: KLEE: done: generated tests = 3
+// CHECK-1: KLEE: done: partially completed paths = 1
+// CHECK-1: KLEE: done: generated tests = 2
 
 #include <assert.h>
 
@@ -20,4 +20,4 @@ int main() {
     assert(0 && "age is deterministic");
   }
   return *age();
-}
+}