-
Notifications
You must be signed in to change notification settings - Fork 25k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs on JNA temp directory not being noexec (#35355)
If the underlying mount point for the JNA temporary directory is mounted noexec on Linux, then the JVM will not be able to map the native code in as executable. This will prevent JNA from executing and will prevent Elasticsearch from being able to execute some functions that rely on native code (e.g., memory locking, and installing system call filters). We do not want to get into the business of catching exceptions and parsing messages towards this because these exception messages can change on us. We also do not want to jump through a lot of hoops to check the underlying mount point for noexec. Instead, we will rely on documentation to address this problem. This commit adds to the important system configuration section of the docs that the JNA temporary directory is not on a mount point with the noexec mount option.
- Loading branch information
1 parent
6bd3f4c
commit 72e615a
Showing
3 changed files
with
32 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
docs/reference/setup/sysconfig/executable-jna-tmpdir.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
[[executable-jna-tmpdir]] | ||
=== JNA temporary directory not mounted with `noexec` | ||
|
||
[NOTE] | ||
This is only relevant for Linux. | ||
|
||
Elasticsearch uses the Java Native Access (JNA) library for executing some | ||
platform-dependent native code. On Linux, the native code backing this library | ||
is extracted at runtime from the JNA archive. By default, this code is extracted | ||
to the Elasticsearch temporary directory which defaults to a sub-directory of | ||
`/tmp`. Alternatively, this location can be controlled with the JVM flag | ||
`-Djna.tmpdir=<path>`. As the native library is mapped into the JVM virtual | ||
address space as executable, the underlying mount point of the location that | ||
this code is extracted to must *not* be mounted with `noexec` as this prevents | ||
the JVM process from being able to map this code as executable. On some hardened | ||
Linux installations this is a default mount option for `/tmp`. One indication | ||
that the underlying mount is mounted with `noexec` is that at startup JNA will | ||
fail to load with a `java.lang.UnsatisfiedLinkerError` exception with a message | ||
along the lines of `failed to map segment from shared object`. Note that the | ||
exception message can differ amongst JVM versions. Additionally, the components | ||
of Elasticsearch that rely on execution of native code via JNA will fail with | ||
messages indicating that it is `because JNA is not available`. If you are seeing | ||
such error messages, you must remount the temporary directory used for JNA to | ||
not be mounted with `noexec`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters