Update trace branch

.circleci/config.yml

@@ -49,4 +49,5 @@ workflows:
             - docs-build
           filters:
             branches:
-              only: main
+              only: 
+                - main

.github/ISSUE_TEMPLATE/simeng-bug-or-issue-report.md

@@ -0,0 +1,66 @@
+---
+name: SimEng Bug or Issue Report
+about: Report a bug or un-expected SimEng behaviour
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Check List**
+ - [ ] The binary I am trying to run has been compiled statically for either RV64 or AArch64.
+ - [ ] The compiled binary is a Linux Elf file.
+ - [ ] I have provided both a config file and a binary to SimEng as runtime arguments.
+
+**Binary File Information**
+Please run `file` on the binary used and paste the output below (i.e. `file myBinary.elf`).
+```bash
+```
+
+**System Description**
+Please provide the following as a list:
+ - The Operating System of the system you are running SimEng on
+ - The compiler used to compile SimEng and its version
+ - The compiler used to compile the static binary and its version
+ - The ISA or specific processor that the binary was compiled for
+   - For example, if `-march=armv8.4-a+sve` was used, then present `armv8.4-a+sve`
+   - If `-mcpu=neoverse-v1` or similar was used, then present `neoverse-v1`
+ - The processor of the system you are running SimEng on
+ - The main memory capacity of the system you are running SimEng on
+
+**SimEng Version**
+Provide the SimEng repository branch, commit hash, and version tag (if relevant) that the issue is present on.
+
+**SimEng CMAKE Options Used**
+Provide a bullet list of all CMAKE options used. E.g. `-DCMAKE_BUILD_TYPE=Release`.
+
+**Binary Compilation Instructions**
+Provide a bullet list of how the binary in question was compiled, including all compiler flags used.
+
+**SimEng Command Line Expression**
+Provide the command line expression used to run SimEng e.g. `./simeng /path/to/configs/a64fx.yaml /path/to/myBinary.elf`
+
+**SimEng Metadata Output**
+If your simulation begins to execute the binary, please provide the metadata that SimEng prints at the start of execution.
+E.g.
+```bash
+./simeng configs/a64fx.yaml myStaticBinary.elf 
+[SimEng] Build metadata: 
+[SimEng]        Version: 0.9.6 
+[SimEng]        Compile Time - Date: 14:01:44 - Jun 19 2024 
+[SimEng]        Build type: Debug 
+[SimEng]        Compile options: $<$<COMPILE_LANGUAGE:CXX>:-fno-rtti>;-Wall;-pedantic;-Werror 
+[SimEng]        Test suite: ON 
+
+[SimEng] Running in Out-of-Order mode 
+[SimEng] Workload: /home/SimEng/myStaticBinary.elf 
+[SimEng] Config file: /home/SimEng/configs/a64fx.yaml 
+[SimEng] ISA: AArch64
+[SimEng] Auto-generated Special File directory: True 
+[SimEng] Special File directory used: /home/SimEng/build/specialFiles/ 
+[SimEng] Number of Cores: 1 
+[SimEng] Starting...
+```
+
+**Problem Description**
+Explain what you think should happen, and what actually happens.

.github/ISSUE_TEMPLATE/simeng-instruction-NYI-or-Alias.md

@@ -0,0 +1,51 @@
+---
+name: SimEng Instruction Not-Yet-Imlpemented, Alias, or Missing System Register
+about: Report an instruction which either does not yet have execution logic implemented (NYI), an instruction who's alias needs resolving, or an instruction which targets a system register which is not yet supported.
+title: '[NYI|ALIAS|SYSREG]'
+labels: ''
+assignees: ''
+
+---
+
+**Check List**
+ - [ ] I have selected the appropriate title prefix from the available options within `[NYI|ALIAS|SYSREG]`, and added a suitable title after this.
+ - [ ] The binary I am trying to run has been compiled statically for either RV64 or AArch64.
+ - [ ] The compiled binary is a Linux Elf file.
+
+**Binary Compilation Instructions**
+Provide a bullet list of how the binary in question was compiled, including all compiler flags used.
+
+**SimEng CMAKE Options Used**
+Provide a bullet list of all CMAKE options used. E.g. `-DCMAKE_BUILD_TYPE=Release`.
+
+**SimEng Command Line Expression**
+Provide the command line expression used to run SimEng e.g. `./simeng /path/to/configs/a64fx.yaml /path/to/myBinary.elf`
+
+**Console Printout**
+Please provide a copy of SimEng's console printout prior to its end-of-execution statistics. Please do not include any binary specific output.
+E.g.
+```bash
+./simeng configs/a64fx.yaml myStaticBinary.elf 
+[SimEng] Build metadata: 
+[SimEng]        Version: 0.9.6 
+[SimEng]        Compile Time - Date: 14:01:44 - Jun 19 2024 
+[SimEng]        Build type: Debug 
+[SimEng]        Compile options: $<$<COMPILE_LANGUAGE:CXX>:-fno-rtti>;-Wall;-pedantic;-Werror 
+[SimEng]        Test suite: ON 
+
+[SimEng] Running in Out-of-Order mode 
+[SimEng] Workload: /home/SimEng/myStaticBinary.elf 
+[SimEng] Config file: /home/SimEng/configs/a64fx.yaml 
+[SimEng] ISA: AArch64
+[SimEng] Auto-generated Special File directory: True 
+[SimEng] Special File directory used: /home/SimEng/build/specialFiles/ 
+[SimEng] Number of Cores: 1 
+[SimEng] Starting...
+
+
+[SimEng:ExceptionHandler] Encountered execution not-yet-implemented exception
+[SimEng:ExceptionHandler]   Generated by instruction:
+[SimEng:ExceptionHandler]     0x0000000000402dc8: 1d 00 80 d2     mov x29, #0
+[SimEng:ExceptionHandler]       opcode ID: 3680
+[SimEng:Core] Halting due to fatal exception
+``` 

