Merge pull request #524 from secure-software-engineering/feature/statisticsUpdate

Feature/statistics update

Author: pdschubert

.docker/Dockerfile.devenv

@@ -16,4 +16,5 @@ USER vscode
 
 ENV CC "/usr/bin/clang-14"
 ENV CXX "/usr/bin/clang++-14"
+ENV PATH "/usr/local/llvm-14/bin:/home/vscode/.local/bin:$PATH"
 ENV CMAKE_GENERATOR "Ninja"

.github/workflows/docker.yml

@@ -0,0 +1,50 @@
+name: Docker Image
+
+on:
+  push:
+    branches: [ development ]
+
+jobs:
+  push_to_registries:
+    name: Push Docker image to multiple registries
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      # If we want to publish an image of PhASAR to the official docker hub we
+      # can just use the following code and set the corresponding secrets.
+      # - name: Log in to Docker Hub
+      #   uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+      #   with:
+      #     username: ${{ secrets.DOCKER_USERNAME }}
+      #     password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ghcr.io/${{ github.repository }}
+            # here we could add a second image for the official docker registry
+            # sse/phasar
+      - name: Build and push Docker images
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

CMakeLists.txt

@@ -31,7 +31,7 @@ elseif(CMAKE_BUILD_TYPE STREQUAL "Debug")
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -MP -fvisibility-inlines-hidden -fstack-protector-strong -ffunction-sections -fdata-sections -pipe -g")
 else()
   message(STATUS "Selected Release Build")
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -MP -fvisibility-inlines-hidden -fstack-protector-strong -ffunction-sections -fdata-sections -pipe -march=native")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -MP -fvisibility-inlines-hidden -fstack-protector-strong -ffunction-sections -fdata-sections -pipe")
 endif()
 
 # Enable testing

Dockerfile

@@ -1,44 +1,61 @@
-FROM ubuntu:20.04
-ARG LLVM_INSTALL_DIR="/usr/local/llvm-12"
+FROM ubuntu:22.04
+ARG LLVM_INSTALL_DIR="/usr/local/llvm-14"
 LABEL Name=phasar Version=1.0.0
 
 RUN apt -y update && apt install bash sudo -y
 
+
 WORKDIR /usr/src/phasar
 RUN mkdir -p /usr/src/phasar/utils
 
 COPY ./utils/InitializeEnvironment.sh /usr/src/phasar/utils/
 RUN ./utils/InitializeEnvironment.sh
 
+RUN apt-get -y install --no-install-recommends \
+    cmake \
+    ninja-build \
+    libstdc++6 \
+    libboost-all-dev
+
 COPY ./utils/InstallAptDependencies.sh /usr/src/phasar/utils/
 RUN ./utils/InstallAptDependencies.sh
 
+RUN apt-get update && \
+    apt-get install -y software-properties-common
+
+RUN apt-key adv --fetch-keys https://apt.llvm.org/llvm-snapshot.gpg.key && \
+           add-apt-repository -y 'deb http://apt.llvm.org/focal/ llvm-toolchain-focal-14 main' && \
+           apt-get update && \
+           apt-get -y install --no-install-recommends \
+              clang-14 \
+              llvm-14-dev \
+              libllvm14 \
+              libclang-common-14-dev \
+              libclang-14-dev \
+              libclang-cpp14-dev \
+              clang-tidy-14
+
 RUN pip3 install Pygments pyyaml
 
 # installing boost
 RUN apt install libboost-all-dev -y
 
-# installing LLVM
-COPY utils/safeCommandsSet.sh /usr/src/phasar/utils/safeCommandsSet.sh
-COPY utils/install-llvm.sh /usr/src/phasar/utils/install-llvm.sh
-RUN ./utils/install-llvm.sh $(nproc) . ${LLVM_INSTALL_DIR} "llvmorg-12.0.0"
 
 # installing wllvm
 RUN pip3 install wllvm
 
-ENV CC=${LLVM_INSTALL_DIR}/bin/clang
-ENV CXX=${LLVM_INSTALL_DIR}/bin/clang++
-ENV LD_LIBRARY_PATH=${LLVM_INSTALL_DIR}/lib:$LD_LIBRARY_PATH
+ENV CC=/usr/bin/clang-14
+ENV CXX=/usr/bin/clang++-14
 
 COPY . /usr/src/phasar
 
 RUN git submodule init
 RUN git submodule update
