Merge pull request #151 from ut-issl/develop

Update main (v3.4.0) on 2021-12-31

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,7 +2,7 @@
 ひとことで
 
 ## Issue
-Issue がすでに立っているならば，そのリンクを貼る
+- 関連する issue
 
 ## 詳細
 詳しく

.github/labels.yml

@@ -49,3 +49,15 @@
 - name: "priority::medium"
   description: "priority medium"
   color: "fbca04"
+
+- name: "tools"
+  description: ""
+  color: "510f70"
+
+- name: "S2E"
+  description: ""
+  color: "eef789"
+
+- name: "WINGS"
+  description: ""
+  color: "1503bb"

.github/workflows/build_as_c89.yml

@@ -0,0 +1,178 @@
+name: build as C89 using SILS Mockup
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    paths:
+      - '.github/workflows/build_as_c89.yml'
+      - 'c2a_core_main.c'
+      - 'c2a_core_main.h'
+      - 'common.cmake'
+      - 'Applications/**'
+      - 'CmdTlm/**'
+      - 'Drivers/**'
+      - 'IfWrapper/**'
+      - 'Library/**'
+      - 'System/**'
+      - 'Examples/minimum_user_for_s2e/CMakeLists.txt'
+      - 'Examples/minimum_user_for_s2e/src/**'
+      - 'setup.bat'
+      - 'setup.sh'
+
+jobs:
+  gen_build_matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.gen-matrix.outputs.matrix }}
+    steps:
+      - name: generate matrix json
+        id: gen-matrix
+        shell: bash
+        run: |
+          compiler=(
+            "gcc"
+            "clang"
+          )
+          warning=(
+          "Werror"
+          "Wextra"
+          )
+          echo "[" > tmp
+          for c in "${compiler[@]}"; do
+            for w in "${warning[@]}"; do
+              if [ "$c" == "gcc" ] && [ "$w" == "Werror" ]; then
+                continue
+              fi
+              echo "{ \"compiler\": \"${c}\", \"warning\": \"${w}\" }" >> tmp
+              echo "," >> tmp
+            done
+          done
+          sed -i -e '$d' tmp # remove final comma
+          echo "]" >> tmp
+          sed -i -z 's/\n//g' tmp # remove newline
+          jq < tmp
+          echo "::set-output name=matrix::{\"include\": $(cat tmp) }"
+
+  build_minimum_user_as_c89:
+    runs-on: ubuntu-latest
+    needs: gen_build_matrix
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJson(needs.gen_build_matrix.outputs.matrix) }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: install deps
+        run: |
+          sudo apt-get install -y libc6-dev-i386 nkf
+
+      - name: convert Shift-JIS to UTF-8
+        if: matrix.compiler == 'clang'
+        run: find -- . -type f \( -name '*.h' -or -name '*.c' \) -exec nkf --overwrite -S -w80 "{}" \;
+
+      - name: setup
+        shell: bash
+        run: ./setup.sh
+
+      - name: generate compile option
+        id: compile_flags
+        shell: bash
+        run: |
+          WERROR="OFF"
+          WEXTRA="OFF"
+          if ${{ contains(matrix.warning, 'Werror') }}; then
+            WERROR="ON"
+          fi
+          if ${{ contains(matrix.warning, 'Wextra') }}; then
+            WEXTRA="ON"
+          fi
+          echo "::set-output name=WERROR::${WERROR}"
+          echo "::set-output name=WEXTRA::${WEXTRA}"
+
+      - name: cmake
+        working-directory: ./Examples/minimum_user_for_s2e
+        env:
+          CC: ${{ matrix.compiler }}
+        run: |
+          mkdir build
+          cd build
+          cmake .. -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DUSE_SILS_MOCKUP=ON -DADD_WERROR_FLAGS=${{ steps.compile_flags.outputs.WERROR }} -DADD_WEXTRA_FLAGS=${{ steps.compile_flags.outputs.WEXTRA }}
+
+      - name: build
+        id: build
+        continue-on-error: ${{ matrix.compiler == 'clang' }}
+        working-directory: ./Examples/minimum_user_for_s2e/build
+        run: cmake --build .
+
+      - name: run
+        if: steps.build.outcome == 'success'
+        working-directory: ./Examples/minimum_user_for_s2e/build
+        shell: bash
+        run: timeout 3 ./C2A || exit 0
+
+
+      - name: install reviewdog
+        if: matrix.compiler == 'clang'
+        uses: reviewdog/[email protected]
+
+      - name: install clang-tidy
+        if: matrix.compiler == 'clang'
+        run: sudo apt-get install -y clang-tidy-11
+
+      - name: clang-tidy
+        if: matrix.compiler == 'clang'
+        working-directory: ./Examples/minimum_user_for_s2e/build
+        run: |
+          run-clang-tidy-11 \
+            | sed 's/\/home\/runner\/work\/c2a-core\/c2a-core\///g' \
+            | sed 's/Examples\/minimum_user_for_s2e\/src\/src_core\///g' \
+            > clang_tidy.log
+
+      - name: clang-tidy result
+        if: matrix.compiler == 'clang'
+        working-directory: ./Examples/minimum_user_for_s2e/build
+        run: cat clang_tidy.log
+
+      - name: reviewdog clang-tidy (github-pr-review)
+        if: matrix.compiler == 'clang' && matrix.warning == 'Werror'
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          cp ./Examples/minimum_user_for_s2e/build/clang_tidy.log .
+          reviewdog \
+            -name 'clang-tidy(Werror)' \
+            -level warning \
+            -fail-on-error=true \
+            -filter-mode=added \
+            -diff="git diff FETCH_HEAD" \
+            -reporter=github-pr-review \
+            -efm="%-Gclang-tidy%s" \
+            -efm="%-GError while processing%s" \
+            -efm="%W%f:%l:%c: warning: %m" \
+            -efm="%E%f:%l:%c: error: %m" \
+            -efm="%C%m" \
+            < clang_tidy.log
+
+      # - name: reviewdog clang-tidy (github-check)
+      #   if: matrix.compiler == 'clang' && matrix.warning == 'Wextra'
+      #   env:
+      #     REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      #   run: |
+      #     cp ./Examples/minimum_user_for_s2e/build/clang_tidy.log .
+      #     reviewdog \
+      #       -name 'clang-tidy(Wextra)' \
+      #       -level warning \
+      #       -fail-on-error=true \
+      #       -filter-mode=nofilter \
+      #       -diff="git diff FETCH_HEAD" \
+      #       -reporter=github-check \
+      #       -efm="%-Gclang-tidy%s" \
+      #       -efm="%-GError while processing%s" \
+      #       -efm="%W%f:%l:%c: warning: %m" \
+      #       -efm="%E%f:%l:%c: error: %m" \
+      #       -efm="%C%m" \
+      #       < clang_tidy.log

