Create source cache when building native in container #12283 #12294

galderz · 2020-09-23T13:37:43Z

Let Mandrel/GraalVM decide where to put the source cache, which naturally leads to a folder that's stored within the module shared with container.
Copy the application sources in advance, to avoid the need to make src/main/java available to the container.
Update documentation.

* Let Mandrel/GraalVM decide where to put the source cache, which naturally leads to a folder that's stored within the module shared with container. * Copy the application sources in advance, to avoid the need to make src/main/java available to the container.

geoand · 2020-09-24T08:14:56Z

Seems like CI failed... But it does look unrelated - I'll restart the job just to be on the safe side

geoand · 2020-09-24T14:41:07Z

@rsvoboda can you verify this one?

rsvoboda · 2020-09-24T16:41:16Z

I don't have much context for this, I can take a look tmr, I need to tackle few things before looking into this. @Karm / @jerboaa, would it be possible to take a look?

geoand · 2020-09-24T17:02:11Z

Thanks 👍

jerboaa · 2020-09-24T17:50:53Z

I'll try to take a look tomorrow.

geoand · 2020-09-25T13:53:41Z

Any news on validating this?

rsvoboda · 2020-09-25T13:57:56Z

It's weird, like if Quarkus master with this patch is not providing debug info at all

I have sample app created using:

mvn io.quarkus:quarkus-maven-plugin:1.8.1.Final:create \
    -DprojectGroupId=org.acme \
    -DprojectArtifactId=getting-started \
    -DclassName="org.acme.getting.started.GreetingResource" \
    -Dpath="/hello"
cd getting-started

Debug enabled:

cat src/main/resources/application.properties
quarkus.native.debug.enabled=true

When running mvn clean package -Dnative -Dquarkus.native.container-build=true I can see -H:DebugInfoSourceSearchPath=../../src/main/java -H:DebugInfoSourceCacheRoot=/Users/rsvoboda/tmp/getting-started/target/sources-cache in docker run command

But when running mvn clean package -Dnative -Dquarkus.native.container-build=true -Dquarkus.platform.artifact-id=quarkus-bom -Dquarkus.platform.version=999-SNAPSHOT -Dquarkus-plugin.version=999-SNAPSHOT there is no such info in docker run command, like if debug is not enabled at all

geoand · 2020-09-25T14:00:46Z

@galderz can you shine some light here please?

zakkak · 2020-09-25T14:43:56Z

When running mvn clean package -Dnative -Dquarkus.native.container-build=true I can see -H:DebugInfoSourceSearchPath=../../src/main/java -H:DebugInfoSourceCacheRoot=/Users/rsvoboda/tmp/getting-started/target/sources-cache in docker run command

But when running mvn clean package -Dnative -Dquarkus.native.container-build=true -Dquarkus.platform.artifact-id=quarkus-bom -Dquarkus.platform.version=999-SNAPSHOT -Dquarkus-plugin.version=999-SNAPSHOT there is no such info in docker run command, like if debug is not enabled at all

That's expected, judging by the diff of this PR.

Testing locally...

rsvoboda · 2020-09-25T14:48:21Z

JIRA says: This value should work for DebugInfoSourceCacheRoot: -H:DebugInfoSourceCacheRoot=/project/source-cache
That's why I expected to see this property to be set.

So this PR removes command.add("-H:DebugInfoSourceSearchPath=" + javaSourcesPath.toString()); and command.add("-H:DebugInfoSourceCacheRoot=" + sourcesCachePath.toString());

and copies .jar bits and sources into target/getting-started-1.0-SNAPSHOT-native-image-source-jar/ in case of my application

Why is -H:DebugInfoSourceSearchPath and -H:DebugInfoSourceCacheRoot no longer needed to be set?

jerboaa · 2020-09-25T15:26:14Z

It's weird, like if Quarkus master with this patch is not providing debug info at all

I have sample app created using:
mvn io.quarkus:quarkus-maven-plugin:1.8.1.Final:create \
    -DprojectGroupId=org.acme \
    -DprojectArtifactId=getting-started \
    -DclassName="org.acme.getting.started.GreetingResource" \
    -Dpath="/hello"
cd getting-started
Debug enabled:
cat src/main/resources/application.properties
quarkus.native.debug.enabled=true
When running mvn clean package -Dnative -Dquarkus.native.container-build=true I can see -H:DebugInfoSourceSearchPath=../../src/main/java -H:DebugInfoSourceCacheRoot=/Users/rsvoboda/tmp/getting-started/target/sources-cache in docker run command

