Package org.eolang.hone

Class OptimizeMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.eolang.hone.OptimizeMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="optimize",
      defaultPhase=PROCESS_CLASSES,
      requiresProject=false)
public final class OptimizeMojo
extends org.apache.maven.plugin.AbstractMojo

Converts Bytecode to Bytecode in order to make it faster.

This goal takes every .class file from the target/classes/ directory, converts it to .xmir format (which is XML representation of EO), then converts .xmir to .phi (which is 𝜑-calculus), then optimizes it via phino, and then back to .xmir and to .class. As a result, you obtain optimized Bytecode in the target/classes/ directory, which supposedly works faster than before.

The entire optimization pipeline happens inside Docker container, which is run from the image specified in the image parameter. The image may either be pulled or built locally. We recommend pulling it from the Docker Hub with the help of the pull goal. Also, we recommend deleting the image after optimization is done, with the help of the rmi goal.

Since:

0.1.0

Suppressed Checkstyle violations:

CyclomaticComplexityCheck (500 lines), NPathComplexityCheck (500 lines), ExecutableStatementCountCheck (500 lines)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OptimizeMojo.CLibrary	C library interface for getting user IDs.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	alwaysWithDocker	Run without Docker even if phino is available.
protected String	image	Docker image to use.
protected boolean	sudo	Whether to use "sudo" when executing Docker commands.
protected File	target	The "target/" directory of Maven project.
protected org.eolang.hone.Timings	timings	Timings tracker for performance measurements.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
OptimizeMojo()

Method Summary

Modifier and Type	Method	Description
void	exec()
final void	execute()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

target

@Parameter(property="hone.target",
           defaultValue="${project.build.directory}")
protected File target

The "target/" directory of Maven project.

Since:

0.1.0

timings

protected org.eolang.hone.Timings timings

Timings tracker for performance measurements.

Since:

0.1.0

image

@Parameter(property="hone.image",
           defaultValue="yegor256/hone:0.20.3")
protected String image

Docker image to use.

Since:

0.1.0

sudo

@Parameter(property="hone.sudo",
           defaultValue="false")
protected boolean sudo

Whether to use "sudo" when executing Docker commands.

Since:

0.1.0

alwaysWithDocker

@Parameter(property="hone.always-with-docker",
           defaultValue="false")
protected boolean alwaysWithDocker

Run without Docker even if phino is available.

If this is set to true, Docker is used even if phino is available. It is recommended to keep this parameter to false, thus making the build faster if it's possible.

Since:

0.17.0

Suppressed Checkstyle violations:

MemberNameCheck (6 lines)

Constructor Details

OptimizeMojo

public OptimizeMojo()

Method Details

exec

public void exec()
          throws IOException

Throws:

IOException

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException