about summary refs log tree commit diff homepage
path: root/scripts/build/klee.sh
blob: 517318f895639ded144b8797999713ec7cee1e42 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
#!/bin/bash -x
# Compile KLEE
# Make sure we exit if there is a failure
set -e

DIR="$(cd "$(dirname "$0")" && pwd)"
source "${DIR}/common-defaults.sh"

: ${SOLVERS?"Solvers must be specified"}
if [[ -z "${KLEE_UCLIBC}" ]]; then
  echo "KLEE_UCLIBC must be specified: 0 or branch/tag"
  exit 1
fi
if [[ -z "${KLEE_SRC}" ]]; then
  # Assumeption: this build script is part of the KLEE source tree
  KLEE_SRC="${DIR}/../.."
fi

CMAKE_PREFIX_PATH=""
###############################################################################
# Handling LLVM configuration
###############################################################################
if [[ "$TRAVIS_OS_NAME" = "linux" ]] ; then
  LLVM_CONFIG="${LLVM_BIN}/llvm-config"
  LLVM_BUILD_DIR="/usr/lib/llvm-${LLVM_VERSION_SHORT}/build"
  KLEE_CC="${LLVM_BIN}/clang"
  KLEE_CXX="${LLVM_BIN}/clang++"
elif [[ "${TRAVIS_OS_NAME}" == "osx" ]]; then
  LLVM_CONFIG="/usr/local/bin/llvm-config-${LLVM_VERSION}"
  LLVM_BUILD_DIR="$(${LLVM_CONFIG} --src-root)"
  KLEE_CC="/usr/local/bin/clang-${LLVM_VERSION}"
  KLEE_CXX="/usr/local/bin/clang++-${LLVM_VERSION}"
else
  echo "Unhandled TRAVIS_OS_NAME \"${TRAVIS_OS_NAME}\""
  exit 1
fi

###############################################################################
# klee-uclibc
###############################################################################
if [ "${KLEE_UCLIBC}" != "0" ]; then
    KLEE_UCLIBC_CONFIGURE_OPTION=(-DENABLE_KLEE_UCLIBC=TRUE -DKLEE_UCLIBC_PATH="${BASE}/klee-uclibc-${LLVM_VERSION_SHORT}" -DENABLE_POSIX_RUNTIME=TRUE)
else
    KLEE_UCLIBC_CONFIGURE_OPTION=(-DENABLE_KLEE_UCLIBC=FALSE -DENABLE_POSIX_RUNTIME=FALSE)
fi

COVERAGE_FLAGS=""
if [ ${COVERAGE} -eq 1 ]; then
    COVERAGE_FLAGS='-fprofile-arcs -ftest-coverage'
fi


###############################################################################
# Handle setting up solver configure flags for KLEE
###############################################################################
SOLVER_LIST=$(echo "${SOLVERS}" | sed 's/:/ /g')

# Set CMake configure options
KLEE_Z3_CONFIGURE_OPTION=(-DENABLE_SOLVER_Z3=OFF)
KLEE_STP_CONFIGURE_OPTION=(-DENABLE_SOLVER_STP=OFF)
KLEE_METASMT_CONFIGURE_OPTION=(-DENABLE_SOLVER_METASMT=OFF)
for solver in ${SOLVER_LIST}; do
  echo "Setting CMake configuration option for ${solver}"
  case ${solver} in
  STP)
    KLEE_STP_CONFIGURE_OPTION=(-DENABLE_SOLVER_STP=TRUE -DSTP_DIR="${BASE}/stp-${STP_VERSION}-install")
    ;;
  Z3)
    echo "Z3"
    KLEE_Z3_CONFIGURE_OPTION=(-DENABLE_SOLVER_Z3=TRUE)
    if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
    	KLEE_Z3_CONFIGURE_OPTION+=(-DZ3_INCLUDE_DIRS="${BASE}/z3-${Z3_VERSION}-install/include" -DZ3_LIBRARIES="${BASE}/z3-${Z3_VERSION}-install/lib/libz3.so")
    fi
    ;;
  metaSMT)
    echo "metaSMT"
    if [ "X${METASMT_DEFAULT}" == "X" ]; then
      METASMT_DEFAULT=STP
    fi
    KLEE_METASMT_CONFIGURE_OPTION=(-DENABLE_SOLVER_METASMT=TRUE -DmetaSMT_DIR="${BASE}/metaSMT/build" -DMETASMT_DEFAULT_BACKEND="${METASMT_DEFAULT}")
    ;;
  *)
    echo "Unknown solver ${solver}"
    exit 1
  esac
done

###############################################################################
# Handle additional configure flags
###############################################################################

TCMALLOC_OPTION=$([ "${USE_TCMALLOC:-0}" == 1 ] && echo "-DENABLE_TCMALLOC=TRUE" || echo "-DENABLE_TCMALLOC=FALSE")
if [[ "$TCMALLOC_OPTION" != "0" ]] ; then
  if [[ ! -z "${CMAKE_PREFIX_PATH}" ]]; then
    CMAKE_PREFIX_PATH+=":"
  fi
  CMAKE_PREFIX_PATH="${CMAKE_PREFIX_PATH}$BASE/tcmalloc-install"
fi

###############################################################################
# KLEE
###############################################################################
KLEE_BUILD="${BASE}/klee_build${LLVM_VERSION_SHORT}${LLVM_SUFFIX}${SOLVER_SUFFIX}${DEPS_SUFFIX}"
mkdir -p "${KLEE_BUILD}"
cd "${KLEE_BUILD}"
GTEST_SRC_DIR="${BASE}/googletest-release-${GTEST_VERSION}/"
if [ "X${DISABLE_ASSERTIONS}" == "X1" ]; then
  KLEE_ASSERTS_OPTION="-DENABLE_KLEE_ASSERTS=FALSE"
else
  KLEE_ASSERTS_OPTION="-DENABLE_KLEE_ASSERTS=TRUE"
fi

if [ "X${ENABLE_OPTIMIZED}" == "X1" ]; then
  CMAKE_BUILD_TYPE="RelWithDebInfo"
else
  CMAKE_BUILD_TYPE="Debug"
fi

# TODO: We should support Ninja too
# Configure KLEE
echo "CXXFLAGS=\"${COVERAGE_FLAGS} ${SANITIZER_CXX_FLAGS}\" \
CFLAGS=\"${COVERAGE_FLAGS} ${SANITIZER_C_FLAGS}\" \
LDFLAGS=\"${COVERAGE_LDFLAGS} ${SANITIZER_LD_FLAGS}\" \
cmake \
  -DLLVM_CONFIG_BINARY=\"${LLVM_CONFIG}\" \
  -DLLVMCC=\"${KLEE_CC}\" \
  -DLLVMCXX=\"${KLEE_CXX}\" \
  ${KLEE_STP_CONFIGURE_OPTION[@]} \
  ${KLEE_Z3_CONFIGURE_OPTION[@]} \
  ${KLEE_METASMT_CONFIGURE_OPTION[@]} \
  ${KLEE_UCLIBC_CONFIGURE_OPTION[@]} \
  ${TCMALLOC_OPTION[@]} \
  -DGTEST_SRC_DIR=${GTEST_SRC_DIR} \
  -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} \
  ${KLEE_ASSERTS_OPTION[@]} \
  -DENABLE_UNIT_TESTS=TRUE \
  -DENABLE_SYSTEM_TESTS=TRUE \
  -DLIT_ARGS=\"-v\" \
  ${SANITIZER_CMAKE_C_COMPILER[@]} \
  ${SANITIZER_CMAKE_CXX_COMPILER[@]} \
  -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH} \
  ${KLEE_SRC}" > "${KLEE_BUILD}/.build_command"
source "${KLEE_BUILD}/.build_command"
make -j$(nproc)

###############################################################################
# Prepare Coverage functionality
###############################################################################
coverage_setup()
{
  # TODO Remove it and put it to the proper package install section
  apt update && apt -y --no-install-recommends install lcov
  # Zero coverage for any file, e.g. previous tests
  lcov --directory . --no-external --zerocounters
  # Create a baseline by capturing any file used for compilation, no execution yet
  lcov --rc lcov_branch_coverage=1 --directory . --base-directory="${KLEE_SRC}" --no-external --capture --initial --output-file coverage_base.info
  lcov --rc lcov_branch_coverage=1 --remove coverage_base.info 'test/*' --output-file coverage_base.info
  lcov --rc lcov_branch_coverage=1 --remove coverage_base.info 'unittests/*' --output-file coverage_base.info
}

coverageup()
{
  tags=$1
  codecov_suffix=(${tags// /})
  # Create report
  # (NOTE: "--rc lcov_branch_coverage=1" needs to be added in all calls, otherwise branch coverage gets dropped)
  lcov --rc lcov_branch_coverage=1 --directory . --base-directory="${KLEE_SRC}" --no-external --capture --output-file coverage.info
  # Exclude uninteresting coverage goals (LLVM, googletest, and KLEE system and unit tests)
  lcov --rc lcov_branch_coverage=1 --remove coverage.info 'test/*' --output-file coverage.info
  lcov --rc lcov_branch_coverage=1 --remove coverage.info 'unittests/*' --output-file coverage.info
  # Combine baseline and measured coverage
  lcov --rc lcov_branch_coverage=1 -a coverage_base.info -a coverage.info -o coverage_all.info.${codecov_suffix}
  # Debug info
  lcov --rc lcov_branch_coverage=1 --list coverage_all.info.${codecov_suffix}
}

COVERAGE=${COVERAGE:=0}

###############################################################################
# Unit tests
###############################################################################
# Prepare coverage information if COVERAGE is set
if [ ${COVERAGE} -eq 1 ]; then
  coverage_setup
fi
make unittests

# Generate and upload coverage if COVERAGE is set
if [ ${COVERAGE} -eq 1 ]; then
  coverageup "unittests"
fi

###############################################################################
# lit tests
###############################################################################
if [ ${COVERAGE} -eq 1 ]; then
  coverage_setup
fi
make systemtests

# If metaSMT is the only solver, then rerun lit tests with non-default metaSMT backends
if [ "X${SOLVERS}" == "XmetaSMT" ]; then
  metasmt_default=$(to_lower $METASMT_DEFAULT) # klee_opts and kleaver_opts use lowercase
  available_metasmt_backends="btor stp z3 yices2 cvc4"
  for backend in $available_metasmt_backends; do
    if [ "X${metasmt_default}" != "X$backend" ]; then
      if [ "$backend" == "cvc4" ]; then
        for num in {1..5}; do sleep 120; echo 'Keep Travis alive'; done &
      fi
      lit -v --param klee_opts=-metasmt-backend=$backend --param kleaver_opts=-metasmt-backend=$backend test/
    fi
  done
fi

# Generate and upload coverage if COVERAGE is set
if [ ${COVERAGE} -eq 1 ]; then
  coverageup "systemtests"
fi