RFR: 8338596: Clarify handling of restricted and caller-sensitive methods [v5]

David Holmes dholmes at openjdk.org
Wed Oct 2 01:53:39 UTC 2024


On Mon, 23 Sep 2024 21:06:12 GMT, Maurizio Cimadamore <mcimadamore at openjdk.org> wrote:

>> This PR moves the section on restricted methods from the the javadoc of `java.lang.foreign` package into a standalone static [javadoc page](https://cr.openjdk.org/~mcimadamore/jdk/restricted_javadoc_section/docs/api/java.base/java/lang/foreign/doc-files/RestrictedMethods.html).
>> 
>> This is because, after [JEP 472](https://openjdk.org/jeps/472), we now have restricted methods *outside* the foreign package, namely `System::loadLibrary`, `Runtime::loadLibrary` (and related methods). And, even before, we also had a restricted method in `ModuleLayer.Controller`.
>> 
>> The new static page contains some guidance of what happens when a restricted method is called when there's no Java frame on the stack (this can happen e.g. when upcalling into a restricted method from a native thread not known to the JVM) - that is, the call is treated as originating from an unnamed module.
>> 
>> The static page is linked from the restricted method banner in a restricted method javadoc. Here's an [example](https://cr.openjdk.org/~mcimadamore/jdk/restricted_javadoc_section/docs/api/java.base/java/lang/foreign/Linker.html#downcallHandle(java.lang.foreign.MemorySegment,java.lang.foreign.FunctionDescriptor,java.lang.foreign.Linker.Option...)).
>
> Maurizio Cimadamore has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Fix javadoc test failure

src/java.base/share/classes/java/lang/doc-files/RestrictedMethods.html line 40:

> 38:     be disabled by granting access to restricted methods to selected modules. This can be
> 39:     done either via implementation-specific command line options or programmatically, e.g.
> 40:     by calling <a href="../../ModuleLayer.Controller.html#enableNativeAccess(java.lang.Module)"><code>ModuleLayer.Controller.enableNativeAccess(java.lang.Module)</code></a>.</p>

Given the very generic preceding description of "restricted methods" with no actual example, the fact this method is called `enableNativeAccess` really stands out as odd. One would expect it to be `enableRestrictedAccess`.

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/21067#discussion_r1772686695


More information about the core-libs-dev mailing list