But when running mvn clean package -Dnative -Dquarkus.native.container-build=true -Dquarkus.platform.artifact-id=quarkus-bom -Dquarkus.platform.version=999-SNAPSHOT -Dquarkus-plugin.version=999-SNAPSHOT there is no such info in docker run command, like if debug is not enabled at all

After the patch, you should see -g added for an image which actually supports debug symbols. AFAIK, the default image is a Graal CE one, so try using -Dquarkus.native.builder-image=quay.io/quarkus/ubi-quarkus-mandrel:20.1-java11 That one should enter the path this patch touches.

jerboaa · 2020-09-25T15:34:33Z

Why is -H:DebugInfoSourceSearchPath and -H:DebugInfoSourceCacheRoot no longer needed to be set?

Default for DebugInfoSourceCacheRoot is sources in $PWD. So the copy of app sources to the rightly mapped container folder would cover the application sources bits. I'm trying to verify this myself too now. First time building quarkus, though. It'll be slow.

The expectation would be for the source cache (Graal tries to produce a directory of all sources which make up the native image) to contain relevant JDK classes (from src.zip), Graal classes, from *src.zip files, and application classes.

zakkak · 2020-09-25T15:37:53Z

Why is -H:DebugInfoSourceSearchPath and -H:DebugInfoSourceCacheRoot no longer needed to be set?

Default for DebugInfoSourceCacheRoot is sources in $PWD, not sure about the former. I'm trying to verify this myself too now. First time building quarkus, though. It'll be slow.

Default DebugInfoSourceSearchPath is empty, and Graal checks $PWD in this case. So by copying the sources @galderz makes sure native-image will have access to them without the need of -H:DebugInfoSourceSearchPath

galderz · 2020-09-25T15:38:07Z

@rsvoboda They're not set any more because they're not needed, given the preferred location for container environments. To be more precise:

Not using -H:DebugInfoSourceCacheRoot the source cache falls within the folder that's volumed across to the container. I had used it to bring the sources cache folder to be right under target/ but as seen, that causes issues on containers. So, as also indicated by the documentation update, I've gone for the default location.
Not using -H:DebugInfoSourceSearchPath any more since it was referencing a location outside of of the volumed folder. Instead, I manually copied the sources across before native-image invocation and then the sources are located in the right place.

zakkak · 2020-09-25T15:55:20Z

Non-blocking issue I see with the PR at its current state.

The user experience is not ideal. One has to run

(gdb) set directories getting-started-1.0-SNAPSHOT-native-image-source-jar/sources/jdk:getting-started-1.0-SNAPSHOT-native-image-source-jar/sources/src

for it to work.

This is happening because the binary is placed in a different folder than the sources directory using -H:DebugInfoSourceCacheRoot to place the sources next to the binary would fix that.

Other than that it worked fine for me for both a container-base and a graalvm-home-based build.

galderz · 2020-09-25T15:59:36Z

This is happening because the binary is placed in a different folder than the sources directory using -H:DebugInfoSourceCacheRoot to place the sources next to the binary would fix that.

Hmmm, you mean the sources dir has to be next to the executable? If so, that might be hard to achieve due to the original issue, which sets a volume starting in getting-started-1.0-SNAPSHOT-native-image-source-jar/ and that's a level up from the binary... I'd have to run it again to see how it manages to set the binary output a folder below.

zakkak · 2020-09-25T16:04:01Z

The transfer happens after the build:

[INFO] [io.quarkus.deployment.pkg.steps.NativeImageBuildStep] Execute [objcopy, --only-keep-debug, /tmp/getting-started/target/getting-started-1.0-SNAPSHOT-runner, /tmp/getting-started/target/getting-started-1.0-SNAPSHOT-runner.debug]
[INFO] [io.quarkus.deployment.pkg.steps.NativeImageBuildStep] Execute [objcopy, --add-gnu-debuglink=/tmp/getting-started/target/getting-started-1.0-SNAPSHOT-runner.debug, /tmp/getting-started/target/getting-started-1.0-SNAPSHOT-runner]
[INFO] [io.quarkus.deployment.pkg.steps.NativeImageBuildStep] Execute [objcopy, --strip-debug, /tmp/getting-started/target/getting-started-1.0-SNAPSHOT-runner]

So we can do another copy and bring the sources next to the binary :)

zakkak · 2020-09-25T16:05:57Z

Sorry the copying actually happens here

quarkus/core/deployment/src/main/java/io/quarkus/deployment/pkg/steps/NativeImageBuildStep.java

Line 329 in ec9a5ff

IoUtils.copy(generatedImage, finalPath);

So I would expect something like:

if (nativeConfig.debug.enabled) {
    IoUtils.copy(outputDir.resolve("sources"), outputTargetBuildItem.getOutputDirectory().resolve("sources"));
}

to do the trick.

jerboaa

This seems to be working fine for me. Bug is fixed. The UX improvement can be implemented as a follow-up, IMO.

rsvoboda

Approving, the main trouble is solved. User experience can be improved in follow-up PR.

rsvoboda · 2020-09-25T17:37:22Z

@jerboaa / @zakkak / @galderz thanks for explaining the details.
Can you please create follow-up issue to improve user experience (bring the sources next to the binary)?

rsvoboda · 2020-09-25T17:38:08Z

@geoand I think PR is ready for merge

geoand · 2020-09-25T17:39:56Z

Great!

geoand · 2020-09-25T17:41:08Z

I'll attempt a release with these fixes over the weekend

geoand added triage/backport? labels Sep 24, 2020

jerboaa approved these changes Sep 25, 2020

View reviewed changes

rsvoboda approved these changes Sep 25, 2020

View reviewed changes

geoand merged commit 80d9d46 into quarkusio:master Sep 25, 2020

geoand added this to the 1.9.0 - master milestone Sep 25, 2020

geoand removed the triage/backport-1.7? label Sep 25, 2020

zakkak mentioned this pull request Sep 25, 2020

Improve Debugging experience by copying sources #12351

Merged

geoand removed the triage/backport? label Sep 29, 2020

geoand modified the milestones: 1.9.0 - master, 1.7.4.Final Sep 29, 2020

Karm mentioned this pull request Sep 30, 2020

GDB: Line numbers off, Thread names missing characters, Quarkus: galderz/quarkus/tree/t_sourcecache_container_12283 graalvm/mandrel#141

Closed

gsmet added triage/backport? and removed triage/backport? labels Oct 1, 2020

zakkak mentioned this pull request Oct 6, 2020

Native image, -Dquarkus.native.debug.enabled=true, Quarkus 1.8+ does not copy sources; Quarkus 1.7.x does graalvm/mandrel#145

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create source cache when building native in container #12283 #12294

Create source cache when building native in container #12283 #12294

galderz commented Sep 23, 2020

geoand commented Sep 24, 2020

geoand commented Sep 24, 2020

rsvoboda commented Sep 24, 2020 •

edited

geoand commented Sep 24, 2020

jerboaa commented Sep 24, 2020

geoand commented Sep 25, 2020

rsvoboda commented Sep 25, 2020

geoand commented Sep 25, 2020

zakkak commented Sep 25, 2020

rsvoboda commented Sep 25, 2020 •

edited

jerboaa commented Sep 25, 2020

jerboaa commented Sep 25, 2020 •

edited

zakkak commented Sep 25, 2020

galderz commented Sep 25, 2020

zakkak commented Sep 25, 2020

galderz commented Sep 25, 2020

zakkak commented Sep 25, 2020

zakkak commented Sep 25, 2020 •

edited

jerboaa left a comment

rsvoboda left a comment

rsvoboda commented Sep 25, 2020

rsvoboda commented Sep 25, 2020

geoand commented Sep 25, 2020

geoand commented Sep 25, 2020

Create source cache when building native in container #12283 #12294

Create source cache when building native in container #12283 #12294

Conversation

galderz commented Sep 23, 2020

geoand commented Sep 24, 2020

geoand commented Sep 24, 2020

rsvoboda commented Sep 24, 2020 • edited

geoand commented Sep 24, 2020

jerboaa commented Sep 24, 2020

geoand commented Sep 25, 2020

rsvoboda commented Sep 25, 2020

geoand commented Sep 25, 2020

zakkak commented Sep 25, 2020

rsvoboda commented Sep 25, 2020 • edited

jerboaa commented Sep 25, 2020

jerboaa commented Sep 25, 2020 • edited

zakkak commented Sep 25, 2020

galderz commented Sep 25, 2020

zakkak commented Sep 25, 2020

galderz commented Sep 25, 2020

zakkak commented Sep 25, 2020

zakkak commented Sep 25, 2020 • edited

jerboaa left a comment

Choose a reason for hiding this comment

rsvoboda left a comment

Choose a reason for hiding this comment

rsvoboda commented Sep 25, 2020

rsvoboda commented Sep 25, 2020

geoand commented Sep 25, 2020

geoand commented Sep 25, 2020

rsvoboda commented Sep 24, 2020 •

edited

rsvoboda commented Sep 25, 2020 •

edited

jerboaa commented Sep 25, 2020 •

edited

zakkak commented Sep 25, 2020 •

edited