.github/workflows/build_as_cxx.yml

@@ -0,0 +1,64 @@
+name: build as C++ for S2E
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    paths:
+      - '.github/workflows/build_as_cxx.yml'
+      - 'c2a_core_main.c'
+      - 'c2a_core_main.h'
+      - 'common.cmake'
+      - 'Applications/**'
+      - 'CmdTlm/**'
+      - 'Drivers/**'
+      - 'IfWrapper/**'
+      - 'Library/**'
+      - 'System/**'
+      - 'Examples/minimum_user_for_s2e/CMakeLists.txt'
+      - 'Examples/minimum_user_for_s2e/src/**'
+      - 'setup.bat'
+      - 'setup.sh'
+
+jobs:
+  build_minimum_user_as_cxx:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: setup
+        shell: cmd
+        run: ./setup.bat
+
+      - name: cmake
+        working-directory: ./Examples/minimum_user_for_s2e
+        run: |
+          mkdir build
+          cd build
+          cmake .. -A Win32
+
+      - name: build
+        working-directory: ./Examples/minimum_user_for_s2e/build
+        run: cmake --build .
+
+  build_s2e_mockup:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: setup
+        shell: cmd
+        run: ./setup.bat
+
+      - name: cmake
+        working-directory: ./Examples/minimum_user_for_s2e/src/s2e_mockup
+        run: |
+          mkdir build
+          cd build
+          cmake .. -A Win32
+
+      - name: build
+        working-directory: ./Examples/minimum_user_for_s2e/src/s2e_mockup/build
+        run: cmake --build .

.github/workflows/check_coding_rule.yml

@@ -0,0 +1,24 @@
+name: check_coding_rule
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+
+jobs:
+  check_coding_rule:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+          architecture: 'x64'
+      - name: setup
+        shell: bash
+        run: ./setup.sh
+      - name: check_coding_rule
+        run: python ./src_core/Script/CI/check_coding_rule.py ./src_core/Script/CI/check_coding_rule.json
+        working-directory: ./Examples/minimum_user_for_s2e/src

.github/workflows/check_encoding.yml

@@ -0,0 +1,22 @@
+name: check_encoding
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+
+jobs:
+  check_encoding:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+          architecture: 'x64'
+      - run: pip install chardet
+      - name: check_encoding
+        run: python check_encoding.py
+        working-directory: ./Script/CI

.github/workflows/labeler.yml

@@ -3,7 +3,7 @@ name: labeler
 on:
   push:
     branches:
-      - main
+      - develop
   pull_request:
     paths:
       - .github/workflows/labeler.yml
@@ -22,4 +22,4 @@ jobs:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           yaml-file: .github/labels.yml
           skip-delete: false
-          dry-run: ${{ github.ref != 'refs/heads/main' }}
+          dry-run: ${{ github.ref != 'refs/heads/develop' }}

.gitignore

@@ -56,3 +56,9 @@ dkms.conf
 .AppleDouble
 .LSOverride
 ._*
+
+# for c2a user sample
+Examples/minimum_user_for_s2e/src/src_core
+Examples/minimum_user_for_s2e/build
+Examples/minimum_user_for_s2e/src/src_user/Test/authorization.json
+*.pyc

Applications/CMakeLists.txt

@@ -0,0 +1,25 @@
+cmake_minimum_required(VERSION 3.13)
+
+project(C2A_CORE_APPS)
+
+set(C2A_SRCS
+  anomaly_handler.c
+  divided_cmd_utility.c
+  gs_command_dispatcher.c
+  event_utility.c
+  memory_dump.c
+  nop.c
+  realtime_command_dispatcher.c
+  timeline_command_dispatcher.c
+  utility_command.c
+  utility_counter.c
+  telemetry_manager.c
+)
+
+if(BUILD_C2A_AS_CXX)
+  set_source_files_properties(${C2A_SRCS} PROPERTIES LANGUAGE CXX)  # C++
+endif()
+
+add_library(${PROJECT_NAME} OBJECT ${C2A_SRCS})
+
+include(${C2A_CORE_DIR}/common.cmake)

Applications/anomaly_handler.c

@@ -34,7 +34,7 @@ static size_t AH_prev_act_;
 
 AppInfo AH_create_app(void)
 {
-  return create_app_info("ah", AH_init_, AH_exec_);
+  return AI_create_app_info("ah", AH_init_, AH_exec_);
 }
 
 
@@ -225,7 +225,7 @@ static void AH_respond_to_anomaly_(size_t id)
 
 AppInfo print_ah_status(void)
 {
-  return create_app_info("ahs", NULL, AH_print_ah_status_);
+  return AI_create_app_info("ahs", NULL, AH_print_ah_status_);
 }