Opt-in way to start the patched server on the app class path, so JDK 25's AOT cache can hold it

Ouverte
#75 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
52/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
java

Piste de recherche

Start by reading Paperclip.main, setupClasspath, and the paperclip.patchonly handling around bundlerRepoDir. Compare the proposed manifest-only launch.jar with Paperclip's existing class-path order and consider how the opt-in setting should work. Done means an opt-in app-class-path launcher is produced without changing the default launch, or the README documents the manual workflow if that is preferred.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

What

Paperclip starts the server from a URLClassLoader over the patched jars (Paperclip.main). JDK 25's AOT cache (JEP 483, JEP 514) only caches classes loaded by the JVM's built-in loaders. So a cache recorded through Paperclip holds none of Minecraft's or Paper's classes. The training run skipped all 12,520 of them:

[warning][aot] Skipping net/minecraft/world/level/block/TntBlock: Unsupported location
... (12,520 lines)

Started from the same patched jars on the app class path, the same cache cuts startup by about a third.

Numbers

Paper 26.2-124, Temurin 25.0.4+7, -Xms1G -Xmx1G, a fresh world each start (level-seed=1), on an 8-core Linux box. Time from java to Done (:

Start Time to Done
java -jar paper.jar (Paperclip), as today 13.3s
app class path, no cache 12.1s
app class path, -XX:AOTCache=paper.aot 7.9–8.7s

The cache was recorded with -XX:AOTCacheOutput=paper.aot on one start that ran to Done and was then stopped. It's about 195MB.

How we got Paper onto the app class path

We ran -Dpaperclip.patchonly=true into a bundlerRepoDir. Next to it we put a manifest-only jar, Main-Class: org.bukkit.craftbukkit.Main, whose Class-Path lists versions/… and then libraries/…, in the order META-INF/versions.list and META-INF/libraries.list give. The paths are relative to the jar, so the folder can move. Then:

java -XX:AOTCache=paper.aot -jar <repo>/launch.jar --nogui

Our server images now start this way, with a plugin loaded, and pass our start-up checks. The class-path order is the same as Paperclip's, versions first, as setupClasspath requires.

Two things we learned that a user would need to know:

  • The JVM checks every class-path jar's size and modification time against the cache. If anything differs, for example after a repatch, it prints [error][aot] … timestamp has changed and starts without the cache. So a stale cache fails safe, just slower.
  • A cache recorded with the JDK and the jars at other paths still works when they're moved, as long as their relative layout and times are the same. We record ours at image build time.
Proposal

An opt-in, leaving the default launch alone. For example, while patching Paperclip could also write launch.jar (as above) into the bundlerRepoDir, perhaps only when asked with a system property. Anyone wanting the AOT cache would then run that jar instead of paper.jar.

This keeps what #35 was after: the server loaded as if started with plain java -jar, on the JVM's own loader. It would also sidestep the service-loader problem in #66, since the app loader is the parent there.

If a Paperclip-side change isn't wanted, a short note in the readme on doing this by hand with paperclip.patchonly would still help people on Java 25.

I'm happy to open a PR for whichever shape you prefer.

Langage dominant
Java
Étoiles
128
Forks
65
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de PaperMC/Paperclip

Toutes les issues de PaperMC/Paperclip

Issues similaires

Plus d'issues Java

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.