Add tests for the new GC extensions.

Author: rbehrends

test/Makefile

@@ -16,6 +16,8 @@ TESTS = all stdlib $(TESTGROUPS) \
 
 EMBEDDING_ARGS := "JULIA=$(JULIA_EXECUTABLE)" "BIN=$(SRCDIR)/embedding" "CC=$(CC)"
 
+GCEXT_ARGS := "JULIA=$(JULIA_EXECUTABLE)" "BIN=$(SRCDIR)/gcext" "CC=$(CC)"
+
 default: all
 
 $(TESTS):
@@ -25,7 +27,11 @@ $(TESTS):
 embedding:
 	@$(MAKE) -C $(SRCDIR)/$@ check $(EMBEDDING_ARGS)
 
+gcext:
+	@$(MAKE) -C $(SRCDIR)/$@ check $(GCEXT_ARGS)
+
 clean:
 	@$(MAKE) -C embedding $@ $(EMBEDDING_ARGS)
+	@$(MAKE) -C gcext $@ $(GCEXT_ARGS)
 
-.PHONY: $(TESTS) embedding clean
+.PHONY: $(TESTS) embedding gcext clean

test/gcext/.gitignore

@@ -0,0 +1,2 @@
+/gcext
+/gcext-debug

test/gcext/LocalTest.jl

@@ -0,0 +1,85 @@
+# This file is a part of Julia. License is MIT: https://julialang.org/license
+
+module LocalTest
+  const Stack = Main.TestGCExt.Stack
+  function make()
+    ccall(:stk_make, Stack, ())
+  end
+  function push(stack :: Stack, val :: String)
+    ccall(:stk_push, Nothing, (Stack, String), stack, val)
+  end
+  function top(stack :: Stack)
+    return ccall(:stk_top, String, (Stack,), stack)
+  end
+  function pop(stack :: Stack)
+    return ccall(:stk_pop, String, (Stack,), stack)
+  end
+  function size(stack :: Stack)
+    return ccall(:stk_size, UInt, (Stack,), stack)
+  end
+  function empty(stack :: Stack)
+    return size(stack) == 0
+  end
+  function blob(stack :: Stack)
+    return ccall(:stk_blob, Any, (Stack,), stack)
+  end
+  function gc_counter_full()
+    return ccall(:get_gc_counter, UInt, (Cint,), 1)
+  end
+  function gc_counter_inc()
+    return ccall(:get_gc_counter, UInt, (Cint,), 0)
+  end
+  function gc_counter()
+    return gc_counter_full() + gc_counter_inc()
+  end
+  function num_obj_sweeps()
+    return ccall(:get_obj_sweeps, UInt, ())
+  end
+  function get_aux_root(n :: Int)
+    return ccall(:get_aux_root, String, (UInt,), n)
+  end
+  function set_aux_root(n :: Int, x :: String)
+    return ccall(:set_aux_root, Nothing, (UInt, String), n, x)
+  end
+  function internal_obj_scan(p :: Any)
+    if ccall(:internal_obj_scan, Cint, (Any,), p) == 0
+      global internal_obj_scan_failures += 1
+    end
+  end
+
+  global internal_obj_scan_failures = 0
+  for i in 0:1000
+    set_aux_root(i, string(i))
+  end
+  function test()
+    local stack = make()
+    for i in 1:100000
+      push(stack, string(i, base=2))
+      internal_obj_scan(top(stack))
+    end
+    for i in 1:1000
+      local stack2 = make()
+      internal_obj_scan(stack2)
+      internal_obj_scan(blob(stack2))
+      while !empty(stack)
+	push(stack2, pop(stack))
+      end
+      stack = stack2
+      if i % 100 == 0
+	GC.gc()
+      end
+    end
+  end
+  global corrupted_roots = 0
+  for i in 0:1000
+    if get_aux_root(i) != string(i)
+      global corrupted_roots += 1
+    end
+  end
+  @time test()
+  print(gc_counter_full(), " full collections.\n")
+  print(gc_counter_inc(), " partial collections.\n")
+  print(num_obj_sweeps(), " object sweeps.\n")
+  print(internal_obj_scan_failures, " internal object scan failures.\n")
+  print(corrupted_roots, " corrupted auxiliary roots.\n")
+end

test/gcext/Makefile

@@ -0,0 +1,60 @@
+# This file is a part of Julia. License is MIT: https://julialang.org/license
+
+# This Makefile template requires the following variables to be set
+# in the environment or on the command-line:
+#   JULIA: path to julia[.exe] executable
+#   BIN:   binary build directory
+
+ifndef JULIA
+  $(error "Please pass JULIA=[path of target julia binary], or set as environment variable!")
+endif
+ifndef BIN
+  $(error "Please pass BIN=[path of build directory], or set as environment variable!")
+endif
+
+#=============================================================================
+# this source directory where gcext.c is located
+SRCDIR := $(abspath $(dir $(lastword $(MAKEFILE_LIST))))
+
+# get the executable suffix, if any
+EXE := $(suffix $(abspath $(JULIA)))
+
+# get compiler and linker flags. (see: `contrib/julia-config.jl`)
+JULIA_CONFIG := $(JULIA) -e 'include(joinpath(Sys.BINDIR, Base.DATAROOTDIR, "julia", "julia-config.jl"))' --
+CPPFLAGS_ADD :=
+CFLAGS_ADD = $(shell $(JULIA_CONFIG) --cflags)
+LDFLAGS_ADD = -lm $(shell $(JULIA_CONFIG) --ldflags --ldlibs)
+
+DEBUGFLAGS += -g
+
+#=============================================================================
+
+release: $(BIN)/gcext$(EXE)
+debug:   $(BIN)/gcext-debug$(EXE)
+
+$(BIN)/gcext$(EXE): $(SRCDIR)/gcext.c
+	$(CC) $^ -o $@ $(CPPFLAGS_ADD) $(CPPFLAGS) $(CFLAGS_ADD) $(CFLAGS) $(LDFLAGS_ADD) $(LDFLAGS)
+
+$(BIN)/gcext-debug$(EXE): $(SRCDIR)/gcext.c
+	$(CC) $^ -o $@ $(CPPFLAGS_ADD) $(CPPFLAGS) $(CFLAGS_ADD) $(CFLAGS) $(LDFLAGS_ADD) $(LDFLAGS) $(DEBUGFLAGS)
+
+ifneq ($(abspath $(BIN)),$(abspath $(SRCDIR)))
+# for demonstration purposes, our demo code is also installed
+# in $BIN, although this would likely not be typical
+$(BIN)/LocalModule.jl: $(SRCDIR)/LocalModule.jl
+	cp $< $@
+endif
+
+check: $(BIN)/gcext$(EXE) $(BIN)/LocalTest.jl
+	$(JULIA) --depwarn=error $(SRCDIR)/gcext-test.jl $<
+	@echo SUCCESS
+
+clean:
+	-rm -f $(BIN)/gcext-debug$(EXE) $(BIN)/gcext$(EXE)
+
+.PHONY: release debug clean check
+
+# Makefile debugging trick:
+# call print-VARIABLE to see the runtime value of any variable
+print-%:
+	@echo '$*=$($*)'

test/gcext/gcext-test.jl

@@ -0,0 +1,42 @@
+# This file is a part of Julia. License is MIT: https://julialang.org/license
+
+# tests the output of the embedding example is correct
+using Test
+
+if Sys.iswindows()
+    # libjulia needs to be in the same directory as the embedding executable or in path
+    ENV["PATH"] = string(Sys.BINDIR, ";", ENV["PATH"])
+end
+
+function checknum(s, rx, cond)
+    m = match(rx, s)
+    if m === nothing
+	return false
+    else
+        num = m[1]
+	return cond(parse(UInt, num))
+    end
+end
+
+@test length(ARGS) == 1
+@testset "gcext example" begin
+    out = Pipe()
+    err = Pipe()
+    p = run(pipeline(Cmd(ARGS), stdin=devnull, stdout=out, stderr=err), wait=false)
+    close(out.in)
+    close(err.in)
+    out_task = @async readlines(out)
+    err_task = @async readlines(err)
+    # @test success(p)
+    errlines = fetch(err_task)
+    lines = fetch(out_task)
+    @test length(errlines) == 0
+    @test length(lines) == 6
+    @test checknum(lines[2], r"([0-9]+) full collections", n -> n >= 10)
+    @test checknum(lines[3], r"([0-9]+) partial collections", n -> n > 0)
+    @test checknum(lines[4], r"([0-9]+) object sweeps", n -> n > 0)
+    @test checknum(lines[5], r"([0-9]+) internal object scan failures",
+        n -> n == 0)
+    @test checknum(lines[6], r"([0-9]+) corrupted auxiliary roots",
+        n -> n == 0)
+end