Merge pull request #222 from intel-innersource/rdementi/simdjson-submodule

rdementi · web-flow · commit c4f4cf171657 · 2022-09-12T14:28:40.000+02:00
simdjson submodule
diff --git a/.github/workflows/ci-clang-scan.yml b/.github/workflows/ci-clang-scan.yml
@@ -14,11 +14,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Preparation
-      run: |
-        cd ${{ github.workspace }}/src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
     - name: Configure CMake
       run: |
         cmake --version
diff --git a/.github/workflows/ci-cmake-options.yml b/.github/workflows/ci-cmake-options.yml
@@ -14,11 +14,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Preparation
-      run: |
-        cd ${{ github.workspace }}/src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
 
     - name: CMake default install
       run: |
diff --git a/.github/workflows/ci-cpack.yml b/.github/workflows/ci-cpack.yml
@@ -13,11 +13,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Preparation
-      run: |
-        cd ${{ github.workspace }}/src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
     - name: Configure CMake
       run: |
         cmake --version
@@ -39,11 +34,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Preparation
-      run: |
-        cd ${{ github.workspace }}/src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
     - name: Configure CMake
       run: |
         cmake --version
diff --git a/.github/workflows/ci-cppcheck.yml b/.github/workflows/ci-cppcheck.yml
@@ -16,5 +16,4 @@ jobs:
     - uses: actions/checkout@v2
     - name: cppcheck_script
       run: |
-        git clone https://github.com/simdjson/simdjson.git
         sh ${{ github.workspace }}/scripts/cppcheck.sh . `getconf _NPROCESSORS_ONLN`
diff --git a/.github/workflows/ci-gcc10.yml b/.github/workflows/ci-gcc10.yml
@@ -14,11 +14,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Preparation
-      run: |
-        cd ${{ github.workspace }}/src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
     - name: Configure CMake
       run: |
         cmake --version
diff --git a/.github/workflows/ci-gcc48.yml b/.github/workflows/ci-gcc48.yml
@@ -14,11 +14,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Preparation
-      run: |
-        cd ${{ github.workspace }}/src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
     - name: Configure CMake
       run: |
         cmake --version
diff --git a/.github/workflows/ci-gcc5.yml b/.github/workflows/ci-gcc5.yml
@@ -14,11 +14,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Preparation
-      run: |
-        cd ${{ github.workspace }}/src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
     - name: Configure CMake
       run: |
         cmake --version
diff --git a/.github/workflows/ci-gcc7.yml b/.github/workflows/ci-gcc7.yml
@@ -14,11 +14,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Preparation
-      run: |
-        cd ${{ github.workspace }}/src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
     - name: Configure CMake
       run: |
         cmake --version
diff --git a/.github/workflows/ci-gcc9.yml b/.github/workflows/ci-gcc9.yml
@@ -14,11 +14,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Preparation
-      run: |
-        cd ${{ github.workspace }}/src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
     - name: Configure CMake
       run: |
         cmake --version
diff --git a/.github/workflows/ci-kw-linux-report.yml b/.github/workflows/ci-kw-linux-report.yml
@@ -12,9 +12,6 @@ jobs:
     - uses: actions/checkout@v2
     - name: kw
       run: |
-        cd src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
         mkdir build
         cd build
         cmake ..
diff --git a/.github/workflows/ci-kw-linux.yml b/.github/workflows/ci-kw-linux.yml
@@ -16,9 +16,6 @@ jobs:
     - uses: actions/checkout@v2
     - name: kw
       run: |
-        cd src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
         mkdir build
         cd build
         cmake ..
diff --git a/.github/workflows/ci-kw-windows-report.yml b/.github/workflows/ci-kw-windows-report.yml
@@ -16,9 +16,6 @@ jobs:
     
     - name: kw
       run: |
-        cd ${{github.workspace}}\src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
         mkdir build
         cd build
         cmake ..
diff --git a/.github/workflows/ci-kw-windows.yml b/.github/workflows/ci-kw-windows.yml
@@ -20,9 +20,6 @@ jobs:
     
     - name: kw
       run: |
-        cd ${{github.workspace}}\src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
         mkdir build
         cd build
         cmake ..
diff --git a/.github/workflows/ci-test.yml b/.github/workflows/ci-test.yml
@@ -14,11 +14,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Preparation
-      run: |
-        cd ${{ github.workspace }}/src
-        git clone https://github.com/simdjson/simdjson.git
-        cd ..
     - name: Configure CMake
       run: |
         cmake --version
diff --git a/.github/workflows/ci-windows.yml b/.github/workflows/ci-windows.yml
@@ -17,10 +17,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Preparation
-      run: |
-        cd ${{github.workspace}}\src
-        git clone https://github.com/simdjson/simdjson.git
     - name: Configure CMake
       run: |
         if (Test-Path ${{github.workspace}}\build){ Remove-Item ${{github.workspace}}\build -Recurse }
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "src/simdjson"]
+	path = src/simdjson
+	url = https://github.com/simdjson/simdjson.git
diff --git a/README.md b/README.md
@@ -55,6 +55,18 @@ And finally a daemon that stores core, memory and QPI counters in shared memory
 Building PCM Tools
 --------------------------------------------------------------------------------
 
+Clone PCM repository with submodules:
+
+```
+git clone --recursive https://github.com/opcm/pcm.git
+```
+
+or clone the repository first, and then update submodules with:
+
+```
+git submodule update --init --recursive
+```
+
 Install cmake then:
 
 ```
diff --git a/doc/PCM_RAW_README.md b/doc/PCM_RAW_README.md
@@ -38,7 +38,11 @@ pcm-raw -e core/config=0x00000000004300c5,name=BR_MISP_RETIRED.ALL_BRANCHES -e c
 Collecting Events By Names From Event Lists (https://download.01.org/perfmon/)
 --------------------------------------------------------------------------------
 
-pcm-raw can also automatically lookup the events from the json event lists (https://download.01.org/perfmon/) and translate them to raw encodings itself. To make this work you need to download simdjson library in the PCM source directory and recompile PCM:
+pcm-raw can also automatically lookup the events from the json event lists (https://download.01.org/perfmon/) and translate them to raw encodings itself. To make this work you need to checkout PCM with simdjson submodule:
+
+* use git clone --recursive flag when cloning pcm repository, or
+* update submodule with command `git submodule update --init --recursive`, or
+* download simdjson library in the PCM source directory and recompile PCM:
 
 1. change to PCM 'src/' directory
 2. git clone https://github.com/simdjson/simdjson.git
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -113,7 +113,9 @@ if(SIMDJSON_IS_APPLICABLE)
         else()
             message(WARNING
                 " ${CMAKE_CURRENT_SOURCE_DIR}/simdjson/singleheader/simdjson.h doesn't exist\n"
-                " Run 'git clone https://github.com/simdjson/simdjson.git' in 'src' directory to get simdjson library")
+                " Use `git clone --recursive` flag when cloning pcm repository to clone simdjson submodule as well or\n"
+                " update submodule with command 'git submodule update --init --recursive' or\n"
+                " run 'git clone https://github.com/simdjson/simdjson.git' in 'src' directory to get simdjson library")
         endif()
     endif(simdjson_FOUND)
 endif(SIMDJSON_IS_APPLICABLE)
diff --git a/src/simdjson b/src/simdjson
@@ -0,0 +1 @@
+Subproject commit e6c90b8efb5a4f3fbd93db01181c2b22e0c92167
