Skip to content

Commit ca2076d

Browse files
olyagplolyagpl
authored
Merge pull request #312 from graalvm/ni-demos-refactoring-9
[GR-60094] Add demo for Optimize Size Using Build Reports guide.
2 parents bcf2be7 + a48f89a commit ca2076d

File tree

7 files changed

+254
-0
lines changed

7 files changed

+254
-0
lines changed

‎.github/workflows/native-image-emit-build-report.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: native-image/emit-build-report
2+
on:
3+
push:
4+
paths:
5+
- 'native-image/emit-build-report/**'
6+
- '.github/workflows/native-image-emit-build-report.yml'
7+
pull_request:
8+
paths:
9+
- 'native-image/emit-build-report/**'
10+
- '.github/workflows/native-image-emit-build-report.yml'
11+
schedule:
12+
- cron: "0 0 1 * *" # run every month
13+
workflow_dispatch:
14+
permissions:
15+
contents: read
16+
jobs:
17+
run:
18+
name: Run 'native-image/emit-build-report'
19+
runs-on: ubuntu-latest
20+
timeout-minutes: 15
21+
steps:
22+
- uses: actions/checkout@v4
23+
- uses: graalvm/setup-graalvm@v1
24+
with:
25+
java-version: '24-ea'
26+
distribution: 'graalvm'
27+
github-token: ${{ secrets.GITHUB_TOKEN }}
28+
cache: 'maven'
29+
native-image-job-reports: 'true'
30+
- name: Run 'native-image/emit-build-report'
31+
run: |
32+
cd native-image/emit-build-report
33+
./run.sh

‎native-image/emit-build-report/.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.class
2+
ithword-build-report.html
3+
ithword

‎native-image/emit-build-report/1-original/IthWord.java‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/*
2+
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* The Universal Permissive License (UPL), Version 1.0
6+
*
7+
* Subject to the condition set forth below, permission is hereby granted to any
8+
* person obtaining a copy of this software, associated documentation and/or
9+
* data (collectively the "Software"), free of charge and under any and all
10+
* copyright rights in the Software, and any and all patent rights owned or
11+
* freely licensable by each licensor hereunder covering either (i) the
12+
* unmodified Software as contributed to or provided by such licensor, or (ii)
13+
* the Larger Works (as defined below), to deal in both
14+
*
15+
* (a) the Software, and
16+
*
17+
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
18+
* one is included with the Software each a "Larger Work" to which the Software
19+
* is contributed by such licensors),
20+
*
21+
* without restriction, including without limitation the rights to copy, create
22+
* derivative works of, display, perform, and distribute the Software and make,
23+
* use, sell, offer for sale, import, export, have made, and have sold the
24+
* Software and the Larger Work(s), and to sublicense the foregoing rights on
25+
* either these or other terms.
26+
*
27+
* This license is subject to the following condition:
28+
*
29+
* The above copyright notice and either this complete permission notice or at a
30+
* minimum a reference to the UPL must be included in all copies or substantial
31+
* portions of the Software.
32+
*
33+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
39+
* SOFTWARE.
40+
*/
41+
42+
public class IthWord {
43+
public static String input = "foo \t , \t bar , baz";
44+
45+
public static void main(String[] args) {
46+
if (args.length < 1) {
47+
System.out.println("Word index is required, please provide one first.");
48+
return;
49+
}
50+
int i = Integer.parseInt(args[0]);
51+
52+
// Extract the word at the given index.
53+
String[] words = input.split("\\s+,\\s+");
54+
if (i >= words.length) {
55+
System.out.printf("Cannot get the word #%d, there are only %d words.%n", i, words.length);
56+
return;
57+
}
58+
59+
System.out.printf("Word #%d is %s.%n", i, words[i]);
60+
}
61+
}

‎native-image/emit-build-report/2-optimized/IthWord.java‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/*
2+
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* The Universal Permissive License (UPL), Version 1.0
6+
*
7+
* Subject to the condition set forth below, permission is hereby granted to any
8+
* person obtaining a copy of this software, associated documentation and/or
9+
* data (collectively the "Software"), free of charge and under any and all
10+
* copyright rights in the Software, and any and all patent rights owned or
11+
* freely licensable by each licensor hereunder covering either (i) the
12+
* unmodified Software as contributed to or provided by such licensor, or (ii)
13+
* the Larger Works (as defined below), to deal in both
14+
*
15+
* (a) the Software, and
16+
*
17+
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
18+
* one is included with the Software each a "Larger Work" to which the Software
19+
* is contributed by such licensors),
20+
*
21+
* without restriction, including without limitation the rights to copy, create
22+
* derivative works of, display, perform, and distribute the Software and make,
23+
* use, sell, offer for sale, import, export, have made, and have sold the
24+
* Software and the Larger Work(s), and to sublicense the foregoing rights on
25+
* either these or other terms.
26+
*
27+
* This license is subject to the following condition:
28+
*
29+
* The above copyright notice and either this complete permission notice or at a
30+
* minimum a reference to the UPL must be included in all copies or substantial
31+
* portions of the Software.
32+
*
33+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
39+
* SOFTWARE.
40+
*/
41+
42+
public class IthWord {
43+
public static String input = "foo \t , \t bar , baz";
44+
45+
public static void main(String[] args) {
46+
if (args.length < 1) {
47+
System.out.println("Word index is required, please provide one first.");
48+
return;
49+
}
50+
int i = Integer.parseInt(args[0]);
51+
52+
// Extract the word at the given index.
53+
String[] words = input.split("\\s+,\\s+");
54+
if (i >= words.length) {
55+
// Use System.out.println instead of System.out.printf.
56+
System.out.println("Cannot get the word #" + i + ", there are only " + words.length + " words.");
57+
return;
58+
}
59+
60+
// Use System.out.println instead of System.out.printf.
61+
System.out.println("Word #" + i + " is " + words[i] + ".");
62+
}
63+
}

‎native-image/emit-build-report/3-optimized/IthWord.java‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
/*
2+
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* The Universal Permissive License (UPL), Version 1.0
6+
*
7+
* Subject to the condition set forth below, permission is hereby granted to any
8+
* person obtaining a copy of this software, associated documentation and/or
9+
* data (collectively the "Software"), free of charge and under any and all
10+
* copyright rights in the Software, and any and all patent rights owned or
11+
* freely licensable by each licensor hereunder covering either (i) the
12+
* unmodified Software as contributed to or provided by such licensor, or (ii)
13+
* the Larger Works (as defined below), to deal in both
14+
*
15+
* (a) the Software, and
16+
*
17+
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
18+
* one is included with the Software each a "Larger Work" to which the Software
19+
* is contributed by such licensors),
20+
*
21+
* without restriction, including without limitation the rights to copy, create
22+
* derivative works of, display, perform, and distribute the Software and make,
23+
* use, sell, offer for sale, import, export, have made, and have sold the
24+
* Software and the Larger Work(s), and to sublicense the foregoing rights on
25+
* either these or other terms.
26+
*
27+
* This license is subject to the following condition:
28+
*
29+
* The above copyright notice and either this complete permission notice or at a
30+
* minimum a reference to the UPL must be included in all copies or substantial
31+
* portions of the Software.
32+
*
33+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
39+
* SOFTWARE.
40+
*/
41+
42+
public class IthWord {
43+
public static String input = "foo \t , \t bar , baz";
44+
45+
public static void main(String[] args) {
46+
if (args.length < 1) {
47+
System.out.println("Word index is required, please provide one first.");
48+
return;
49+
}
50+
int i = Integer.parseInt(args[0]);
51+
52+
// Extract the word at the given index using String.substring and String.indexOf.
53+
String word = input;
54+
int j = i, index;
55+
while (j > 0) {
56+
index = word.indexOf(',');
57+
if (index < 0) {
58+
// Use System.out.println instead of System.out.printf.
59+
System.out.println("Cannot get the word #" + i + ", there are only " + (i - j + 1) + " words.");
60+
return;
61+
}
62+
word = word.substring(index + 1);
63+
j--;
64+
}
65+
index = word.indexOf(',');
66+
if (index > 0) {
67+
word = word.substring(0, word.indexOf(','));
68+
}
69+
word = word.trim();
70+
71+
// Use System.out.println instead of System.out.printf.
72+
System.out.println("Word #" + i + " is " + word + ".");
73+
}
74+
}

‎native-image/emit-build-report/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Optimize Size of a Native Executable using Build Reports
2+
3+
You can find the steps to run this demo on [the website](https://www.graalvm.org/latest/reference-manual/native-image/guides/optimize-native-executable-size-using-build-report/).

‎native-image/emit-build-report/run.sh‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#!/usr/bin/env bash
2+
set -ex
3+
4+
cd 1-original
5+
javac IthWord.java
6+
native-image IthWord --emit build-report
7+
./ithword 1
8+
9+
cd ../2-optimized
10+
javac IthWord.java
11+
native-image IthWord --emit build-report
12+
./ithword 1
13+
14+
cd ../3-optimized
15+
javac IthWord.java
16+
native-image IthWord --emit build-report
17+
./ithword 1

0 commit comments

Comments
 (0)