Runtime.h

// This file is part of SymCC.
//
// SymCC is free software: you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the Free Software
// Foundation, either version 3 of the License, or (at your option) any later
// version.
//
// SymCC is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
// A PARTICULAR PURPOSE. See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with
// SymCC. If not, see <https://www.gnu.org/licenses/>.

#ifndef RUNTIME_H
#define RUNTIME_H

#include <llvm/IR/InstrTypes.h>
#include <llvm/IR/Module.h>

#if LLVM_VERSION_MAJOR >= 9 && LLVM_VERSION_MAJOR < 11
using SymFnT = llvm::Value *;
#else
using SymFnT = llvm::FunctionCallee;
#endif

/// Runtime functions
struct Runtime {
  Runtime(llvm::Module &M);

  SymFnT buildInteger{};
  SymFnT buildInteger128{};
  SymFnT buildFloat{};
  SymFnT buildNullPointer{};
  SymFnT buildTrue{};
  SymFnT buildFalse{};
  SymFnT buildBool{};
  SymFnT buildSExt{};
  SymFnT buildZExt{};
  SymFnT buildTrunc{};
  SymFnT buildBswap{};
  SymFnT buildIntToFloat{};
  SymFnT buildFloatToFloat{};
  SymFnT buildBitsToFloat{};
  SymFnT buildFloatToBits{};
  SymFnT buildFloatToSignedInt{};
  SymFnT buildFloatToUnsignedInt{};
  SymFnT buildFloatAbs{};
  SymFnT buildBoolAnd{};
  SymFnT buildBoolOr{};
  SymFnT buildBoolXor{};
  SymFnT buildBoolToBit{};
  SymFnT buildBitToBool{};
  SymFnT buildAddOverflow{};
  SymFnT buildSubOverflow{};
  SymFnT buildMulOverflow{};
  SymFnT buildSAddSat{};
  SymFnT buildUAddSat{};
  SymFnT buildSSubSat{};
  SymFnT buildUSubSat{};
  SymFnT buildSShlSat{};
  SymFnT buildUShlSat{};
  SymFnT buildFshl{};
  SymFnT buildFshr{};
  SymFnT buildAbs{};
  SymFnT buildConcat{};
  SymFnT pushPathConstraint{};
  SymFnT getParameterExpression{};
  SymFnT setParameterExpression{};
  SymFnT setReturnExpression{};
  SymFnT getReturnExpression{};
  SymFnT memcpy{};
  SymFnT memset{};
  SymFnT memmove{};
  SymFnT readMemory{};
  SymFnT writeMemory{};
  SymFnT buildZeroBytes{};
  SymFnT buildInsert{};
  SymFnT buildExtract{};
  SymFnT notifyCall{};
  SymFnT notifyRet{};
  SymFnT notifyBasicBlock{};

  /// Mapping from icmp predicates to the functions that build the corresponding
  /// symbolic expressions.
  std::array<SymFnT, llvm::CmpInst::BAD_ICMP_PREDICATE> comparisonHandlers{};

  /// Mapping from binary operators to the functions that build the
  /// corresponding symbolic expressions.
  std::array<SymFnT, llvm::Instruction::BinaryOpsEnd> binaryOperatorHandlers{};

  /// Mapping from unary operators to the functions that build the
  /// corresponding symbolic expressions.
  std::array<SymFnT, llvm::Instruction::UnaryOpsEnd> unaryOperatorHandlers{};
};

bool isInterceptedFunction(const llvm::Function &f);

#endif