Skip to content

Commit

Permalink
Note libffi error message in tmpdir docs (#83662)
Browse files Browse the repository at this point in the history
In #80617 we upgraded to a version of JNA which would report the message
`Failed to allocate closure` if the temp dir for `libffi` did not permit
executables (rather than crashing with a segfault). This commit extends
the docs to mention this message.
  • Loading branch information
DaveCTurner authored Feb 8, 2022
1 parent d6c6d29 commit 4e525d9
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions docs/reference/setup/sysconfig/executable-jna-tmpdir.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[executable-jna-tmpdir]]
=== JNA temporary directory not mounted with `noexec`
=== Ensure JNA temporary directory permits executables

[NOTE]
This is only relevant for Linux.
Expand All @@ -16,8 +16,9 @@ some hardened Linux installations mount `/tmp` with the `noexec` option by
default. This prevents JNA and `libffi` from working correctly. For instance,
at startup JNA may fail to load with an `java.lang.UnsatisfiedLinkerError`
exception or with a message that says something similar to
`failed to map segment from shared object`. Note that the exception message can
differ amongst JVM versions. Additionally, the components of {es} that rely on
`failed to map segment from shared object`, or `libffi` may report a message
such as `failed to allocate closure`. Note that the exception messages can
differ between JVM versions. Additionally, the components of {es} that rely on
execution of native code via JNA may fail with messages indicating that it is
`because JNA is not available`.

Expand All @@ -31,7 +32,9 @@ instance:
export ES_TMPDIR=/usr/share/elasticsearch/tmp
--------------------------------------------

Alternatively, you can configure the path that JNA uses for its temporary files
with the <<set-jvm-options,JVM flag>> `-Djna.tmpdir=<path>` and you can
configure the path that `libffi` uses for its temporary files with the
`LIBFFI_TMPDIR` environment variable.
If you need finer control over the location of these temporary files, you can
also configure the path that JNA uses with the <<set-jvm-options,JVM flag>>
`-Djna.tmpdir=<path>` and you can configure the path that `libffi` uses for its
temporary files by setting the `LIBFFI_TMPDIR` environment variable. Future
versions of {es} may need additional configuration, so you should prefer to set
`ES_TMPDIR` wherever possible.

0 comments on commit 4e525d9

Please sign in to comment.