automation: build python targets in pipeline ci-cd

done using a 2d matrix involving the build type (regular or with python)

.github/workflows/pr-pipeline.yaml

@@ -0,0 +1,25 @@
+name: gdb-static-pr-pipeline
+
+on:
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        build_type: ["build", "build-with-python"]
+        architecture: ["x86_64", "arm", "aarch64", "powerpc", "mips", "mipsel"]
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+
+    - name: Install dependencies
+      run: sudo apt-get install -y wget
+
+    - name: Build
+      run: make ${{ matrix.build_type }}-${{ matrix.architecture }} -j$((`nproc`+1))

.github/workflows/release-pipeline.yaml

@@ -1,19 +1,19 @@
-name: gdb-static-pipeline
+name: gdb-static-release-pipeline
 
 on:
-  pull_request:
-    branches:
-      - '*'
   push:
     tags:
       - 'v*'
 
+# Use a non-parallel single job pipeline because artifacts weigh too much. Instead,
+# simply build the files in the same job they are released.
 jobs:
-  build:
+  build_and_publish:
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v4
+      with:
+        submodules: recursive
 
     - name: Install dependencies
       run: sudo apt-get install -y wget
@@ -24,14 +24,7 @@ jobs:
     - name: Pack
       run: make pack
 
-    - name: Upload artifact
-      uses: actions/upload-artifact@v4
-      with:
-        name: gdb-static
-        path: build/artifacts/gdb-static*.tar.gz
-
     - name: Publish release
-      if: github.event_name == 'push'
       uses: softprops/action-gh-release@v2
       with:
         files: build/artifacts/gdb-static*.tar.gz

.gitmodules

@@ -0,0 +1,8 @@
+[submodule "cpython-static"]
+	path = src/submodule_packages/cpython-static
+	url = git@github.com:guyush1/cpython-static.git
+	branch = python3.12-static
+[submodule "binutils-gdb-static"]
+	path = src/submodule_packages/binutils-gdb
+	url = git@github.com:guyush1/binutils-gdb.git
+	branch = gdb-static

Makefile

@@ -1,15 +1,24 @@
 ARCHS := x86_64 arm aarch64 powerpc mips mipsel
-TARGETS := $(addprefix build-, $(ARCHS))
-PACK_TARGETS := $(addprefix pack-, $(ARCHS))
 