.github/actions/select_setup/action.yml

@@ -0,0 +1,113 @@
+name: Setup compiler and OS combo
+description: installs dependencies and correct compiler/OS versions to build and test simeng
+
+##############################################################################
+# Calls the correct setup action based on parameters passed into this action.
+##############################################################################
+
+inputs:
+  OS:
+    required: true
+  COMPILER:
+    required: true
+  MODE:
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    ##########################################
+    # GCC jobs
+    ##########################################
+
+    # ubuntu
+    - if: ${{ contains( inputs.COMPILER, 'gcc') && contains( inputs.OS, 'ubuntu') }}
+      name:  Install ${{ inputs.COMPILER }} + Build SimEng
+      uses: ./.github/actions/setup_gcc_ubuntu
+      with:
+        OS: ${{ inputs.OS }}
+        gcc-version: ${{ inputs.COMPILER }}
+        MODE: ${{ inputs.mode }}
+
+    # rocky linux
+    - if: ${{ contains( inputs.COMPILER, 'gcc') && contains( inputs.OS, 'rocky') }}
+      name:  Install ${{ inputs.COMPILER }} + Build SimEng
+      uses: ./.github/actions/setup_gcc_rocky
+      with:
+        OS: ${{ inputs.OS }}
+        gcc-version: ${{ inputs.COMPILER }}
+        MODE: ${{ inputs.mode }}
+
+    # red hat
+    - if: ${{ contains( inputs.COMPILER, 'gcc') && contains( inputs.OS, 'redhat') }}
+      name:  Install ${{ inputs.COMPILER }} + Build SimEng
+      uses: ./.github/actions/setup_gcc_redhat
+      with:
+        OS: ${{ inputs.OS }}
+        gcc-version: ${{ inputs.COMPILER }}
+        MODE: ${{ inputs.mode }}
+
+    # debian
+    - if: ${{ contains( inputs.COMPILER, 'gcc') && contains( inputs.OS, 'debian') }}
+      name:  Install ${{ inputs.COMPILER }} + Build SimEng
+      uses: ./.github/actions/setup_gcc_debian
+      with:
+        OS: ${{ inputs.OS }}
+        gcc-version: ${{ inputs.COMPILER }}
+        MODE: ${{ inputs.mode }}
+
+    # macos
+    - if: ${{ contains( inputs.COMPILER, 'gcc') && contains( inputs.OS, 'macos') }}
+      name:  Install ${{ inputs.COMPILER }} + Build SimEng
+      uses: ./.github/actions/setup_gcc_macos
+      with:
+        OS: ${{ inputs.OS }}
+        gcc-version: ${{ inputs.COMPILER }}
+        MODE: ${{ inputs.mode }}
+
+    ##########################################
+    # APPLE CLANG
+    ##########################################
+
+    - if: ${{ contains( inputs.COMPILER, 'clang') && contains( inputs.OS, 'macos') }}
+      name:  Install ${{ inputs.COMPILER }} + Build SimEng
+      uses: ./.github/actions/setup_clang_macos
+      with:
+        OS: ${{ inputs.OS }}
+        MODE: ${{ inputs.mode }}
+
+    ##########################################
+    # ARM CLANG
+    ##########################################
+
+    # ubuntu
+    - if: ${{ contains( inputs.COMPILER, 'armclang') && contains( inputs.OS, 'ubuntu') }}
+      name:  Install ${{ inputs.COMPILER }} + Build SimEng
+      uses: ./.github/actions/setup_armclang_ubuntu
+      with:
+        OS: ${{ inputs.OS }}
+        MODE: ${{ inputs.mode }}
+
+    # debian
+    - if: ${{ contains( inputs.COMPILER, 'armclang') && contains( inputs.OS, 'debian') }}
+      name:  Install ${{ inputs.COMPILER }} + Build SimEng
+      uses: ./.github/actions/setup_armclang_debian
+      with:
+        OS: ${{ inputs.OS }}
+        MODE: ${{ inputs.mode }}
+
+    # redhat
+    - if: ${{ contains( inputs.COMPILER, 'armclang') && contains( inputs.OS, 'redhat') }}
+      name:  Install ${{ inputs.COMPILER }} + Build SimEng
+      uses: ./.github/actions/setup_armclang_redhat
+      with:
+        OS: ${{ inputs.OS }}
+        MODE: ${{ inputs.mode }}
+
+    # rocky
+    - if: ${{ contains( inputs.COMPILER, 'armclang') && contains( inputs.OS, 'rocky') }}
+      name:  Install ${{ inputs.COMPILER }} + Build SimEng
+      uses: ./.github/actions/setup_armclang_rocky
+      with:
+        OS: ${{ inputs.OS }}
+        MODE: ${{ inputs.mode }}

