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

Đang mở
#75 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
52/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
java
Lĩnh vực
build-system, devtools

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Java
Star
128
Fork
65
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của PaperMC/Paperclip

Tất cả issue của PaperMC/Paperclip

Issue tương tự

Thêm issue về Java

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.