-.PHONY: clean help download_packages build build-docker-image $(TARGETS) $(PACK_TARGETS)
+TARGETS := $(addprefix build-, $(ARCHS))
+PYTHON_TARGETS := $(addprefix build-with-python-, $(ARCHS))
+ALL_TARGETS := $(TARGETS) $(PYTHON_TARGETS)
+
+PACK_TARGETS := $(addprefix pack-, $(ARCHS))
+PYTHON_PACK_TARGETS := $(addprefix pack-with-python-, $(ARCHS))
+ALL_PACK_TARGETS := $(PACK_TARGETS) $(PYTHON_PACK_TARGETS)
+
+SUBMODULE_PACKAGES := $(wildcard src/submodule_packages/*)
+BUILD_PACKAGES_DIR := "build/packages"
+
+.PHONY: clean help download_packages build build-docker-image $(ALL_TARGETS) $(ALL_PACK_TARGETS)
 
 help:
 	@echo "Usage:"
 	@echo "  make build"
 	@echo ""
 
-	@for target in $(TARGETS); do \
+	@for target in $(ALL_TARGETS); do \
 		echo "  $$target"; \
 	done
 
@@ -18,36 +27,57 @@ help:
 
 build/build-docker-image.stamp: Dockerfile
 	mkdir -p build
-	docker build -t gdb-static .
+	docker buildx build --tag gdb-static .
 	touch build/build-docker-image.stamp
 
 build-docker-image: build/build-docker-image.stamp
 
-build/download-packages.stamp: build/build-docker-image.stamp src/download_packages.sh
+build/download-packages.stamp: build/build-docker-image.stamp src/compilation/download_packages.sh
-	mkdir -p build/packages
+	mkdir -p $(BUILD_PACKAGES_DIR)
 	docker run --user $(shell id -u):$(shell id -g) \
 		--rm --volume .:/app/gdb gdb-static env TERM=xterm-256color \
-		/app/gdb/src/download_packages.sh /app/gdb/build/packages
+		/app/gdb/src/compilation/download_packages.sh /app/gdb/$(BUILD_PACKAGES_DIR)/
 	touch build/download-packages.stamp
 
+build/symlink-git-packages.stamp: $(SUBMODULE_PACKAGES)
+	mkdir -p $(BUILD_PACKAGES_DIR)
+	ln -sf $(addprefix /app/gdb/, $(SUBMODULE_PACKAGES)) $(BUILD_PACKAGES_DIR)/
+
+symlink-git-packages: build/symlink-git-packages.stamp
+
 download-packages: build/download-packages.stamp
 
-build: $(TARGETS)
+build: $(ALL_TARGETS)
 
-$(TARGETS): build-%: download-packages build-docker-image
+$(TARGETS): build-%:
+	@$(MAKE) _build-$*
+
+$(PYTHON_TARGETS): build-with-python-%:
+	@WITH_PYTHON="--with-python" $(MAKE) _build-$*
+
+_build-%: symlink-git-packages download-packages build-docker-image
 	mkdir -p build
 	docker run --user $(shell id -u):$(shell id -g) \
 		--rm --volume .:/app/gdb gdb-static env TERM=xterm-256color \
-		/app/gdb/src/build.sh $* /app/gdb/build/ /app/gdb/src
+		/app/gdb/src/compilation/build.sh $* /app/gdb/build/ /app/gdb/src $(WITH_PYTHON)
 
-pack: $(PACK_TARGETS)
+pack: $(ALL_PACK_TARGETS)
 
-$(PACK_TARGETS): pack-%: build-%
+$(PACK_TARGETS): pack-%:
-	if [ ! -f "build/artifacts/gdb-static-$*.tar.gz" ]; then \
+	@$(MAKE) _pack-$*
-		tar -czf "build/artifacts/gdb-static-$*.tar.gz" -C "build/artifacts/$*" .; \
+
+$(PYTHON_PACK_TARGETS): pack-with-python-%:
+	@TAR_EXT="with-python-" ARTIFACT_EXT="_with_python" $(MAKE) _pack-$*
+
+_pack-%: build-%
+	if [ ! -f "build/artifacts/gdb-static-$(TAR_EXT)$*.tar.gz" ]; then \
+		tar -czf "build/artifacts/gdb-static-$(TAR_EXT)$*.tar.gz" -C "build/artifacts/$*$(ARTIFACT_EXT)" .; \
 	fi
 
-clean:
+clean-git-packages:
+	git submodule foreach '[[ ! "$$sm_path" == src/submodule_packages/* ]] || git clean -xffd'
+
+clean: clean-git-packages
 	rm -rf build
 # Kill and remove all containers of image gdb-static
 	docker ps -a | grep -P "^[a-f0-9]+\s+gdb-static\s+" | awk '{print $$1}' | xargs docker rm -f 2>/dev/null || true

src/compilation/build.sh

@@ -4,6 +4,9 @@
 script_dir=$(dirname "$0")
 source "$script_dir/utils.sh"
 
+# Don't want random unknown things to fail in the build procecss!
+set -e
+
 function set_compliation_variables() {
     # Set compilation variables such as which compiler to use.
     #
@@ -40,7 +43,7 @@ function set_compliation_variables() {
         CROSS=mipsel-linux-gnu-
         export HOST=mipsel-linux-gnu
     elif [[ "$target_arch" == "x86_64" ]]; then
-        CROSS=""
+        CROSS=x86_64-linux-gnu-
         export HOST=x86_64-linux-gnu
     fi
 
@@ -49,6 +52,9 @@ function set_compliation_variables() {
 
     export CFLAGS="-O2"
     export CXXFLAGS="-O2"
+
+    # Strip the binary to reduce it's size.
+    export LDFLAGS="-s"
 }
 
 function set_ncurses_link_variables() {
@@ -329,6 +335,7 @@ function build_gdb() {
     # $3: libiconv prefix
     # $4: libgmp prefix
     # $5: libmpfr prefix
+    # $6: whether to build with python or not
     #
     # Echoes:
     # The gdb build directory
@@ -342,7 +349,15 @@ function build_gdb() {
     local libiconv_prefix="$3"
     local libgmp_prefix="$4"
     local libmpfr_prefix="$5"
-    local gdb_build_dir="$(realpath "$gdb_dir/build-$target_arch")"
+    local with_python="$6"
+
+    if [[ "$with_python" == "yes" ]]; then
+        local python_flag="--with-python=/app/gdb/build/packages/cpython-static/build-$target_arch/bin/python3-config"
+        local gdb_build_dir="$(realpath "$gdb_dir/build-${target_arch}_with_python")"
+    else
+        local python_flag="--without-python"
+        local gdb_build_dir="$(realpath "$gdb_dir/build-${target_arch}")"
+    fi
 
     echo "$gdb_build_dir"
     mkdir -p "$gdb_build_dir"
@@ -357,7 +372,7 @@ function build_gdb() {
     >&2 fancy_title "Building gdb for $target_arch"
 
     ../configure -C --enable-static --with-static-standard-libraries --disable-inprocess-agent \
-                 --enable-tui --with-python=/app/gdb/build/packages/cpython-static/build-$target_arch/bin/python3-config \
+                 --enable-tui "$python_flag" \
                  "--with-libiconv-prefix=$libiconv_prefix" --with-libiconv-type=static \
                  "--with-gmp=$libgmp_prefix" \
                  "--with-mpfr=$libmpfr_prefix" \
@@ -384,6 +399,7 @@ function install_gdb() {
     # $1: gdb build directory
     # $2: artifacts directory
     # $3: target architecture
+    # $4: whether gdb was built with or without python
     #
     # Returns:
     # 0: success
@@ -392,15 +408,22 @@ function install_gdb() {
     local gdb_build_dir="$1"
     local artifacts_dir="$2"
     local target_arch="$3"
+    local with_python="$4"
 
-    if [[ -d "$artifacts_dir/$target_arch" && -n "$(ls -A "$artifacts_dir/$target_arch")" ]]; then
+    if [[ "$with_python" == "yes" ]]; then
+        local artifacts_location="$artifacts_dir/${target_arch}_with_python"
+    else
+        local artifacts_location="$artifacts_dir/${target_arch}"
+    fi
+
+    if [[ -d "$artifacts_location" && -n "$(ls -A "$artifacts_location")" ]]; then
         >&2 echo "Skipping install: gdb already installed for $target_arch"
         return 0
     fi
 
     temp_artifacts_dir="$(mktemp -d)"
 
-    mkdir -p "$artifacts_dir/$target_arch"
+    mkdir -p "$artifacts_location"
 
     make -C "$gdb_build_dir" install "DESTDIR=$temp_artifacts_dir" 1>&2
     if [[ $? -ne 0 ]]; then
@@ -409,7 +432,7 @@ function install_gdb() {
     fi
 
     while read file; do
-        cp "$file" "$artifacts_dir/$target_arch/"
+        cp "$file" "$artifacts_location/"
     done < <(find "$temp_artifacts_dir/usr/local/bin" -type f -executable)
 
     rm -rf "$temp_artifacts_dir"
@@ -423,8 +446,9 @@ function build_and_install_gdb() {
     # $2: libiconv prefix
     # $3: libgmp prefix
     # $4: libmpfr prefix
-    # $5: install directory
+    # $5: whether to build with python or not
-    # $6: target architecture
+    # $6: install directory
+    # $7: target architecture
     #
     # Returns:
     # 0: success
@@ -434,15 +458,16 @@ function build_and_install_gdb() {
     local libiconv_prefix="$2"
     local libgmp_prefix="$3"
     local libmpfr_prefix="$4"
-    local artifacts_dir="$5"
+    local with_python="$5"
-    local target_arch="$6"
+    local artifacts_dir="$6"
+    local target_arch="$7"
 
-    gdb_build_dir="$(build_gdb "$gdb_dir" "$target_arch" "$libiconv_prefix" "$libgmp_prefix" "$libmpfr_prefix")"
+    gdb_build_dir="$(build_gdb "$gdb_dir" "$target_arch" "$libiconv_prefix" "$libgmp_prefix" "$libmpfr_prefix" "$with_python")"
     if [[ $? -ne 0 ]]; then
         return 1
     fi
 
-    install_gdb "$gdb_build_dir" "$artifacts_dir" "$target_arch"
+    install_gdb "$gdb_build_dir" "$artifacts_dir" "$target_arch" "$with_python"
     if [[ $? -ne 0 ]]; then
         return 1
     fi
@@ -455,10 +480,12 @@ function build_gdb_with_dependencies() {
     # $1: target architecture
     # $2: build directory
     # $3: src directory
+    # $4: whether to build gdb with python or not
 
     local target_arch="$1"
     local build_dir="$2"
     local source_dir="$3"
+    local with_python="$4"
     local packages_dir="$build_dir/packages"
     local artifacts_dir="$build_dir/artifacts"
 
@@ -490,15 +517,18 @@ function build_gdb_with_dependencies() {
     fi
     set_ncurses_link_variables "$ncursesw_build_dir"
 
-    python_build_dir="$(build_python "$packages_dir/cpython-static" "$target_arch")"
+    if [[ "$with_python" == "yes" ]]; then
-    if [[ $? -ne 0 ]]; then
+        build_python "$packages_dir/cpython-static" "$target_arch"
-        return 1
+        if [[ $? -ne 0 ]]; then
+            return 1
+        fi
     fi
 
     build_and_install_gdb "$packages_dir/binutils-gdb" \
                           "$iconv_build_dir/lib/.libs/" \
                           "$gmp_build_dir/.libs/" \
                           "$mpfr_build_dir/src/.libs/" \
+                          "$with_python" \
                           "$artifacts_dir" \
                           "$target_arch"
     if [[ $? -ne 0 ]]; then
@@ -507,12 +537,17 @@ function build_gdb_with_dependencies() {
 }
 
 function main() {
-    if [[ $# -ne 3 ]]; then
+    if [[ $# -lt 3 ]]; then
-        >&2 echo "Usage: $0 <target_arch> <build_dir> <src_dir>"
+        >&2 echo "Usage: $0 <target_arch> <build_dir> <src_dir> [--with-python]"
         exit 1
     fi
 
-    build_gdb_with_dependencies "$1" "$2" "$3"
+    local with_python="no"
+    if [[ "$4" == "--with-python" ]]; then
+        with_python="yes"
+    fi
+
+    build_gdb_with_dependencies "$1" "$2" "$3" "$with_python"
     if [[ $? -ne 0 ]]; then
         >&2 echo "Error: failed to build gdb with dependencies"
         exit 1

src/compilation/download_packages.sh

@@ -2,7 +2,7 @@
 
 # Include utils library
 script_dir=$(dirname "$0")
-. "$script_dir/utils.sh"
+source "$script_dir/utils.sh"
 
 # List of package URLs to download
 SOURCE_URLS=(
@@ -201,14 +201,6 @@ function download_gdb_packages() {
         fi
     done
 
-    if [[ ! -d gdb-static ]]; then
-        git clone https://github.com/guyush1/binutils-gdb.git --single-branch --branch gdb-static
-    fi
-
-    if [[ ! -d python3.12-static ]]; then
-        git clone https://github.com/guyush1/cpython-static.git --single-branch --branch python3.12-static
-    fi
-
     fancy_title "Finished downloading GDB packages"
     popd
 }