clj-easy / graalvm-clojure Goto Github PK

This project contains a set of "hello world" projects to verify which Clojure libraries do actually compile and produce native images under GraalVM.

License: Apache License 2.0

Shell 4.95% Clojure 91.80% Makefile 0.48% Batchfile 0.55% Dockerfile 2.22%

graalvm-clojure's Introduction

Clojure meets GraalVM

This project contains a set of "hello world" projects to verify which Clojure libraries do actually compile and produce native images under GraalVM.

Here the instructions on how to build your own Clojure projects with GraalVM.

Here the list of libraries tested:

Status	Library	Description	Remarks
✅	Clojure core	Clojure core
✅	clojure spec	Clojure Spec
✅	clojure/tools.logging	Logging library
✅	clojure/tools.logging+log4j	Logging library
✅	aleph	Web server
✅	amazonica+s3	Cloud API wrapper library
✅	asami	Asami DB
✅	aws-api+s3	Cognitect AWS client library
✅	buffy	Buffy, The Byte Buffer Slayer
✅	carmine	Redis client and message queue for Clojure
✅	cheshire	JSON parser/writer
✅	cli4clj	Interactive Command Line Interfaces (CLIs) for Clojure Applications
✅	cljfmt	Source Formatter
✅	clj-http-lite	Web client
❌	clj-sophia	A fast RAM-Disk hybrid storage	Runtime error/JNA
✅	clj-uuid	RFC4122 Unique Identifiers for Clojure	No objects in namespaced uuids
✅	clara-rules	A Clojure forward-chaining rules engine	Using AOT compiled session
✅	clostache	{{ mustache }} for Clojure
✅	component	Managing lifecycle and dependencies of software
✅	cprop	Configuration/property management
✅	datascript	Immutable database and Datalog query engine
⚠️	fastmath	Fast and primitive math and stats library	See README
✅	fire	A lightweight clojure client for Firebase based using the REST API.
✅	hiccup	Fast library for rendering HTML in Clojure
✅	http-kit	Web server and server
✅	integrant	Alternative to mount, component etc.
✅	lacinia	A GraphQL server implementation in pure Clojure
✅	loom	A Graph manipulation and computation library.
❌	monger	An idiomatic Clojure MongoDB driver with sane defaults
✅	μ/log	Event logging system
✅	next.jdbc + honeysql	Database driver and SQL-in-Clojure
✅	nippy	Clojure serialization/deserialization library
✅	pp-grid	A text-formatting library
✅	ring/jetty	Web server
✅	RoaringBitmap	Bitset library
✅	safely	Circuit breaker
✅	secure-random	`SecureRandom` initialization
✅	selmer	A fast, Django inspired template system for Clojure.
✅	system	Layer on top of components
✅	tech.ml.dataset	A Clojure high performance data processing system
✅	timbre	Pure Clojure/Script logging library
✅	pedestal	Pedestal is a sturdy and reliable base for services and APIs.
✅	claypoole	Claypoole: Threadpool tools for Clojure
✅	upit	Very very simple library to initialise your app stack.
::white_check_mark:	zetasketch	Sketch data structures like HLL	requires reflect-config.json

More libraries to come (PRs are welcome).

Interesting GraalVM documentation to build native-images:

Understand Class Initialization in Native Image
Native Image Build Configuration
URL Protocols in Native Image for http and https
JCA Security Services in Native Image

How to contribute

If you wish to add a library and contribute with a PR please follow these steps:

Fork the project
use the sample-project as a template. cp -r sample-project my-library
add the library to the project.clj and the native-image parameters used
amend the my-library/src/simple/main.clj to use the library
amend the my-library/README.md with the info you discovered.
Make a PR with your findings and "Thank you" in advance.

License