-RUN mkdir -p build &&                       \
-    cd build &&                             \
-    cmake -DCMAKE_BUILD_TYPE=Release .. &&  \
-    make -j $(nproc) &&                     \
-    make install &&                         \
-    ldconfig
+RUN mkdir -p build && cd build && \
+          cmake .. \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DCMAKE_CXX_COMPILER=$CXX \
+            -G Ninja && \
+          cmake --build .
 
 ENTRYPOINT [ "./build/tools/phasar-llvm/phasar-llvm" ]

include/phasar/Controller/AnalysisController.h

@@ -49,7 +49,7 @@ enum class AnalysisControllerEmitterOptions : uint32_t {
   EmitPTAAsText = (1 << 11),
   EmitPTAAsDot = (1 << 12),
   EmitPTAAsJson = (1 << 13),
-  EmitStatisticAsJson = (1 << 14),
+  EmitStatisticsAsJson = (1 << 14),
 };
 
 class AnalysisController {

include/phasar/PhasarLLVM/Passes/GeneralStatisticsAnalysis.h

@@ -48,6 +48,7 @@ class GeneralStatistics {
   std::set<const llvm::Type *> AllocatedTypes;
   std::set<const llvm::Instruction *> AllocaInstructions;
   std::set<const llvm::Instruction *> RetResInstructions;
+  std::string ModuleName = "";
 
 public:
   /**

lib/Controller/AnalysisController.cpp

@@ -273,9 +273,9 @@ void AnalysisController::emitRequestedHelperAnalysisResults() {
     }
   }
 
-  if (EmitterOptions & AnalysisControllerEmitterOptions::EmitStatisticAsJson) {
+  if (EmitterOptions & AnalysisControllerEmitterOptions::EmitStatisticsAsJson) {
     if (!ResultDirectory.empty()) {
-      if (auto OFS = openFileStream("/psr-IrStatistic.json")) {
+      if (auto OFS = openFileStream("/psr-IrStatistics.json")) {
         IRDB.printAsJson(*OFS);
       }
     } else {

lib/PhasarLLVM/Passes/GeneralStatisticsAnalysis.cpp

@@ -42,6 +42,7 @@ GeneralStatisticsAnalysis::run(llvm::Module &M,
   static const std::set<std::string> MemAllocatingFunctions = {
       "operator new(unsigned long)", "operator new[](unsigned long)", "malloc",
       "calloc", "realloc"};
+  Stats.ModuleName = M.getName();
   for (auto &F : M) {
     ++Stats.Functions;
     for (auto &BB : F) {
@@ -217,11 +218,12 @@ GeneralStatistics::getRetResInstructions() const {
 
 nlohmann::json GeneralStatistics::getAsJson() const {
   nlohmann::json J;
+  J["ModuleName"] = GeneralStatistics::ModuleName;
   J["Instructions"] = getInstructions();
   J["Functions"] = Functions;
-  J["Alloca Instructions"] = AllocaInstructions.size();
-  J["Call Sites"] = CallSites;
-  J["Global Variables"] = Globals;
+  J["AllocaInstructions"] = AllocaInstructions.size();
+  J["CallSites"] = CallSites;
+  J["GlobalVariables"] = Globals;
   return J;
 }
 

tools/phasar-llvm/phasar-llvm.cpp

@@ -408,7 +408,7 @@ int main(int Argc, const char **Argv) {
     EmitterOptions |= AnalysisControllerEmitterOptions::EmitPTAAsJson;
   }
   if (PhasarConfig::VariablesMap().count("emit-statistic-as-json")) {
-    EmitterOptions |= AnalysisControllerEmitterOptions::EmitStatisticAsJson;
+    EmitterOptions |= AnalysisControllerEmitterOptions::EmitStatisticsAsJson;
   }
   if (PhasarConfig::VariablesMap().count("follow-return-past-seeds")) {
     SolverConfig.setFollowReturnsPastSeeds(