Merge pull request #527 from secure-software-engineering/development

Update `master`

Author: pdschubert

.docker/Dockerfile.devenv

@@ -0,0 +1,20 @@
+FROM ubuntu:22.04
+
+RUN apt -y update && apt -y upgrade && apt install bash  -y
+RUN DEBIAN_FRONTEND=noninteractive apt -y install wget gpg software-properties-common lsb-release git make python3 python3-pip vim -y
+RUN apt -y update && apt -y install cmake clang-14 ninja-build sudo
+
+RUN pip install pre-commit
+
+RUN set -exu; \
+    useradd -p test -s /bin/bash -m vscode; \
+    groupadd docker; \
+    usermod -aG docker vscode; \
+    usermod -aG sudo vscode;
+
+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"

.docker/config.json

@@ -0,0 +1,3 @@
+{
+  "dockerfile": "Dockerfile.devenv"
+}

.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 }}

.gitmodules

@@ -6,9 +6,6 @@
 	path = external/googletest
 	url = https://github.com/google/googletest.git
 	branch = master
-[submodule "external/WALi-OpenNWA"]
-	path = external/WALi-OpenNWA
-	url = https://github.com/pdschubert/WALi-OpenNWA.git
 [submodule "external/json-schema-validator"]
 	path = external/json-schema-validator
 	url = https://github.com/pboettch/json-schema-validator.git

Brewfile

@@ -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
@@ -243,10 +243,6 @@ if (PHASAR_IN_TREE)
   )
 endif()
 
-# WALi-OpenNWA
-add_subdirectory(external/WALi-OpenNWA)
-include_directories(external/WALi-OpenNWA/Source/wali/include)
-
 # Set up clang-tidy to run during PhASAR's compilation to indicate code smells
 if (PHASAR_ENABLE_CLANG_TIDY_DURING_BUILD)
   message(STATUS "Enabled clang-tidy during build")

CMakeLists.txt

@@ -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" ]

Dockerfile

@@ -99,36 +99,6 @@ pyyaml tests        llvm/test/YAMLParser/{*.data, LICENSE.TXT}
 ARM contributions   llvm/lib/Target/ARM/LICENSE.TXT
 md5 contributions   llvm/lib/Support/MD5.cpp llvm/include/llvm/Support/MD5.h
 
-
-WALi-OpenNWA
--------------------------------------------------------------------------------
-OpenNWA portions:
-  Copyright (c) 2009-2012 Amanda Burton, Evan Driscoll, Aditya Thakur,
-                and Thomas Reps
-
-WALi portions:
-  Copyright (c) 2010 Nicholas Kidd, Akash Lal, and Thomas Reps
-  Copyright (c) 2007 Nicholas Kidd, Akash Lal, and Thomas Reps
-
-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.
-
-
 Boost
 -------------------------------------------------------------------------------
 Boost Software License - Version 1.0 - August 17th, 2003

LICENSE.txt

@@ -73,31 +73,9 @@ Done!
 
 
 ### Installing PhASAR a MacOS system
-Mac OS 10.13.1 or higher only!
-To install the framework on a Mac we will rely on Homebrew. (https://brew.sh/)
-
-Please follow the instructions down below.
-
-```
-$ brew install boost
-$ brew install python3
-# Install llvm version 10
-$ brew install llvm
-# Setting the paths
-# Use LLVM's Clang rather than Apple's Clang compiler
-$ export CC=/usr/local/opt/llvm/bin/clang
-$ export CXX=/usr/local/opt/llvm/bin/clang++
-# Set PATH env variable to /usr/local/opt/llvm/bin
-# Go to PhASAR directory run the following commands
-$ git submodule init
-$ git submodule update
-$ mkdir build
-$ cd build/
-$ cmake -DCMAKE_BUILD_TYPE=Release ..
-$ make -j $(nproc) # or use a different number of cores to compile it
-$ sudo make install # if you wish a system-wise installation
-```
-
+Due to unfortunate updates to MacOS and the handling of C++, especially on the newer M1 processors, we can't support native development on Mac.
+The easiest solution to develop PhASAR on a Mac right now is to use [dockers development environments](https://docs.docker.com/desktop/dev-environments/). Clone this repository as described in their documentation. Afterwards, you have to login once manually, as a root user by running `docker exec -it -u root <container name> /bin/bash` to complete the rest of the install process as described in this readme (install submodules, run bootstrap.sh, ...).
+Now you can just attach your docker container to VS Code or any other IDE, which supports remote development.
 
 ### Compiling PhASAR (if not already done using the installation scripts)
 Set the system's variables for the C and C++ compiler to clang: