ysbaddaden/crystal_library

Static/Shared libraries written in Crystal (Proof of Concept)

Static/Shared libraries in Crystal

Write C static (or shared) libraries in Crystal. This is just a Proof of Concept that exemplifies how to expose a Crystal library to the outside world, eg: C or any language with bindings to C.

Build the library

Change CRYSTAL_ROOT to match your Crystal distribution (it's /opt/crystal by default on Linux):

$ make CRYSTAL_ROOT=/opt/crystal

You may now test that it works:

$ make test

How does it work?

We need Crystal 0.18.0+ and:

1. Some crystal code. See src/counter.cr for a basic example.

2. An API, thankfully written in Crystal to expose the Crystal internals as proper C functions with symbols that won't be mangled. See src/libcounter.cr. You'll notice that it requires a bunch of boilerplate and casting objects with Box to exchange references as void pointers with the outside world.

3. A hack to avoid the generation of a main function by Crystal, and have an alternative function that must be manually called from the outside world to initialize the GC, Crystal constants, etc. See Hack below.

4. A C header to declare the function signatures to C. See src/counter.h.

5. Use the library. See examples in test and Makefile for how to compile and link them.

Hack

In order to compile, we need to avoid loading the original main.cr from the Crystal, and replace it with. This PoC does that by hacking the CRYSTAL_PATH environment variable so it references the local src folder first. This will work with distributions of Crystal, but won't from a Git clone of Crystal, which always overwrites CRYSTAL_PATH.

crystal_library's Issues

PoC with crystal 0.24.2

Tried your PoC with crystal 0.24.2 on linux 64 bits. Alas did not work, there is no compile option, only a build option. With the build option it does not work

user1 ~/download/try/crystal_library (master) $ make CRYSTAL_ROOT=/opt/crystal
CRYSTAL_PATH="src:/opt/crystal/share/crystal/src" /opt/crystal/bin/crystal build \
	--release --cross-compile -o libcounter src/libcounter.cr
cc 'libcounter.o' -o 'libcounter'  -rdynamic  -lpcre -lgc -lpthread /opt/crystal/share/crystal/src/ext/libcrystal.a -levent -lrt -ldl -L/usr/lib -L/usr/local/lib
ar rcs libcounter.a libcounter.o
user1 ~/download/try/crystal_library (master) $ make test
cc test/counter_test.c ./libcounter.a /opt/crystal/share/crystal/src/ext/libcrystal.a -lgc -ldl -levent -lpcre -o counter_test
./libcounter.a(libcounter.o): In function `main':
/opt/crystal/share/crystal/src/crystal/main.cr:134: multiple definition of `main'
/tmp/ccowU1tv.o:counter_test.c:(.text+0x0): first defined here
/usr/bin/ld: cannot find -lgc
collect2: error: ld returned 1 exit status
Makefile:18: recipe for target 'counter_test' failed
make: *** [counter_test] Error 1

Update the POC

Hi :)
Now that crystal has support for not generating main , would it be easier to do this with less steps ?