.github/actions/setup_armclang_debian/action.yml

@@ -0,0 +1,95 @@
+name: setup armclang
+description: installs dependencies and correct armclang version to build and test simeng
+
+inputs:
+  OS:
+    description: docker image name
+    required: true
+  MODE:
+    description: simeng-mode e.g. Release or Debug
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    #######################################
+    # Install dependencies required (cmake, etc).
+    #######################################
+    - name: Install dependencies
+      shell: bash
+      run: |
+        export DEBIAN_FRONTEND=noninteractive
+
+        # Update package lists
+        apt-get update
+
+        # Install essential packages
+        apt-get install -y \
+          python3-launchpadlib \
+          software-properties-common \
+          build-essential \
+          sudo \
+          wget \
+          zlib1g-dev \
+          python3 \
+          build-essential \
+          libssl-dev \
+          ninja-build \
+          tree \
+          git
+
+        # add pyparsing for benchmarking
+        apt-get install -y python3-pip
+        pip3 install pyparsing
+
+        apt-get update
+        apt-get upgrade -y
+
+    #######################################
+    # Install Cmake
+    #######################################
+    - name: Install Cmake via apt
+      shell: bash
+      run: |
+        wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | gpg --dearmor - | tee /etc/apt/trusted.gpg.d/kitware.gpg >/dev/null && \
+        apt-add-repository 'deb https://apt.kitware.com/ubuntu/ bionic main' && \
+        apt update && apt install cmake -y
+        apt upgrade -y
+
+    #######################################
+    # Install ArmClang
+    #######################################
+    - name: Install armclang
+      shell: bash
+      run: |
+        apt-get update
+        apt-get upgrade -y
+        apt-get install environment-modules
+        source /etc/profile.d/modules.sh
+
+        wget https://developer.arm.com/-/cdn-downloads/permalink/Arm-Compiler-for-Linux/Version_24.04/arm-compiler-for-linux_24.04_Ubuntu-22.04_aarch64.tar
+        tar -xf arm-compiler-for-linux_24.04_Ubuntu-22.04_aarch64.tar
+
+        ./arm-compiler-for-linux_24.04_Ubuntu-20.04/arm-compiler-for-linux_24.04_Ubuntu-20.04.sh --install-to ./armclang_compiler
+        export MODULEPATH=$MODULEPATH:$(pwd)/armclang_compiler/modulefiles
+
+        module avail
+        module load acfl/24.04
+        armclang -v
+
+        echo "C_COMPILER=$(which armclang)" >> $GITHUB_ENV
+        echo "CPP_COMPILER=$(which armclang++)" >> $GITHUB_ENV
+
+    #######################################
+    # Build SimEng
+    #######################################
+    - name: Build SimEng
+      shell: bash
+      run: |
+        cmake -B build -S . -DCMAKE_BUILD_TYPE=${{ inputs.MODE }} -DSIMENG_ENABLE_TESTS=ON -DSIMENG_OPTIMIZE=ON -DCMAKE_C_COMPILER=${{ env.C_COMPILER }} -DCMAKE_CXX_COMPILER=${{ env.CPP_COMPILER }}
+
+        cmake --build build -j $(nproc)
+
+        cmake --build build --target install
+
+