Fork me on GitHub

Invoke dynamic support

Introduction

Since Groovy 2.0, support was added for the JVM invokedynamic instruction. This instruction is supported since Java 7 and is a new bytecode instruction in the JVM that allows easier implementation of dynamic languages. This instruction is used internally, by the JVM, for the lambda support in Java 8.

This means that unlike APIs, AST transformations or syntactic sugar, this feature is not visible to the developer or the end user. It is a compilation and runtime feature only. This means that given two programs written in Groovy, you have the choice to compile it with or without invokedynamic support. Whatever you choose, it comes with pros and cons.

  • classes compiled with invokedynamic can only be used on JDK 1.7+
    • without invokedynamic, Groovy classes are still compatible with JDK 1.6+
  • it is possible to mix classes compiled with and without invokedynamic in the same project, as long as you run JDK 1.7+
  • depending on the JVM (even different minor versions of the JVM), you can target close to Java performance for dynamic Groovy with invokedynamic support activated

JDK version

All JDK 7 versions ranging from 7u21 to 7u55 are buggy with regards to invokedynamic. If you plan to use invokedynamic support, make sure you either use 7u60 or JDK 8.

The distributions

Two JARs

The Groovy distribution comes with two jars:

  • groovy-x.y.z.jar: compatible with JDK 1.6+, contains Groovy sources compiled with call site caching
  • groovy-x-y-z-indy.jar: compatible with JDK 1.7+, contains Groovy sources compiled with invokedynamic

As Groovy core and the Groovy modules are sometimes written in Groovy, we currently have no choice but to distribute two distinct versions of Groovy. This means that if you pick the "normal" jar, the Groovy classes of Groovy itself are compiled with call site caching, while if you use the "indy" jar, the Groovy classes of Groovy itself are compiled using invokedynamic.

Both jars contain a fully working Groovy implementation that is capable of compiling user supplied Groovy sources using either invokedynamic or call site caching. The sets of jars are mutually exclusive (don't put both on classpath) and the key difference between them has to do with how the Groovy source files that make up Groovy itself are compiled.

Command-line and indy

If you download the distribution and use the command line, it's always the "normal" version of Groovy which is picked up in classpath. This means that whatever command you use (groovy, groovyc, groovysh or groovyConsole), invokedynamic support is not available out of the box. To use a Groovy distribution that was compiled with invokedynamic for its Groovy sources you have to switch the jars manually. The distribution makes use of the jars in the lib directory, while the indy jars are available in the indy directory. You have three things to do:

  • remove or rename the groovy-*.jar files in the lib directory
  • replace them with the indy version from the indy directory
  • remove the -indy classifier from jar names

Here's a bash script that would do it all at once:

$ for f in `ls lib/groovy*.jar | cut -d/ -f2`;do k=`basename $f .jar`; mv lib/$k.jar lib/$k.jar.old; cp indy/$k-indy.jar lib/$k.jar ; done

Running groovy script from command line

The usual way to run a script from the command line is by "groovy foo.groovy", where foo.groovy is the Groovy program in source form. To use indy for this you have to use the indy compilation flag, "groovy --indy foo.groovy".

The compilation flag

Independently of the jar version that you use, invokedynamic support requires a specific compilation flag (indy). If you want to compile your classes with invokedynamic support, this flag must be set at compile time. The following tables show you what happens with user compiled classes and Groovy core classes depending on the jar you use and the compilation flag:

For user compiled classes:

indy flagoffon
normal jarcall site cachinginvokedynamic
indy jarcall site cachinginvokedynamic

For core Groovy classes:

indy flagoffon
normal jarcall site cachingcall site caching
indy jarinvokedynamicinvokedynamic

So even if you use the indy jar, if you don't use the invokedynamic flag at compile time, then the compiled classes will use the "old" format, meaning they will use the JDK1.6+ classes without invokedynamic.