Merging in fixes for running in devcontainer to Derek's changes to setup to fix smoke test.

Author: james-ball-qualcomm

.gitignore

@@ -11,6 +11,7 @@
 diag-ditaa-*
 arch/manual/isa/**/riscv-isa-manual
 gen
+gen.*
 node_modules
 _site
 images

bin/build_container

@@ -9,6 +9,11 @@ if [ -v GITHUB_ACTIONS ]; then
   CONTAINER_PATH=${ROOT}/.singularity/image.sif
   HOME_PATH=${GITHUB_WORKSPACE}
   SINGULARITY_CACHE=--disable-cache
+
+  # needed to get singularity working on Ubuntu 24.04
+  # see https://github.com/lima-vm/lima/issues/2319
+  sudo /bin/bash -c "echo \"kernel.apparmor_restrict_unprivileged_userns = 0\" >/etc/sysctl.d/99-userns.conf"
+  sudo sysctl --system
 else
   CONTAINER_PATH=${ROOT}/.singularity/image-$CONTAINER_TAG.sif
   HOME_PATH=${HOME}

bin/setup

@@ -22,17 +22,17 @@ CONTAINER_TAG=`cat ${ROOT}/bin/.container-tag`
 # An apptainer/singularity container. All commands on the host (using ./do or ./bin/*) are run in the context of an Apptainer/Singularity image.
 #
 #
-# ALL THREE CONTAINERS ARE IDENTICAL. Which one you use is a preference of your setup and installed
+# ALL THREE CONTAINERS ARE (in theory) IDENTICAL. Which one you use is a preference of your setup and installed
 # software.
 
 
 # get the container type
 #
 # use, in priority order:
-#  1. devcontainer, if DEVCONTAINER_ENV is set in the enviornment
+#  1. devcontainer, if DEVCONTAINER_ENV is set in the environment
 #  2. the type stored in .container-type
-#  3. Docker, if DOCKER is set in the enviornment
-#  4. Singularity, if SINGULARITY is set in the enviornment
+#  3. Docker, if DOCKER is set in the environment
+#  4. Singularity, if SINGULARITY is set in the environment
 #  5. The choice made by the user, which will be cached in .container-type
 if [ -v DEVCONTAINER_ENV ]; then
 CONTAINER_TYPE=devcontainer
@@ -56,7 +56,7 @@ else
 fi
 
 if [ "${CONTAINER_TYPE}" != "docker" -a "${CONTAINER_TYPE}" != "singularity" -a "${CONTAINER_TYPE}" != "devcontainer" ]; then
-  echo "BAD CONTAINER TYPE: ${CONTAINER_TYPE}"
+  echo "BAD CONTAINER TYPE: ${CONTAINER_TYPE}" 1>&2
   exit 1
 fi
 
@@ -72,19 +72,25 @@ print_env() {
     elif [ "${CONTAINER_TYPE}" == "devcontainer" ]; then
         echo "Using devcontainer environment"
     else
-        echo "Unknown container type of ${CONTAINER_TYPE}"
+        echo "Unknown container type of ${CONTAINER_TYPE}" 1>&2
         exit 1
     fi
 }
 
+print_env
+
 if [ -v GITHUB_ACTIONS ]; then
-    echo "ACTIONS"
+    echo "Running in a GitHub Action"
     CONTAINER_PATH=${ROOT}/.singularity/image.sif
     HOME_PATH=${GITHUB_WORKSPACE}
     HOME_OPT="--home ${ROOT}/.home"
     SINGULARITY_CACHE=--disable-cache
+
+    # needed to get singularity working on Ubuntu 24.04
+    # see https://github.com/lima-vm/lima/issues/2319
+    sudo /bin/bash -c "echo \"kernel.apparmor_restrict_unprivileged_userns = 0\" >/etc/sysctl.d/99-userns.conf"
+    sudo sysctl --system
 elif [ "${CONTAINER_TYPE}" == "docker" ]; then