Distributed under the Apache License v 2.0 (http://www.apache.org/licenses/LICENSE-2.0)

graalvm-clojure's People

Contributors

Stargazers

Watchers

Forkers

jgrodziski paulschulz timotheosh danielcompton amikishiyev jimpil dsesclei alekcz genmeblog jamartin9 jvia jrwdunham jeroenvandijk kolharsam phronmophobic ajchemist agilecreativity burinc bsless lsevero cnuernber mohammedamarnah salvatoretosti k13gomez maxgfaraday ruedigergad jjtolton quoll nzioki the-alchemist fierycod thy-chan piotr-yuxuan mourjo rorokimdim skynet-gh orange-guo brandonstubbs oakmac emilaasa arttemkorap carlzhc strogo

graalvm-clojure's Issues

Add a spec example project

Currently, you can't build a native-image that uses spec: oracle/graal#1681. It could be good to add a small test project demonstrating that to test against.

Workaround for dynamic Var holding a SecureRandom instance

Hi there,

First of all many thanks for this repo - it contains some super valuable information! I just wanted to say that I was recently trying to create a native-image for cryptohash-clj, and it turns out that the problem was statically initialised instances of SecureRandom. You see, the library has a dynamic Var initialised with an instance of SecureRandom, and no matter what I did, I wasn't able to generate a working image (I tried literally everything). I wrapped that instance in a delay (see here), and now the native-image is working as expected.

I just thought you (or someone else) might find that information useful.

Kind regards

depstar is deprecated and archived; switch to tools.build

depstar has been deprecated and archived for six month now; I'm encouraging everyone to switch to tools.build. My build-clj wrapper makes it easier to switch.

drewr/postal

I've been experimenting with drewr/postal to be able to send e-mails from a native-image.
So far it fails for me with:

#error {
 :cause "smtps"
 :via
 [{:type javax.mail.NoSuchProviderException
   :message "smtps"
   :at [javax.mail.Session getService "Session.java" 811]}]

I've tried adding com.sun.mail.smtp.SMTPTransport to the reflection config, but this didn't help.

Problem running the aws-api-s3

I am getting the following errors:

./aws-api-s3 
Exception in thread "main" clojure.lang.ExceptionInfo: Cannot find resource cognitect/aws/s3/service.edn. {}
	at cognitect.aws.service$service_description.invokeStatic(service.clj:31)
	at cognitect.aws.service$service_description.invoke(service.clj:28)
	at cognitect.aws.client.api$client.invokeStatic(api.clj:67)
	at cognitect.aws.client.api$client.invoke(api.clj:22)
	at simple.main$_main.invokeStatic(main.clj:8)
	at simple.main$_main.invoke(main.clj:7)
	at clojure.lang.AFn.applyToHelper(AFn.java:152)
	at clojure.lang.AFn.applyTo(AFn.java:144)
	at simple.main.main(Unknown Source)

Not sure if anyone have idea about how to make this work.
I am guessing that it may have something to do with adding the following config as part of native-image generation.

My env:

graalvm-ce-java11-20.3.0
Clojure 1.10.1-rc2
Java 1.11.0

hickory and other jsoup dependents are incompatible

Idk where else to document this in a public manner.
Hickory, as well as most other projects labeling themselves as html parsers don't play nicely with graalvm.
This is because jsoup wants to be initialized at runtime and clojure libs at build time.
The project where I tried for days to get it to play with graal: bbyt

[http-kit] class initialization changes as of 2.5.2

Hello,
Following a bug fix in http-kit, to compile the client with version 2.5.2 the following initialization flag is required:

--initialize-at-run-time=org.httpkit.client.ClientSslEngineFactory\$SSLHolder

Will PR this soon

Cheers :)

Make ring-jetty work

On master:

$ native-image --version
GraalVM Version 19.2.1 CE
$ java -version
openjdk version "1.8.0_232"
OpenJDK Runtime Environment (build 1.8.0_232-20191009173705.graal.jdk8u-src-tar-gz-b07)
OpenJDK 64-Bit GraalVM CE 19.2.1 (build 25.232-b07-jvmci-19.2-b03, mixed mode)
$ lein do clean, uberjar, native, run-native
Compiling simple.main
2019-10-24 14:38:17.909:INFO::main: Logging initialized @1477ms to org.eclipse.jetty.util.log.StdErrLog
Created /Users/danielcompton/Developer/clojure/test/graalvm-clojure/ring-jetty/target/ring-jetty-0.1.0-SNAPSHOT.jar
Created /Users/danielcompton/Developer/clojure/test/graalvm-clojure/ring-jetty/target/simple-main.jar
[./target/ring-jetty:62615]    classlist:   2,375.62 ms
[./target/ring-jetty:62615]        (cap):   1,128.28 ms
[./target/ring-jetty:62615]        setup:   2,440.11 ms
2019-10-24 14:38:26.546:INFO::ForkJoinPool-2-worker-12: Logging initialized @5707ms to org.eclipse.jetty.util.log.StdErrLog
[./target/ring-jetty:62615]   (typeflow):   5,140.84 ms
[./target/ring-jetty:62615]    (objects):   4,779.68 ms
[./target/ring-jetty:62615]   (features):     208.57 ms
[./target/ring-jetty:62615]     analysis:  10,351.47 ms
[./target/ring-jetty:62615]     (clinit):     206.89 ms
[./target/ring-jetty:62615]     universe:     503.52 ms
[./target/ring-jetty:62615]      (parse):     434.64 ms
[./target/ring-jetty:62615]     (inline):   1,418.28 ms
[./target/ring-jetty:62615]    (compile):   4,724.07 ms
[./target/ring-jetty:62615]      compile:   7,120.33 ms
[./target/ring-jetty:62615]        image:     850.46 ms
[./target/ring-jetty:62615]        write:     279.14 ms
[./target/ring-jetty:62615]      [total]:  24,094.02 ms
server started on: http://localhost:3000/
Exception in thread "main" java.lang.ClassNotFoundException: org.eclipse.jetty.server.ServerConnector
	at com.oracle.svm.core.hub.ClassForNameSupport.forName(ClassForNameSupport.java:60)
	at java.lang.Class.forName(DynamicHub.java:1174)
	at clojure.lang.RT.classForName(RT.java:2207)
	at clojure.lang.RT.classForName(RT.java:2216)
	at ring.adapter.jetty$server_connector.invokeStatic(jetty.clj:44)
	at ring.adapter.jetty$server_connector.doInvoke(jetty.clj:44)
	at clojure.lang.RestFn.invoke(RestFn.java:423)
	at ring.adapter.jetty$http_connector.invokeStatic(jetty.clj:57)
	at ring.adapter.jetty$http_connector.invoke(jetty.clj:55)
	at ring.adapter.jetty$create_server.invokeStatic(jetty.clj:122)
	at ring.adapter.jetty$create_server.invoke(jetty.clj:119)
	at ring.adapter.jetty$run_jetty.invokeStatic(jetty.clj:164)
	at ring.adapter.jetty$run_jetty.invoke(jetty.clj:127)
	at simple.main$_main.invokeStatic(main.clj:15)
	at simple.main$_main.invoke(main.clj:13)
	at clojure.lang.AFn.applyToHelper(AFn.java:152)
	at clojure.lang.AFn.applyTo(AFn.java:144)
	at simple.main.main(Unknown Source)

After applying ring-clojure/ring#381 locally, I was able to run this. Once that is merged, we should update the dependencies and I think ring-jetty will run.

I think it could be a very fun thing for me to work on :-)

asami

I just tried out asami locally:

https://github.com/threatgrid/asami

$ ./asami
(["Explorers"] ["Demolition Man"] ["Johnny Mnemonic"] ["Toy Story"])

Worked great, memory consumption during compilation is far more reasonable than datascript.
Hopefully once it gets durable storage it keeps working well like this.

Deprecation warning for `--initialize-at-build-time`

--initialize-at-build-time without arguments has been deprecated when not using --diagnostics-mode. With GraalVM 22.0.0 --initialize-at-build-time will only work with --diagnostics-mode for debugging purposes.
The reason for deprecation is that --initalize-at-build-time does not compose, i.e., a single library can make assumptions that the whole classpath can be safely initialized at build time; that assumption is often incorrect.

help with compiling ninja/jep

I've compiled jep, which is a jni based embedded python runtime https://github.com/zcaudate/sample-jep-graal but am getting a weird output.

Have you seen something similar to this before?