Conditionally compile GC source files. Test stock build in CI. (#73)

This PR changes the build script to only include source files for the GC implementation that is selected. The PR also removes unnecessary preprocessor `#ifdef` for related files.

This PR adds a CI job to build with the stock GC. This helps us to make sure that the stock GC can build.

Author: qinsoon

.github/workflows/StockBuild.yml

@@ -0,0 +1,21 @@
+# This workflow does not exist upstream. DO NOT TRY TO UPSTREAM IT.
+# It is just a simple check to ensure that we do not break the stock build.
+
+name: Test stock Julia build
+
+on:
+    pull_request:
+
+concurrency:
+    # Cancels pending runs when a PR gets updated.
+    group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+    cancel-in-progress: true
+
+jobs:
+    build:
+        runs-on: ubuntu-22.04
+        steps:
+        - uses: actions/checkout@v4
+        - name: Build
+          run: |
+            make

src/Makefile

@@ -44,23 +44,34 @@ ifeq ($(OS),FreeBSD)
 FLAGS += -I$(LOCALBASE)/include
 endif
 
+# GC source code. It depends on which GC implementation to use.
+GC_SRCS := gc-common gc-stacks gc-alloc-profiler gc-heap-snapshot
+ifeq ($(WITH_MMTK), 1)
+GC_SRCS += gc-mmtk
+else
+GC_SRCS += gc-stock gc-debug gc-pages gc-page-profiler
+endif
+
 SRCS := \
 	jltypes gf typemap smallintset ast builtins module interpreter symbol \
 	dlload sys init task array genericmemory staticdata toplevel jl_uv datatype \
 	simplevector runtime_intrinsics precompile jloptions mtarraylist \
-	threading scheduler stackwalk gc-common gc-stock gc-mmtk gc-debug gc-pages gc-stacks gc-alloc-profiler gc-page-profiler \
-	method jlapi signal-handling safepoint timing subtype rtutils gc-heap-snapshot \
-	crc32c APInt-C processor ircode opaque_closure codegen-stubs coverage runtime_ccall engine
+	threading scheduler stackwalk \
+	method jlapi signal-handling safepoint timing subtype rtutils \
+	crc32c APInt-C processor ircode opaque_closure codegen-stubs coverage runtime_ccall engine \
+	$(GC_SRCS)
 
 RT_LLVMLINK :=
 CG_LLVMLINK :=
 
 ifeq ($(JULIACODEGEN),LLVM)
+GC_CODEGEN_SRCS := llvm-final-gc-lowering llvm-late-gc-lowering llvm-gc-invariant-verifier
 CODEGEN_SRCS := codegen jitlayers aotcompile debuginfo disasm llvm-simdloop \
-	llvm-final-gc-lowering llvm-pass-helpers llvm-late-gc-lowering llvm-ptls \
-	llvm-lower-handlers llvm-gc-invariant-verifier llvm-propagate-addrspaces \
+	llvm-pass-helpers llvm-ptls \
+	llvm-lower-handlers llvm-propagate-addrspaces \
 	llvm-multiversioning llvm-alloc-opt llvm-alloc-helpers cgmemmgr llvm-remove-addrspaces \
-	llvm-remove-ni llvm-julia-licm llvm-demote-float16 llvm-cpufeatures pipeline llvm_api
+	llvm-remove-ni llvm-julia-licm llvm-demote-float16 llvm-cpufeatures pipeline llvm_api \
+	$(GC_CODEGEN_SRCS)
 FLAGS += -I$(shell $(LLVM_CONFIG_HOST) --includedir)
 CG_LLVM_LIBS := all
 ifeq ($(USE_POLLY),1)
@@ -107,7 +118,12 @@ ifeq ($(USE_SYSTEM_LIBUV),0)
 UV_HEADERS += uv.h
 UV_HEADERS += uv/*.h
 endif
-PUBLIC_HEADERS := $(BUILDDIR)/julia_version.h $(wildcard $(SRCDIR)/support/*.h) $(addprefix $(SRCDIR)/,work-stealing-queue.h gc-interface.h gc-tls.h gc-tls-common.h gc-tls-mmtk.h julia.h julia_assert.h julia_threads.h julia_fasttls.h julia_locks.h julia_atomics.h jloptions.h)
+PUBLIC_HEADERS := $(BUILDDIR)/julia_version.h $(wildcard $(SRCDIR)/support/*.h) $(addprefix $(SRCDIR)/,work-stealing-queue.h gc-interface.h gc-tls-common.h julia.h julia_assert.h julia_threads.h julia_fasttls.h julia_locks.h julia_atomics.h jloptions.h)
+ifeq ($(WITH_MMTK), 1)
+	PUBLIC_HEADERS += $(addprefix $(SRCDIR)/,gc-tls-mmtk.h)
+else
+	PUBLIC_HEADERS += $(addprefix $(SRCDIR)/,gc-tls-stock.h)
+endif
 ifeq ($(OS),WINNT)
 PUBLIC_HEADERS += $(addprefix $(SRCDIR)/,win32_ucontext.h)
 endif

src/gc-debug.c

@@ -1,6 +1,5 @@
 // This file is a part of Julia. License is MIT: https://julialang.org/license
 
-#ifndef MMTK_GC
 #include "gc-common.h"
 #include "gc-stock.h"
 #include "julia.h"
@@ -1130,5 +1129,3 @@ void _report_gc_finished(uint64_t pause, uint64_t freed, int full, int recollect
 #ifdef __cplusplus
 }
 #endif
-
-#endif // !MMTK_GC

src/gc-interface.h

@@ -206,7 +206,7 @@ void jl_gc_notify_image_load(const char* img_data, size_t len);
 // This function notifies the GC about memory addresses that are set when allocating the boot image.
 // The GC may use that information to, for instance, determine that all objects in that chunk of memory should
 // be treated as marked and belonged to the old generation in nursery collections.
-void jl_gc_notify_image_alloc(char* img_data, size_t len);
+void jl_gc_notify_image_alloc(const char* img_data, size_t len);
 
 // ========================================================================= //
 // Runtime Write-Barriers

src/gc-mmtk.c

@@ -1,5 +1,3 @@
-#ifdef MMTK_GC
-
 #include "gc-common.h"
 #include "mmtkMutator.h"
 #include "gc-mmtk.h"
@@ -1109,7 +1107,7 @@ void jl_gc_notify_image_load(const char* img_data, size_t len)
     mmtk_set_vm_space((void*)img_data, len);
 }
 
-void jl_gc_notify_image_alloc(char* img_data, size_t len)
+void jl_gc_notify_image_alloc(const char* img_data, size_t len)
 {
     mmtk_immortal_region_post_alloc((void*)img_data, len);
 }
@@ -1245,5 +1243,3 @@ JL_DLLEXPORT jl_value_t *jl_gc_internal_obj_base_ptr(void *p)
 #ifdef __cplusplus
 }
 #endif
-
-#endif // MMTK_GC

src/gc-mmtk.h

@@ -1,5 +1,3 @@
-#ifdef MMTK_GC
-
 #include <stdbool.h>
 #include <stddef.h>
 #include <stdint.h>
@@ -30,5 +28,3 @@ JL_EXTENSION typedef struct _bigval_t {
 #ifdef __cplusplus
 }
 #endif
-
-#endif // MMTK_GC

src/gc-page-profiler.c

@@ -1,6 +1,5 @@
 // This file is a part of Julia. License is MIT: https://julialang.org/license
 
-#ifndef MMTK_GC
 #include "gc-page-profiler.h"
 #include "julia.h"
 
@@ -179,5 +178,3 @@ JL_DLLEXPORT void jl_gc_take_page_profile(ios_t *stream)
 #ifdef __cplusplus
 }
 #endif
-
-#endif // !MMTK_GC

src/gc-pages.c

@@ -1,6 +1,5 @@
 // This file is a part of Julia. License is MIT: https://julialang.org/license
 
-#ifndef MMTK_GC
 #include "gc-common.h"
 #include "gc-stock.h"
 #ifndef _OS_WINDOWS_
@@ -206,5 +205,3 @@ void jl_gc_free_page(jl_gc_pagemeta_t *pg) JL_NOTSAFEPOINT
 #ifdef __cplusplus
 }
 #endif
-
-#endif // !MMTK_GC

src/gc-stacks.c

@@ -1,7 +1,6 @@
 // This file is a part of Julia. License is MIT: https://julialang.org/license
 
 #include "gc-common.h"
-#include "gc-stock.h"
 #include "threading.h"
 #ifndef _OS_WINDOWS_
 #  include <sys/resource.h>

src/gc-stock.c

@@ -1,6 +1,5 @@
 // This file is a part of Julia. License is MIT: https://julialang.org/license
 
-#ifndef MMTK_GC
 #include "gc-common.h"
 #include "gc-stock.h"
 #include "gc-alloc-profiler.h"
@@ -4007,5 +4006,3 @@ JL_DLLEXPORT const char* jl_active_gc_impl(void) {
 #ifdef __cplusplus
 }
 #endif
-
-#endif // !MMTK_GC