Update devcontainer v24 0

.devcontainer/devcontainer.json

@@ -1,17 +1,38 @@
 {
+    "name": "gem5 Development Container",
+    "image": "ghcr.io/gem5/devcontainer:v24-0",
     "hostRequirements": {
-        "cpus": 16,
+        "cpus": 1,
         "memory": "8gb",
-        "storage": "32gb"
+        "storage": "64gb"
+     },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "GitHub.copilot",
+                "GitHub.copilot-chat",
+                "GitHub.vscode-pull-request-github",
+                "ms-python.debugpy",
+                "ms-python.isort",
+                "ms-python.python",
+                "ms-python.vscode-pylance",
+                "ms-vscode.cpptools",
+                "ms-vscode.cpptools-extension-pack",
+                "ms-vscode.cpptools-themes",
+                "ms-vscode.makefile-tools",
+                "Tsinghua-Hexin-Joint-Institute.gem5-slicc",
+                "ms-python.black-formatter",
+                "marp-team.marp-vscode",
+                "hediet.vscode-drawio"
+            ]
+        }
     },
-    "build": { "dockerfile": "Dockerfile" },
-    "onCreateCommand" : "bash ./.devcontainer/on_create.sh",
-    "runArgs": ["--privileged", "-v", "/var/run/docker.sock:/var/run/docker.sock", "--security-opt", "seccomp=unconfined"],
-	"extensions": [
-		"ms-vscode.cpptools",
-		"streetsidesoftware.code-spell-checker",
-		"eamodio.gitlens",
-		"ms-python.vscode-pylance",
-		"ms-python.python"
-	]
+    "features": {
+        "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+        "ghcr.io/devcontainers/features/github-cli:1": {},
+        "ghcr.io/devcontainers-contrib/features/actionlint:1": {},
+        "ghcr.io/devcontainers-contrib/features/vscode-cli:1": {}
+    },
+    "onCreateCommand": "./.devcontainer/on_create.sh",
+    "postStartCommand": "./.devcontainer/post_start.sh"
 }

.devcontainer/on_create.sh

@@ -3,19 +3,30 @@
 # Update the submodules
 git submodule update --init --recursive
 
-# Create the stubs
-gem5-arm gem5_stubgen.py
-gem5-x86 gem5_stubgen.py
-gem5-riscv gem5_stubgen.py
-
-mv out typings
-
 # Setups the gem5 source directory
-cd gem5
+pushd gem5
 
 ## We cleanup git's 'blame' feature by ignoring certain commits (typically
 ## commits that have reformatted files)
 git config --global blame.ignoreRevsFile .git-blame-ignore-revs
 
 ## `git pull` should rebase by default
 git config --global pull.rebase true
+
+./util/pre-commit-install.sh
+
+popd # gem5
+
+# Pre-download the resources we use
+
+gem5 pre-download-resources.py
+
+docker pull ghcr.io/gem5/gcn-gpu:v24-0
+
+wget http://dist.gem5.org/dist/v24-0/test-progs/square/square
+
+wget https://storage.googleapis.com/dist.gem5.org/dist/v24-0/gpu-fs/kernel/vmlinux-gpu-ml-isca
+
+# Note: this unzips to 55 GB so must in on /tmp.
+# See post_start.sh where it is unzipped each time the devcontainer starts
+wget https://storage.googleapis.com/dist.gem5.org/dist/v24-0/gpu-fs/diskimage/x86-ubuntu-gpu-ml-isca.gz

.devcontainer/post_start.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+if [ ! -f /tmp/x86-ubuntu-gpu-ml-isca ]; then
+  cp x86-ubuntu-gpu-ml-isca.gz /tmp
+  gunzip /tmp/x86-ubuntu-gpu-ml-isca.gz
+fi
+
+ln -s /tmp/x86-ubuntu-gpu-ml-isca .

.gitignore

@@ -1,5 +1,6 @@
 # Ignore all m5out directories and build directories
 **/m5out/
+**/checkpoint/
 
 # Jekyll stuff
 _site/