-    print_env
     if ! docker images riscvintl/udb:${CONTAINER_TAG} | grep -q udb ; then
         # TODO: pull the image if it can be found
         echo "Building Docker image..."
@@ -97,7 +103,6 @@ elif [ "${CONTAINER_TYPE}" == "docker" ]; then
     fi
     RUN="${DOCKER_BASE}"
 elif [ "${CONTAINER_TYPE}" == "singularity" ]; then
-    print_env
     CONTAINER_PATH=${ROOT}/.singularity/image-$CONTAINER_TAG.sif
     HOME_PATH=${HOME}
     HOME_OPT="--bind ${ROOT}/.home:${HOME_PATH}"
@@ -110,9 +115,9 @@ elif [ "${CONTAINER_TYPE}" == "singularity" ]; then
       singularity pull ${SINGULARITY_CACHE} ${CONTAINER_PATH} oras://docker.io/riscvintl/spec-generator:$CONTAINER_TAG
     fi
 elif [ "${CONTAINER_TYPE}" == "devcontainer" ]; then
-    print_env
+    HOME_PATH=${HOME}
 else
-    echo "Unknown container type of ${CONTAINER_TYPE}"
+    echo "Bad container type: ${CONTAINER_TYPE}" 1>&2
     exit 1
 fi
 
@@ -122,12 +127,15 @@ if [ -f $ROOT/.git ]; then
     HOME_OPT="${HOME_OPT} --bind ${GIT_PATH}:${GIT_PATH}"
 fi
 
-if [ -v DEVCONTAINER_ENV ]; then
+if [ "${CONTAINER_TYPE}" == "devcontainer" ]; then
     RUN=""
 elif [ "${CONTAINER_TYPE}" == "docker" ]; then
     RUN="${DOCKER_BASE}"
-else
+elif [ "${CONTAINER_TYPE}" == "singularity" ]; then
     RUN="singularity run ${HOME_OPT} ${CONTAINER_PATH}"
+else
+    echo "Bad container type: ${CONTAINER_TYPE}" 1>&2
+    exit 1
 fi
 
 if [ ! -d $ROOT/.home ]; then
@@ -175,7 +183,7 @@ if [ ! -d ${ROOT}/node_modules ]; then
     ${RUN} npm i
 fi
 
-if [ -v DEVCONTAINER_ENV ]; then
+if [ "${CONTAINER_TYPE}" == "devcontainer" ]; then
     BUNDLE="bundle"
     RUBY="bundle exec ruby"
     RAKE="bundle exec rake"
@@ -195,7 +203,7 @@ elif [ "${CONTAINER_TYPE}" == "docker" ]; then
     PYTHON="${DOCKER_BASE} ${ROOT}/.home/.venv/bin/python3"
     PIP="${DOCKER_BASE} ${ROOT}/.home/.venv/bin/pip"
     BASH="${DOCKER_BASE} bash"
-else
+elif [ "${CONTAINER_TYPE}" == "singularity" ]; then
     BUNDLE="singularity run ${HOME_OPT} ${CONTAINER_PATH} bundle"
     RUBY="singularity run ${HOME_OPT} ${CONTAINER_PATH} bundle exec ruby"
     RAKE="singularity run ${HOME_OPT} ${CONTAINER_PATH} bundle exec rake"
@@ -205,6 +213,9 @@ else
     PYTHON="singularity run ${HOME_OPT} ${CONTAINER_PATH} ${ROOT}/.home/.venv/bin/python3"
     PIP="singularity run ${HOME_OPT} ${CONTAINER_PATH} ${ROOT}/.home/.venv/bin/pip"
     BASH="singularity run ${HOME_OPT} ${CONTAINER_PATH} bash"
+else
+    echo "Bad container type: ${CONTAINER_TYPE}" 1>&2
+    exit 1
 fi
 
 if [ ! -f $ROOT/.git/hooks/pre-commit ]; then