Add spike-stf and stf_tools to the Dockerfile

Author: Jatin-exe

traces/docker_stf_trace_gen/Dockerfile

@@ -1,29 +1,97 @@
-FROM ubuntu:22.04
+FROM ubuntu:24.04
 
-RUN apt-get update
-RUN apt-get install -y device-tree-compiler libboost-regex-dev libboost-system-dev git binutils build-essential cmake gcc-riscv64-linux-gnu zstd libzstd-dev autoconf automake autotools-dev curl python3 python3-pip python3-tomli libmpc-dev libmpfr-dev libgmp-dev gawk build-essential bison flex texinfo gperf libtool patchutils bc zlib1g-dev libexpat-dev ninja-build git cmake libglib2.0-dev libslirp-dev
+# Combine apt-get commands and clean up to reduce image size
+RUN apt-get update && apt-get install -y \
+    device-tree-compiler \
+    libboost-regex-dev \
+    libboost-system-dev \
+    libboost-program-options-dev \
+    libboost-json-dev \
+    rapidjson-dev \
+    libhdf5-dev \
+    liblzma-dev \
+    libbz2-dev \
+    cython3 \
+    git \
+    binutils \
+    build-essential \
+    cmake \
+    gcc-riscv64-linux-gnu \
+    zstd \
+    libzstd-dev \
+    autoconf \
+    automake \
+    autotools-dev \
+    curl \
+    python3 \
+    python3-pip \
+    python3-tomli \
+    libmpc-dev \
+    libmpfr-dev \
+    libgmp-dev \
+    gawk \
+    bison \
+    flex \
+    texinfo \
+    gperf \
+    libtool \
+    patchutils \
+    bc \
+    zlib1g-dev \
+    libexpat-dev \
+    ninja-build \
+    libglib2.0-dev \
+    libslirp-dev \
+    wget \
+    && rm -rf /var/lib/apt/lists/*
 
-RUN mkdir  riscv
+# Set up RISCV environment
 ENV RISCV=/riscv
-ENV PATH=$RISCV/bin:$PATH
-
-RUN git clone https://github.com/jeffnye-gh/riscv-isa-sim.git
-RUN git clone https://github.com/riscv-software-src/riscv-pk.git
-RUN git clone https://github.com/riscv-collab/riscv-gnu-toolchain.git
-
-WORKDIR /riscv-gnu-toolchain
-RUN ./configure --prefix=/opt/riscv
-ENV PATH=/opt/riscv/bin:$PATH
-RUN make -j$(nproc)
-
-WORKDIR /riscv-pk/build
-RUN ../configure --prefix=$RISCV --host=riscv64-unknown-elf
-RUN make  -j$(nproc)
-RUN make install
-
-WORKDIR /riscv-isa-sim/build
-RUN git checkout spike_stf
-RUN git submodule update --init --recursive
-RUN ../configure --prefix=$RISCV
-RUN make -j$(nproc)
-RUN make install
+ENV PATH=$RISCV/bin:/opt/riscv/bin:$PATH
+RUN mkdir -p $RISCV
+
+# Using HTTP instead of SSH to avoid setting git credentials
+RUN git config --global url."https://github.com/".insteadOf "git@github.com:"
+
+# Generic config details required during the cloning (git am, apply,patch done during the toolchain build process)
+RUN git config --global user.email "builder@example.com" && \
+    git config --global user.name "Docker Builder"
+
+
+# Clone repositories
+WORKDIR $RISCV
+RUN git clone https://github.com/condorcomputing/condor.riscv-isa-sim.git --recurse-submodules || exit 1
+RUN git clone https://github.com/sparcians/stf_tools || exit 1
+RUN git clone https://github.com/riscv-software-src/riscv-pk.git || exit 1
+RUN git clone https://github.com/riscv-collab/riscv-gnu-toolchain.git || exit 1
+
+# Build riscv-gnu-toolchain
+WORKDIR $RISCV/riscv-gnu-toolchain
+RUN ./configure --prefix=/opt/riscv && make -j$(nproc) && make install
+
+# Build riscv-pk
+WORKDIR $RISCV/riscv-pk/build
+RUN ../configure --prefix=$RISCV --host=riscv64-unknown-elf && make -j$(nproc) && make install
+
+# Build stf_tools
+WORKDIR $RISCV/stf_tools
+RUN git submodule update --init --recursive || exit 1
+WORKDIR $RISCV/stf_tools/release
+RUN cmake .. -DCMAKE_BUILD_TYPE=Release && make -j$(nproc)
+
+# Build condor.riscv-isa-sim
+WORKDIR $RISCV/condor.riscv-isa-sim
+RUN bash scripts/download-bm-compiler.sh && \
+    COMPILER_DIR=$(find . -maxdepth 1 -type d -name "riscv-embecosm-*" | head -n 1) && \
+    [ -n "$COMPILER_DIR" ] || (echo "Error: riscv-embecosm-* directory not found!" && exit 1) && \
+    export PATH=$(pwd)/$COMPILER_DIR/bin:$PATH && \
+    echo "export PATH=/riscv/condor.riscv-isa-sim/$COMPILER_DIR/bin:\$PATH" >> /root/.bashrc && \
+    mkdir -p build && cd build && \
+    ../configure --prefix=$RISCV/condor.riscv-isa-sim/install && \
+    make -j$(nproc) && \
+    make regress && \
+    make install
+
+# shell
+CMD ["/bin/bash"]
+

traces/docker_stf_trace_gen/README.md

@@ -24,7 +24,7 @@ This setup provides a containerized workflow to generate STF traces using Spike-
 
 ```bash
 qemu-simpoint-dhrystone/
-├── Dockerfile               # Creates a Docker image with the RISC-V GNU toolchain, pk, and Spike-STF
+├── Dockerfile               # Creates a Docker image with the RISC-V GNU toolchain, pk, stf_tools and Spike-STF
 ├── run_in_docker.sh         # Runs an STF trace generation example inside the container
 ├── build_docker.sh          # Builds the Docker image
 ├── build_and_run.sh         # Executes both build_docker and run_in_docker scripts
@@ -51,9 +51,9 @@ docker build -t spike-stf .
 mkdir -p trace_output
 
 docker run --rm \
-  -v ./trace_output:/output \
-  spike-stf \
+  -v "$OUTPUT_DIR":/riscv/condor.riscv-isa-sim/trace_out \
+  "$IMAGE_NAME" \
   bash -c "
-    echo '<REPLACE THIS ECHO COMMAND WITH SPIKE STF TRACE GENERATION COMMAND>' >> /output/EXAMPLE.zstf
+     bash scripts/run-spike-stf.sh $BINARY_NAME $TRACEOUT_NAME
   "
 ```

traces/docker_stf_trace_gen/run_in_docker.sh

@@ -5,11 +5,15 @@ set -e
 IMAGE_NAME="spike-stf"
 OUTPUT_DIR="$(pwd)/trace_output"
 
+# The binary to run on spike (bare-metal)
+BINARY_NAME="dhrystone/bin/dhrystone_opt1.1000.gcc.bare.riscv" 
+TRACEOUT_NAME="trace_output.zstf"
+
 mkdir -p "$OUTPUT_DIR"
 
 docker run --rm \
-  -v "$OUTPUT_DIR":/output \
+  -v "$OUTPUT_DIR":/riscv/condor.riscv-isa-sim/trace_out \
   "$IMAGE_NAME" \
   bash -c "
-    echo '<REPLACE THIS ECHO COMMAND WITH SPIKE STF TRACE GENERATION COMMAND>' >> /output/EXAMPLE.zstf
-  "
+     bash scripts/run-spike-stf.sh $BINARY_NAME $TRACEOUT_NAME
+  "