@@ -12,3 +13,13 @@ typings/
 .vscode/*.log
 
 __pycache__
+
+# Ignore downloaded files
+square
+vmlinux-gpu-ml-isca
+x86-ubuntu-gpu-ml-isca
+x86-ubuntu-gpu-ml-isca.gz
+
+# Ignore slides
+*.pdf
+*.html

.gitmodules

@@ -1,6 +1,6 @@
 [submodule "gem5"]
 	path = gem5
-	url = https://gem5.googlesource.com/public/gem5
+	url = https://github.com/gem5/gem5
 [submodule "gem5-resources"]
 	path = gem5-resources
-	url = https://gem5.googlesource.com/public/gem5-resources
+	url = https://github.com/gem5/gem5-resources

.vscode/settings.json

@@ -1,12 +1,17 @@
 {
-    "python.formatting.provider": "black",
-    "python.analysis.stubPath": "typings",
     "python.analysis.extraPaths": ["gem5/src/python"],
-    "python.formatting.blackArgs": [
-        "--line-length",
-        "79"
-    ],
     "editor.rulers": [
         79
-    ]
+    ],
+    "files.trimTrailingWhitespace": true,
+    "files.insertFinalNewline": true,
+    "markdown.marp.themes": [
+        "slides/themes/gem5.css"
+    ],
+    "markdown.marp.enableHtml": true,
+    "hediet.vscode-drawio.globalVars": {
+         "pageScale": "1",
+         "pageWidth": "1160",
+         "pageHeight": "440"
+    }
 }

README.md

@@ -1,38 +1,43 @@
+# gem5 bootcamp environment
+
 This repository has been designed for use in gem5 tutorials.
+
 It has been built with the assumption users will utilize [Codespaces](https://github.com/features/codespaces) to learn gem5.
 
 The repository contains the following directories:
 
 * [docker](docker) :
-The source code for the Docker image used by [.devcontainer/Dockerfile](.devcontainer/Dockerfile) to create the Codespace Docker container.
+The source code for the Docker image used by the [Dockerfile](gem5/util/dockerfiles/devcontainer/Dockerfile) to create the Codespace Docker container.
 * gem5 :
-v22.0.0.1 of gem5.
+v24.0.0.0 of gem5.
 * gem5-resources :
-gem5-resources which may be used with v22.0 of gem5.
+gem5-resources which may be used with v24.0 of gem5.
 * materials: Example materials used as part of the tutorial.
-* modules: Source for the accompying website: https://gem5bootcamp.github.io/gem5-bootcamp-env
+* modules: Source for the accompanying website: <https://gem5bootcamp.github.io/gem5-bootcamp-env> (This link is not up to date.)
 The website contains links to slides, presentation videos, and notes for the tutorials.
 
-**Note:** 'gem5' and 'gem5-resources' are submodules though the [.devcontainer/devcontainer.json](.devcontainer/devcontainer.json) file specifies that a `git module update --init --recursive` command is executed when the Codespace Docker container is created.
+**Note:** 'gem5' and 'gem5-resources' are submodules though the [.devcontainer/devcontainer.json](.devcontainer/devcontainer.json) file specifies that a `git submodule update --init --recursive` command is executed when the Codespace Docker container is created.
 
-The container used by Codespaces is built from [.devcontainer/Dockerfile](.devcontainer/Dockerfile).
+The container used by Codespaces is built from [Dockerfile](gem5/util/dockerfiles/devcontainer/Dockerfile).
 It contains:
 
 * All gem5 dependencies (inc. optional dependencies).
 * Prebuilt gem5 binaries:
-    - `/usr/local/bin/gem5-x86`
-    - `/usr/local/bin/gem5-arm`
-    - `/usr/local/bin/gem5-riscv`
+  * `/usr/local/bin/gem5` (gem5 ALL ISAs with CHI protocol)
+  * `/usr/local/bin/gem5-default` (default gem5 ALL build with MESI_Two_Level)
+  * `/usr/local/bin/gem5-vega` (x86-only with GPU protocol)
+  * `/usr/local/bin/gem5-vega-se` (same as above, but compiled with 20.04)
 * A RISCV64 and an AARCH64 GNU cross-compiler:
-    * RISCV64 GNU cross-compiler found in `/opt/cross-compiler/riscv64-linux/`.
-    * AARCH64 GNU cross-compiler found in `/opt/cross-compiler/aarch64-linux/`.
+  * RISCV64 GNU cross-compiler found in `/opt/cross-compiler/riscv64-linux/`.
+  * AARCH64 GNU cross-compiler found in `/opt/cross-compiler/aarch64-linux/`.
+* ROCm development environment 6.1.2 (note, this is why the container is based on 22.04 instead of 24.04)
 
 ## Beginners' example
 
 The following can be used within the Codespace container to run a basic gem5 simulation straight away:
 
 ```
-gem5-arm gem5/configs/example/gem5_library/arm-hello.py
+gem5 gem5/configs/example/gem5_library/arm-hello.py
 ```
 
 This will execute a "Hello world!" program inside a simulated ARM system.
@@ -41,12 +46,13 @@ This will execute a "Hello world!" program inside a simulated ARM system.
 
 In this project we have two submodules: 'gem5' and 'gem5-resources'.
 These are automatically obtained when the codespaces is initialized.
-At the time of writing the 'gem5' directory is checked out to the stable branch at v22.0.0.1.
-The 'gem5-resources' repository is checkoued out to revision '871e715', which should contain resources with known compatibility with gem5 v22.0.
+At the time of writing the 'gem5' directory is checked out to the stable branch at v24.0.0.0.
+The 'gem5-resources' repository is checked out to revision '97532302', which should contain resources with known compatibility with gem5 v24.0.
 
-To update the git submodules to be in-sync with their remote origins (that hosted on our [googlesource](https://gem5.googlesource.com)), execute the following command:
+To update the git submodules to be in-sync with their remote origins (that hosted on our [GitHub](https://github.com/gem5/gem5)), execute the following command:
 
 ```sh
+git submodule sync   # Only needed if submodule remotes changed
 git submodule update --remote
 ```
 
@@ -58,7 +64,7 @@ git commit -m "git submodules updated"
 git push
 ```
 
-## Best practises
+## Best practices
 
 ### Using branches
 
@@ -83,7 +89,7 @@ git branch example-1 # Creating a new branch named 'example-1'.
 3. Checkout this branch:
 
 ```sh
-git checkout example-`
+git checkout example-1
 ```
 
 4. Make changes on this branch and commit the changes.
@@ -113,3 +119,12 @@ To see a list of all available branches you can execute:
 ```sh
 git branch
 ```
+
+## Note on running GPU SE
+
+You can use docker.
+Below is an example command
+
+```sh
+docker run -v $PWD:$PWD -v /usr/local/bin:/usr/local/bin -w $PWD ghcr.io/gem5/gcn-gpu:v24-0 gem5-vega-se gem5/configs/example/apu_se.py -n 3 -c square
+```

_data/course.yml

@@ -1,3 +1,3 @@
-title: "gem5 Bootcamp 2022"
-description: "gem5 Bootcamp Summer 2022 at UC Davis offered by the Davis Computer Architecture Research Group"
+title: "gem5 Bootcamp"
+description: "gem5 Bootcamp Summer 2024 at UC Davis offered by the Davis Computer Architecture Research Group"
 modules: ["Introduction", "Using gem5", "Developing gem5 models", "Extra topics"]