Fix GitHub workflows

Switching to Clang with commit 66bff8e ("Convert object_defs.py
to auto-generated file") caused the GitHub build/release workflows
to stop working due to the new requirements for Clang, LLVM, and
the Clang Python bindings.

Fixing this requires adding new GitHub actions to install LLVM and
Clang, configure the build environment and make some code changes
to allow for emulator to compile cleanly.

Author: voidtrance

.github/workflows/build-arm.yml

@@ -44,6 +44,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.13'
+          cache: 'pip'
       - name: Get Version
         id: vortex-version
         run: echo "vortex-version=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT
@@ -56,12 +57,21 @@ jobs:
           sudo apt install -y meson libgirepository-2.0-dev libcairo2-dev
           python -m pip install --upgrade pip setuptools wheel flake8 meson
           pip install -r virtualenv.txt
-#      - name: Lint with flake8
-#        run: |
-#          # stop the build if there are Python syntax errors or undefined names
-#          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-#          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-#          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Install LLVM and Clang
+        uses: KyleMayes/install-llvm-action@v2
+        with:
+          version: "21.1.8"
+          env: 1
+      - name: Install Python Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install clang clang-format
+      - name: Setup Environment
+        run: |
+          echo CLANG_INCLUDE_PATH=$(llvm-config --includedir) >> $GITHUB_ENV
+          echo LIBRARY_PATH=$(llvm-config --libdir) >> $GITHUB_ENV
+          echo LLVM_CFLAGS=$(llvm-config --cflags) >> $GITHUB_ENV
+          echo CC=clang >> $GITHUB_ENV
       - name: Build emulator ${{ steps.vortex-version.outputs.vortex-version }}
         run: make package
       - name: Upload asset

.github/workflows/build-x64.yml

@@ -44,6 +44,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.13'
+          cache: 'pip'
       - name: Get Version
         id: vortex-version
         run: echo "vortex-version=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT
@@ -56,12 +57,21 @@ jobs:
           sudo apt install -y meson libgirepository-2.0-dev libcairo2-dev
           python -m pip install --upgrade pip setuptools wheel flake8 meson
           pip install -r virtualenv.txt
-#      - name: Lint with flake8
-#        run: |
-#          # stop the build if there are Python syntax errors or undefined names
-#          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-#          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-#          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Install LLVM and Clang
+        uses: KyleMayes/install-llvm-action@v2
+        with:
+          version: "21.1.8"
+          env: 1
+      - name: Install Python Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install clang clang-format
+      - name: Setup Environment
+        run: |
+          echo CLANG_INCLUDE_PATH=$(llvm-config --includedir) >> $GITHUB_ENV
+          echo LIBRARY_PATH=$(llvm-config --libdir) >> $GITHUB_ENV
+          echo LLVM_CFLAGS=$(llvm-config --cflags) >> $GITHUB_ENV
+          echo CC=clang >> $GITHUB_ENV
       - name: Build emulator ${{ steps.vortex-version.outputs.vortex-version }}
         run: make package
       - name: Upload asset

Makefile

@@ -24,25 +24,40 @@ VENV ?=
 VENV_PYTHON := $(VENV)/bin/python3
 DEBUG_OPTS :=
 MESON_DEBUG_OPTS :=
-GCC_BUILD_OPTS :=
 VERSION=$(shell git describe --tags --abbrev=0)
 KVER := $(shell uname -r)
 ARCH := $(shell uname -m)
 
 PYTHON_VERSION=$(shell $(PYTHON) -c "import platform; print(platform.python_version())")
 PYTHON_VERSION_NUMS = $(subst ., ,$(PYTHON_VERSION))
 
+# Setup Clang
+CLANG_INCLUDE_DIR=$(shell llvm-config --includedir)
+CLANG_LIB_DIR=$(shell llvm-config --libdir)
+LIBRARY_PATH=$(shell llvm-config --libdir)
+CC=clang
+LD_LIBRATY_PATH += $(shell llvm-config --libdir)
+CFLAGS += $(shell llvm-config --cflags)
+LDFLAGS += -L$(shell llvm-config --libdir)
+
 ifeq ($(DEBUG),1)
-	GCC_BUILD_OPTS=CFLAGS='-DVORTEX_DEBUG -g
+	CFLAGS += -DVORTEX_DEBUG -g
 	ifeq ($(TIMER_DEBUG),1)
-		GCC_BUILD_TOPS += -DVORTEX_TIMERS_DEBUG
+		CFLAGS += -DVORTEX_TIMERS_DEBUG
 	endif
-	GCC_BUILD_OPTS += '
 	MESON_BUILD_OPTS=--config-settings=setup-args="-Dbuildtype=debug"
 endif
 
+export CC
+export CFLAGS
+export LDFLAGS
+export CLANG_INCLUDE_DIR
+export CLANG_LIB_DIR
+export LIBRARY_PATH
+export LD_LIBRARY_PATH
+
 all: version
-	CC=clang $(GCC_BUILD_OPTS) $(PYTHON) -m pip install --no-build-isolation \
+	$(PYTHON) -m pip install --no-build-isolation \
 		--editable . $(MESON_BUILD_OPTS)
 	@if [ ! -L compile_commands.json ]; then \
 		ln -s build/cp$(word 1,$(PYTHON_VERSION_NUMS))$(word 2,$(PYTHON_VERSION_NUMS))/compile_commands.json \
@@ -78,7 +93,7 @@ venv:
 	$(VENV)/bin/pip install -r ./virtualenv.txt
 
 wheel: venv version
-	CC=clang $(VENV_PYTHON) -m build -w .
+	$(VENV_PYTHON) -m build -w .
 
 package: version
 	$(PYTHON) -m build -w .

src/core/mem_debug.c

@@ -15,7 +15,9 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#define _GNU_SOURCE
+#ifndef _GNU_SOURCE
+#define _GNU_SOURCE 1
+#endif
 #include <stdio.h>
 #include <dlfcn.h>
 #include <stdbool.h>

src/core/objects/axis.c

@@ -15,7 +15,9 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#define _GNU_SOURCE
+#ifndef _GNU_SOURCE
+#define _GNU_SOURCE 1
+#endif
 #include <stdint.h>
 #include <string.h>
 #include <stdbool.h>

src/lib/logging/logging.c

@@ -15,7 +15,9 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#define _GNU_SOURCE
+#ifndef _GNU_SOURCE
+#define _GNU_SOURCE 1
+#endif
 #include <stdio.h>
 #include <stddef.h>
 #include <stdint.h>

src/lib/random.c

@@ -15,7 +15,9 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#define _GNU_SOURCE
+#ifndef _GNU_SOURCE
+#define _GNU_SOURCE 1
+#endif
 #include <pthread.h>
 #include <stdlib.h>
 #include <values.h>

src/threads/core_threads.c

@@ -15,7 +15,9 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#define _GNU_SOURCE
+#ifndef _GNU_SOURCE
+#define _GNU_SOURCE 1
+#endif
 #include <errno.h>
 #include <pthread.h>
 #include <stdlib.h>

tools/clang_ast/clang_ast_builder.py

@@ -18,7 +18,8 @@
 import os
 
 def get_clang_cursor_kind_defs():
-    filename = "/usr/include/clang-c/Index.h"
+    include_path = os.environ.get("CLANG_INCLUDE_PATH", "/usr/include")
+    filename = os.path.join(include_path, "clang-c/Index.h")
     enum_found = False
     defs = ["enum CursorKind {"]
     enum_values = {}
@@ -50,7 +51,8 @@ def get_clang_cursor_kind_defs():
     return defs
 
 def get_clang_type_kind_defs():
-    filename = "/usr/include/clang-c/Index.h"
+    include_path = os.environ.get("CLANG_INCLUDE_PATH", "/usr/include")
+    filename = os.path.join(include_path, "clang-c/Index.h")
     enum_found = False
     defs = ["enum TypeKind {"]
     enum_values = {}

tools/find_modules.py

@@ -21,6 +21,9 @@
 
 def find_hw_objects(source_dir):
     object_dir = pathlib.PosixPath(source_dir)
+    libdir = os.environ.get("CLANG_LIB_DIR")
+    if libdir:
+        cindex.Config.set_library_path(libdir)
     index = cindex.Index.create()
     objects = []
     for file in object_dir.iterdir():