Skip to content

Commit 4ed7774

Browse files
fangererolyagpl
authored andcommitted
[GR-58549] Update FFM API docs.
PullRequest: graal/21346
2 parents a35b05c + 3f652e0 commit 4ed7774

File tree

8 files changed

+808
-69
lines changed

8 files changed

+808
-69
lines changed

docs/reference-manual/native-image/AutomaticMetadataCollection.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ redirect_from: /reference-manual/native-image/Agent/
99
# Collect Metadata with the Tracing Agent
1010

1111
The Native Image tool relies on the static analysis of an application's reachable code at runtime.
12-
However, the analysis cannot always completely predict all usages of the Java Native Interface (JNI), Java Reflection, Dynamic Proxy objects, or class path resources.
12+
However, the analysis cannot always completely predict all usages of the Java Native Interface (JNI), Foreign Function and Memory (FFM) API, Java Reflection, Dynamic Proxy objects, or class path resources.
1313
Undetected usages of these dynamic features must be provided to the `native-image` tool in the form of [metadata](ReachabilityMetadata.md) (precomputed in code or as JSON configuration files).
1414

1515
Here you will find information how to automatically collect metadata for an application and write JSON configuration files.
@@ -194,4 +194,5 @@ An arbitrary number of `--input-dir` arguments with sets of configuration files
194194

195195
* [Build a Native Executable with Reflection](guides/build-with-reflection.md)
196196
* [Reachability Metadata](ReachabilityMetadata.md)
197-
* [Experimental Agent Options](ExperimentalAgentOptions.md)
197+
* [Experimental Agent Options](ExperimentalAgentOptions.md)
198+
* [Foreign Function and Memory API in Native Image](FFM-API.md)

docs/reference-manual/native-image/BuildOutput.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ GraalVM Native Image: Generating 'helloworld' (executable)...
3636
3,158 types, 3,625 fields, and 14,804 methods found reachable
3737
1,012 types, 36 fields, and 377 methods registered for reflection
3838
57 types, 57 fields, and 52 methods registered for JNI access
39+
0 downcalls and 0 upcalls registered for foreign access
3940
4 native libraries: dl, pthread, rt, z
4041
[3/8] Building universe... (0.8s @ 0.99GB)
4142
[4/8] Parsing methods... [*] (0.6s @ 0.75GB)
@@ -171,8 +172,8 @@ Large numbers can cause significant reflection overheads, slow down the build pr
171172
#### <a name="glossary-jni-access-registrations"></a>JNI Access Registrations
172173
The number of types, fields, and methods that are registered for [JNI](JNI.md) access.
173174

174-
#### <a name="glossary-foreign-downcall-and-upcall-registrations"></a>Foreign functions stubs
175-
The number of downcalls and upcalls registered for [foreign](ForeignInterface.md) function access.
175+
#### <a name="glossary-foreign-downcall-and-upcall-registrations"></a>Foreign Access Registrations
176+
The number of downcalls and upcalls registered for [foreign function access](FFM-API.md).
176177

177178
#### <a name="glossary-runtime-methods"></a>Runtime Compiled Methods
178179
The number of methods marked for runtime compilation.

docs/reference-manual/native-image/DynamicFeatures.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ The reference information here explains how Native Image handles some dynamic fe
1818
- [Accessing Resources](ReachabilityMetadata.md#resources)
1919
- [Certificate Management](CertificateManagement.md)
2020
- [Java Native Interface (JNI)](ReachabilityMetadata.md#java-native-interface)
21+
* [Foreign Function and Memory API in Native Image](FFM-API.md)
2122
- [JCA Security Services](JCASecurityServices.md)
2223
- [Reflection](ReachabilityMetadata.md#reflection)
2324
- [URL Protocols](URLProtocols.md)

0 commit comments

Comments
 (0)