Skip to contentSkip to conversation

contrib/plugins: add dlcall to call host functions from a guest

PATCH Superseded Ziyang Zhang 2 participants 9 messages Jul 8 – Jul 9 Arm/Amlogic Meson SoC support

v7 of 12 Superseded Latest is v12 →

lore
Share & tools
lore
#0 lore raw

v7 cover contrib/plugins: add dlcall to call host functions from a guest

Hi,

This patch adds a single plugin, contrib/plugins/dlcall.c (~250 lines, no changes to QEMU core), that lets a linux-user guest call functions in the host's native shared libraries instead of emulating them.

It is the natural next step on top of the vCPU syscall-filter callback that I contributed and that was merged earlier:

https://lore.kernel.org/qemu-devel/[email protected]/

Why bother? Because it turns slow, instruction-by-instruction emulation of a library into a native host call. Some results, all on completely unmodified guest binaries:

* minizip (the stock zlib utility) compresses several times faster, because the actual deflate runs natively on the host instead of being translated.
* Real OpenGL/Vulkan games run under qemu-user: SuperTuxKart and Hollow Knight are playable, with their graphics calls going straight to the host GPU.

How it works
============

The guest makes a system call with a reserved number (4096 by default) that no real Linux ABI uses. Its first argument selects a pass-through operation, and the rest carry operands:

syscall(4096, op, arg1, arg2, ...)

          |     |    \............ operands (pointers / values)
          |     \................. which pass-through operation
          \....................... the reserved "magic" number

The plugin registers a vCPU syscall filter: before QEMU forwards a syscall to the host kernel, the filter runs, sees 4096, performs the operation on the host, writes the result back, and tells QEMU the syscall is consumed, so the real kernel never sees it.

The whole interface is just a handful of primitives:

* query a host attribute
* dlopen / dlclose a host shared library
* dlsym a symbol, and read the last dlerror
* invoke a resolved host function with a void(void *, void *) signature

That is all the plugin does. It knows nothing about zlib, X11 or OpenGL, or about any library's calling convention.

The same machinery also runs in reverse: when a host function needs to call back into the guest (a qsort comparator, an allocator, a GUI or game callback), control re-enters the guest to run the callback and then resumes the suspended host call. This reentry is what lets stateful, callback-driven APIs work, not just leaf functions.

Why the plugin belongs in QEMU, and the rest does not
=====================================================

Only the plugin lives in the tree. Everything else is ordinary userspace:

--- userspace (out of tree, not tied to any DBT) -------------

      guest: unmodified program  ->  guest runtime + thunk libs
  --------------------------------------------------------------
                 |  syscall(4096, op, args)   (only crossing point)
                 v
  === inside QEMU: THIS PATCH, ~250 lines ======================
      dlcall plugin:  dlopen / dlsym / invoke a host fn
  ==============================================================
                 |
                 v
  --- userspace (out of tree) ----------------------------------
      host: host runtime + thunk libs  ->  real libz / libGL ...

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

The split is deliberate, and it is why only this one file is proposed for the tree:

* This plugin defines the most general interaction interface for native
pass-through: the magic-syscall ABI between an emulated guest and its emulator. That contract is what every pass-through implementation builds on, so it belongs in a stable, shared place.
* It is also the only piece that is inherently QEMU-specific: it plugs into QEMU's syscall-filter hook and runs inside the QEMU process. The argument marshalling, calling conventions, callbacks/reentry and per-library coverage are not tied to any particular DBT and behave as ordinary userspace, so they should stay out of tree rather than couple QEMU to them.

Background: we presented this approach at KVM Forum 2025, "Lorelei: Enable QEMU to Leverage Native Shared Libraries":

https://www.youtube.com/watch?v=_jioQFm7wyU

The userspace side
==================

A fair point on v3 was that, on its own, the plugin is only half of an
interface: useful only if the other half (the guest/host runtimes and the per-library thunks) is public and specified, rather than a private demo. That half is now available as a standalone, documented, CI-tested project, Lorelei:

https://github.com/rover2024/lorelei

Lorelei provides the guest and host runtimes and a Thunk Library Compiler (TLC, built on Clang LibTooling) that reads a library's headers and generates the guest and host thunks automatically, including the awkward cases of function-pointer callbacks and variadic functions. It has CI for x86_64, arm64 and riscv64 hosts. Lorelei and its thunk libraries are MIT-licensed.

Adding a thunk is deliberately little work, and needs nothing but a release. Lorelei's releases ship a prebuilt toolchain (a "devkit"); after unpacking one, a single command reads a library and its headers and generates both the guest and host thunks, with no per-function code, no manifest and no build system to drive:

  devkit/bin/LoreMakeThunk.py --name z --lib libz.so.1 --header zlib.h -o thunks

Two runnable examples come with Lorelei, each with a Makefile that does exactly this and runs the example under the plugin in one step:

* hello, a minimal one-function library:
https://github.com/rover2024/lorelei/tree/main/examples/hello
* demo, variadic functions and a callback that reenters the guest:
https://github.com/rover2024/lorelei/tree/main/examples/demo

If you do not have qemu or an x86_64 rootfs on hand, the project also ships a small Docker setup that builds qemu and runs the examples for you, so a single command reproduces the whole flow.

Because the plugin is not upstream yet, Lorelei currently builds and tests against the QEMU fork that carries it. Its releases ship prebuilt guest and host thunk trees for x86_64, aarch64 and riscv64 hosts, so trying it out does not require building from source:

https://github.com/rover2024/lorelei/releases

The plugin stays deliberately minimal and prescribes nothing about how thunking is done. Lorelei is one reference implementation of the userspace side. Any toolchain, or another instrumentation framework, can implement the same dlcall interface.

A from-scratch walkthrough of the bare mechanism, with the minizip and OpenGL/X11 examples above, is also available here:

https://github.com/rover2024/qemu-passthrough-test

It is fully opt-in (loaded with -plugin) and targets linux-user, where the guest and host already share a trust domain. The test cases use x86_64 guests and run on x86_64, arm64 and riscv64 Linux hosts.

Feedback on the plugin and on the pass-through approach is welcome.

Changes since v6:

Addressing Pierrick Bouvier's v6 request that trying the userspace side need only the release, with no second repository to clone:

* The thunk generator now ships inside the devkit that Lorelei's releases provide, as bin/LoreMakeThunk.py. After unpacking a devkit, a single command reads a library and its headers and generates both the guest and host thunks, producing all the boilerplate itself. It takes plain command-line arguments, with no manifest or config file and no cmake/make/git behind it, so the whole flow is: download a devkit, run one command, run the guest under the plugin.
* docs/about/emulation.rst: rewrote the hello walkthrough to that flow (download a devkit, one LoreMakeThunk command, run under the plugin) and pointed the example links at the lorelei repository, where the examples now live. The plugin code is unchanged.

Changes since v5:

Following a discussion with Pierrick Bouvier on making the userspace side easy to try, this version focuses on that.

* docs/about/emulation.rst: expanded the example into a runnable hello walkthrough (the wrapped one-function library and its thunk manifest) and added links to the two example directories, hello and demo. Each example comes with a Makefile that builds the thunk and runs it under the plugin in one command, plus a small Docker setup for hosts without qemu or an x86_64 rootfs. Also reframed the section as a dynamic linking function call interception mechanism (tracing/auditing as further uses, acceleration as one use) and renamed it to "Dynamic Linking Call".
* The plugin header now names it "dlcall (Dynamic Linking Call)" and refers to Lorelei as one end-to-end userspace implementation. The plugin code is otherwise unchanged.

Changes since v4:

* Added a documentation patch for docs/about/emulation.rst (Pierrick Bouvier): what the plugin does, its trusted-guests and guest_base == 0 constraints, how to load it, and a minimal example, with a pointer to Lorelei.
* The plugin's header comment now points to Lorelei as one userspace implementation. The plugin code is otherwise unchanged.

Changes since v3:

* Lorelei, the userspace toolchain that implements this interface, is now a public, documented, CI-tested project, with a Thunk Library Compiler that generates the guest/host thunks automatically. This addresses the v3 feedback that the interface needs a public implementation behind it. The plugin code itself is unchanged.

Changes since v2:

* Dropped the RFC tag. The approach was positively received on v2.
* Rebased on master and adjusted the syscall-filter callback to its updated signature (int64_t sysret, added userdata, dropped the plugin id argument).

Changes since v1:

* Renamed the plugin from "passthrough" to "dlcall" (Pierrick Bouvier). The old name was too generic. The name "dlcall" reflects what the plugin actually does (dlopen/dlsym a host symbol and call it) and avoids confusion with QEMU's existing plugin hostcall concept (QEMU_PLUGIN_*_HOSTCALL).
* Made the magic syscall number configurable at load time via the "syscall_num=N" argument, defaulting to 4096 and rejecting values low enough to clash with a real syscall (Pierrick Bouvier).

v1: https://lore.kernel.org/qemu-devel/[email protected]/
v2: https://lore.kernel.org/qemu-devel/[email protected]/
v3: https://lore.kernel.org/qemu-devel/[email protected]/
v4: https://lore.kernel.org/qemu-devel/[email protected]/
v5: https://lore.kernel.org/qemu-devel/[email protected]/
v6: https://lore.kernel.org/qemu-devel/[email protected]/

Thanks,
Ziyang Zhang

Ziyang Zhang (2):
contrib/plugins: add a minimal dlcall plugin docs/about/emulation: document the dlcall plugin

 contrib/plugins/dlcall.c    | 248 ++++++++++++++++++++++++++++++++++++
 contrib/plugins/meson.build |   5 +
 docs/about/emulation.rst    | 122 ++++++++++++++++
 3 files changed, 375 insertions(+)
 create mode 100644 contrib/plugins/dlcall.c
Signature · 1 line
2.34.1
#1 lore raw

PATCH v7 1/2 contrib/plugins: add a minimal dlcall plugin

Add a minimal dlcall plugin that lets the guest invoke host functions through magic system calls. The plugin registers a vCPU syscall filter callback that intercepts a reserved syscall number and dispatches a set of pass-through operations: querying host attributes, loading and freeing shared libraries, resolving symbols, retrieving the last library error, and invoking a host function through a common interface.

The magic syscall number defaults to 4096 and can be overridden at load time with the "syscall_num=N" argument; values low enough to clash with a real syscall are rejected.

---
 contrib/plugins/dlcall.c    | 248 ++++++++++++++++++++++++++++++++++++
 contrib/plugins/meson.build |   5 +
 2 files changed, 253 insertions(+)
 create mode 100644 contrib/plugins/dlcall.c
contrib/plugins/dlcall.c new file +248 -0
new file mode 100644
index 0000000000..9d2230b2d1
@@ -0,0 +1,248 @@
+/*
+ * Copyright (C) 2026, Ziyang Zhang <[email protected]>
+ *
+ * dlcall (Dynamic Linking Call) plugin: lets a linux-user guest invoke host
+ * functions by issuing a magic system call. The guest can ask QEMU to dlopen()
+ * a host shared library, dlsym() a symbol, and call it with guest-supplied
+ * arguments.
+ *
+ * The plugin intentionally keeps the QEMU side lightweight and prescribes
+ * nothing about how a library is thunked. Any toolchain can implement the
+ * userspace side. Lorelei is one end-to-end implementation (guest/host
+ * runtimes plus a thunk compiler that generates thunks from a library's
+ * headers):
+ * https://github.com/rover2024/lorelei
+ *
+ * See docs/about/emulation.rst|Dynamic Linking Call for details and examples.
+ *
+ * WARNING: trusted guests only. The guest can load arbitrary host libraries
+ * and execute arbitrary host code with arbitrary arguments, i.e. full code
+ * execution in the QEMU host process. It is NOT a sandbox and provides no
+ * isolation; only load it for guests you fully trust.
+ *
+ * WARNING: requires guest_base == 0, which is qemu-user's default. Pointer
+ * operands are dereferenced as host addresses directly, and the invoked host
+ * functions dereference guest pointers with no address translation, so guest
+ * and host must share a single address space. A non-zero guest_base (e.g. set
+ * via -B/-R) would make every pointer off by guest_base and hit unrelated
+ * host memory.
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#include <assert.h>
+#include <errno.h>
+#include <string.h>
+#include <stdio.h>
+#include <glib.h>
+#include <dlfcn.h>
+
+#include <qemu-plugin.h>
+
+QEMU_PLUGIN_EXPORT int qemu_plugin_version = QEMU_PLUGIN_VERSION;
+
+/*
+ * The magic system call number for dlcall.
+ *
+ * It defaults to DLCALL_SYSCALL_DEFAULT and can be overridden at load time
+ * with the "syscall_num=N" argument. To avoid hijacking a real syscall the
+ * guest might issue, N must be at least DLCALL_SYSCALL_MIN: every Linux ABI
+ * keeps its syscall numbers well below this; numbers from here up are free.
+ */
+enum {
+    DLCALL_SYSCALL_DEFAULT = 4096,
+    DLCALL_SYSCALL_MIN = 4096,
+};
+
+static int64_t dlcall_syscall_num = DLCALL_SYSCALL_DEFAULT;
+
+/*
+ * dlcall calling convention.
+ *
+ * The guest issues the magic system call (dlcall_syscall_num). The first
+ * argument (a1) is one of the call IDs below; the remaining arguments (a2, a3,
+ * a4, ...) are that ID's operands. All pointer operands are guest virtual
+ * addresses that the plugin dereferences as host addresses directly (see the
+ * guest_base requirement above). Results are written back through
+ * caller-provided "out" pointers rather than returned in the syscall value.
+ *
+ * The syscall return value (*sysret) only reports dispatch status: 0 on a
+ * recognised ID, -EINVAL for an unknown one. The actual success/failure of an
+ * operation (e.g. a NULL handle from dlopen) is delivered through its out
+ * pointer, exactly like the underlying libdl call.
+ *
+ * Operands per ID:
+ *
+ *   DLCALL_ID_GET_HOST_ATTRIBUTE
+ *     a2  const char *key        in:  attribute name to query
+ *     a3  const char **attr_ptr  out: matching value, or NULL if unknown
+ *
+ *   DLCALL_ID_LOAD_LIBRARY                            (wraps dlopen)
+ *     a2  const char *path       in:  library path
+ *     a3  int flags              in:  dlopen() flags (e.g. RTLD_NOW)
+ *     a4  void **handle_ptr      out: library handle, or NULL on failure
+ *
+ *   DLCALL_ID_GET_PROC_ADDRESS                        (wraps dlsym)
+ *     a2  void *handle           in:  library handle
+ *     a3  const char *name       in:  symbol name
+ *     a4  void **entry_ptr       out: symbol address, or NULL if not found
+ *
+ *   DLCALL_ID_FREE_LIBRARY                            (wraps dlclose)
+ *     a2  void *handle           in:  library handle
+ *     a3  int *ret_ptr           out: dlclose() return value (0 on success)
+ *
+ *   DLCALL_ID_GET_LIBRARY_ERROR                       (wraps dlerror)
+ *     a2  const char **error_ptr out: last libdl error string, or NULL
+ *
+ *   DLCALL_ID_INVOKE_PROC                             (calls the symbol)
+ *     a2  void *proc             in:  function pointer, signature
+ *                                     void (*)(void *arg1, void *arg2)
+ *     a3  void *arg1             in:  first argument forwarded to proc
+ *     a4  void *arg2             in:  second argument forwarded to proc
+ */
+enum DlcallID {
+    DLCALL_ID_GET_HOST_ATTRIBUTE,
+    DLCALL_ID_LOAD_LIBRARY,
+    DLCALL_ID_GET_PROC_ADDRESS,
+    DLCALL_ID_FREE_LIBRARY,
+    DLCALL_ID_GET_LIBRARY_ERROR,
+    DLCALL_ID_INVOKE_PROC,
+};
+
+static inline const char *query_host_attribute(const char *key)
+{
+    if (strcmp(key, "emu") == 0) {
+        return "qemu";
+    }
+    return NULL;
+}
+
+static inline void invoke_proc(void *proc, void *arg1, void *arg2)
+{
+    typedef void (*Func)(void * /*arg1*/, void * /*arg2*/);
+    Func func = (Func) proc;
+    func(arg1, arg2);
+}
+
+static bool vcpu_syscall_filter(unsigned int vcpu_index,
+                                int64_t num, uint64_t a1, uint64_t a2,
+                                uint64_t a3, uint64_t a4, uint64_t a5,
+                                uint64_t a6, uint64_t a7, uint64_t a8,
+                                int64_t *sysret, void *userdata)
+{
+    if (num == dlcall_syscall_num) {
+        switch (a1) {
+        /* Query host attribute by a reserved key. */
+        case DLCALL_ID_GET_HOST_ATTRIBUTE: {
+            const char *key = (const char *) a2;
+            const char **attr_ptr = (const char **) a3;
+            assert(attr_ptr);
+            *attr_ptr = query_host_attribute(key);
+            *sysret = 0;
+            break;
+        }
+
+        /* Load a shared library. */
+        case DLCALL_ID_LOAD_LIBRARY: {
+            const char *path = (const char *) a2;
+            int flags = (int) a3;
+            void **handle_ptr = (void **) a4;
+            assert(handle_ptr);
+            *handle_ptr = dlopen(path, flags);
+            *sysret = 0;
+            break;
+        }
+
+        /* Get the address of a function in a shared library. */
+        case DLCALL_ID_GET_PROC_ADDRESS: {
+            void *handle = (void *) a2;
+            const char *name = (const char *) a3;
+            void **entry_ptr = (void **) a4;
+            assert(entry_ptr);
+            *entry_ptr = dlsym(handle, name);
+            *sysret = 0;
+            break;
+        }
+
+        /* Free a shared library. */
+        case DLCALL_ID_FREE_LIBRARY: {
+            void *handle = (void *) a2;
+            int *ret_ptr = (int *) a3;
+            *ret_ptr = dlclose(handle);
+            *sysret = 0;
+            break;
+        }
+
+        /* Get the last error message for a library event. */
+        case DLCALL_ID_GET_LIBRARY_ERROR: {
+            const char **error_ptr = (const char **) a2;
+            *error_ptr = dlerror();
+            *sysret = 0;
+            break;
+        }
+
+        /* Invoke a function of a common interface. */
+        case DLCALL_ID_INVOKE_PROC: {
+            void *proc = (void *) a2;
+            void *arg1 = (void *) a3;
+            void *arg2 = (void *) a4;
+            assert(proc);
+            invoke_proc(proc, arg1, arg2);
+            *sysret = 0;
+            break;
+        }
+
+        default:
+            *sysret = -EINVAL;
+            break;
+        }
+        return true;
+    }
+    return false;
+}
+
+QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id,
+                                           const qemu_info_t *info,
+                                           int argc, char **argv)
+{
+    if (info->system_emulation) {
+        fprintf(stderr, "plugin dlcall: only useful for user emulation\n");
+        return -1;
+    }
+
+    for (int i = 0; i < argc; i++) {
+        char *opt = argv[i];
+        g_auto(GStrv) tokens = g_strsplit(opt, "=", 2);
+        if (g_strcmp0(tokens[0], "syscall_num") == 0) {
+            const char *val = tokens[1];
+            char *endptr = NULL;
+            guint64 num;
+            if (!val || *val == '\0') {
+                fprintf(stderr,
+                        "plugin dlcall: missing value for syscall_num\n");
+                return -1;
+            }
+            num = g_ascii_strtoull(val, &endptr, 0);
+            if (*endptr != '\0' || g_strrstr(val, "-") != NULL) {
+                fprintf(stderr,
+                        "plugin dlcall: invalid syscall_num '%s'\n", val);
+                return -1;
+            }
+            if (num < DLCALL_SYSCALL_MIN || num > G_MAXINT64) {
+                fprintf(stderr,
+                        "plugin dlcall: syscall_num %s is out of range; "
+                        "it must be >= %d to avoid clashing with a real "
+                        "syscall\n", val, DLCALL_SYSCALL_MIN);
+                return -1;
+            }
+            dlcall_syscall_num = (int64_t) num;
+        } else {
+            fprintf(stderr, "plugin dlcall: unknown option '%s'\n", opt);
+            return -1;
+        }
+    }
+
+    qemu_plugin_register_vcpu_syscall_filter_cb(id, vcpu_syscall_filter, NULL);
+
+    return 0;
+}
contrib/plugins/meson.build +5 -0
index 099319e7a1..e7fc4d6d8f 100644
@@ -19,6 +19,11 @@ if host_os != 'windows'
   contrib_plugins += 'lockstep.c'
 endif
 
+if host_os == 'linux'
+  # dlcall passes guest calls through to host libraries; linux-user only
+  contrib_plugins += 'dlcall.c'
+endif
+
 if 'cpp' in all_languages
   contrib_plugins += 'cpp.cpp'
 endif
Signature · 1 line
2.34.1
#2 lore raw

PATCH v7 2/2 docs/about/emulation: document the dlcall plugin

In reply to Ziyang Zhang

Document the dlcall plugin under Example Plugins: what it does, the trusted- guests and guest_base == 0 constraints, how to load it, and a pointer to Lorelei, one end-to-end userspace implementation, for prebuilt thunks and a runnable example.

---
 docs/about/emulation.rst | 122 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 122 insertions(+)
docs/about/emulation.rst +122 -0
index 3b4c365933..07fbd24072 100644
@@ -1046,6 +1046,128 @@ Count traps
 This plugin counts the number of interrupts (asynchronous events), exceptions
 (synchronous events) and host calls (e.g. semihosting) per cpu.
 
+Dynamic Linking Call
+....................
+
+``contrib/plugins/dlcall.c``
+
+This plugin provides a dynamic linking function call interception mechanism
+for linux-user guests: the guest hands a call off to the host, where the plugin
+runs native code in its place instead of the guest emulating it. Interception
+alone enables several uses, for instance tracing or auditing guest calls.
+One use is acceleration by leveraging the host's native shared libraries. For
+example, a thunk layer can run the stock zlib ``minizip`` utility under
+emulation while forwarding its ``deflate`` calls to the host's native zlib
+library (libz). This avoids emulating those selected library calls instruction
+by instruction.
+
+The guest issues a reserved "magic" system call (4096 by default, configurable
+with ``syscall_num=N``) whose first argument selects a pass-through operation:
+dlopen/dlclose a host library, dlsym a symbol, and invoke a resolved host
+function. The plugin performs the operation on the host and consumes the
+syscall, so the real kernel never sees it.
+
+.. warning::
+
+   Trusted guests only. The guest can load arbitrary host libraries and run
+   arbitrary code in the QEMU host process. The plugin is not a sandbox and
+   provides no isolation. It also requires ``guest_base == 0`` (qemu-user's
+   default), as guest pointers are dereferenced as host addresses with no
+   translation.
+
+The plugin intentionally keeps the QEMU side lightweight and knows nothing
+about any particular library or its calling convention. Turning a real library
+into working thunks, including argument marshalling, callbacks and variadic
+functions, is done entirely in userspace, and any toolchain can implement the
+interface.
+
+Loading the plugin is all that is required from QEMU's side:
+
+.. code-block:: shell
+
+   qemu-x86_64 -plugin contrib/plugins/libdlcall.so <guest-program> ...
+
+`Lorelei <https://github.com/rover2024/lorelei>`_ is one end-to-end userspace
+implementation of this: it provides the guest and host runtimes and an
+automated toolchain that generates the thunks from a library's headers, so guest
+library calls run on the host's native libraries. Its prebuilt thunks are for an
+x86_64 guest, running on an x86_64, aarch64 or riscv64 host.
+
+A minimal end-to-end example wraps a one-function library, ``libhello.so``,
+declared by ``hello.h``:
+
+.. code-block:: c
+
+   void hello(const char *name, int lucky);
+
+The guest program ``main`` is an ordinary x86_64 executable, linked against a
+guest ``libhello.so`` and calling its ``hello()``. The host has its own
+``libhello.so``, the same library built for the host. The goal is to run
+``main``, but have each ``hello()`` call run on the host's ``libhello.so``.
+
+Lorelei ships a prebuilt toolchain (a "devkit") in its releases. Download one
+for your host and unpack it:
+
+.. code-block:: shell
+
+   # <arch> is your host architecture: x86_64, aarch64 or riscv64
+   wget https://github.com/rover2024/lorelei/releases/download/v<version>/lorelei-devkit-<arch>-<version>.tar.xz
+   tar -xf lorelei-devkit-<arch>-<version>.tar.xz
+   DEVKIT=lorelei-devkit-<arch>
+
+A single command reads the host ``libhello.so`` and ``hello.h`` and generates
+the thunk: a guest-side ``libhello.so`` that stands in for an ordinary guest
+build, and a host-side thunk library that dispatches to the real one:
+
+.. code-block:: shell
+
+   $DEVKIT/bin/LoreMakeThunk.py --name hello --lib libhello.so --header hello.h \
+       -o thunks -- -I.
+
+Running ``main`` under the plugin forwards each ``hello()`` call to the host's
+real ``libhello.so``:
+
+.. code-block:: shell
+
+   LORELEI_THUNK_PATH=thunks \
+   LD_LIBRARY_PATH=$DEVKIT/lib:. \
+       qemu-x86_64 -plugin contrib/plugins/libdlcall.so \
+       -L $DEVKIT/x86_64/sysroot \
+       -E LD_LIBRARY_PATH=$DEVKIT/x86_64/lib:thunks/x86_64/lib/x86_64-LoreGTL \
+       ./main
+
+The guest ``LD_LIBRARY_PATH``, passed with ``-E``, controls what the emulated
+program loads:
+
+* ``$DEVKIT/x86_64/lib`` contains the guest runtime support shipped with the
+  devkit.
+* ``thunks/x86_64/lib/x86_64-LoreGTL`` contains the generated guest
+  ``libhello.so`` thunk, used in place of an ordinary guest library.
+
+The host ``LD_LIBRARY_PATH`` controls what the plugin and host thunk load:
+
+* ``$DEVKIT/lib`` contains the host runtime support shipped with the devkit.
+* ``.`` is the current directory, where the host's own ``libhello.so`` is
+  located.
+
+See the runnable
+`hello <https://github.com/rover2024/lorelei/tree/main/examples/hello>`_
+(minimal) and
+`demo <https://github.com/rover2024/lorelei/tree/main/examples/demo>`_
+(variadic functions and a callback that reenters the guest) examples, and
+`Lorelei <https://github.com/rover2024/lorelei>`_ for prebuilt thunk trees and
+the runtime environment they expect.
+
+.. list-table:: Dynamic Linking Call arguments
+  :widths: 20 80
+  :header-rows: 1
+
+  * - Option
+    - Description
+  * - syscall_num=N
+    - The magic syscall number the guest issues (default 4096). Must be high
+      enough not to clash with a real syscall.
+
 Other emulation features
 ------------------------
 
Signature · 1 line
2.34.1
#3 lore raw

Re: [PATCH v7 2/2] docs/about/emulation: document the dlcall plugin

Quoted 62 lines · Ziyang Zhang

Document the dlcall plugin under Example Plugins: what it does, the trusted- guests and guest_base == 0 constraints, how to load it, and a pointer to Lorelei, one end-to-end userspace implementation, for prebuilt thunks and a runnable example.

---
 docs/about/emulation.rst | 122 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 122 insertions(+)
docs/about/emulation.rst +44 -0
index 3b4c365933..07fbd24072 100644
@@ -1046,6 +1046,128 @@ Count traps
 This plugin counts the number of interrupts (asynchronous events), exceptions
 (synchronous events) and host calls (e.g. semihosting) per cpu.
 
+Dynamic Linking Call
+....................
+
+``contrib/plugins/dlcall.c``
+
+This plugin provides a dynamic linking function call interception mechanism
+for linux-user guests: the guest hands a call off to the host, where the plugin
+runs native code in its place instead of the guest emulating it. Interception
+alone enables several uses, for instance tracing or auditing guest calls.
+One use is acceleration by leveraging the host's native shared libraries. For
+example, a thunk layer can run the stock zlib ``minizip`` utility under
+emulation while forwarding its ``deflate`` calls to the host's native zlib
+library (libz). This avoids emulating those selected library calls instruction
+by instruction.
+
+The guest issues a reserved "magic" system call (4096 by default, configurable
+with ``syscall_num=N``) whose first argument selects a pass-through operation:
+dlopen/dlclose a host library, dlsym a symbol, and invoke a resolved host
+function. The plugin performs the operation on the host and consumes the
+syscall, so the real kernel never sees it.
+
+.. warning::
+
+   Trusted guests only. The guest can load arbitrary host libraries and run
+   arbitrary code in the QEMU host process. The plugin is not a sandbox and
+   provides no isolation. It also requires ``guest_base == 0`` (qemu-user's
+   default), as guest pointers are dereferenced as host addresses with no
+   translation.
+
+The plugin intentionally keeps the QEMU side lightweight and knows nothing
+about any particular library or its calling convention. Turning a real library
+into working thunks, including argument marshalling, callbacks and variadic
+functions, is done entirely in userspace, and any toolchain can implement the
+interface.
+
+Loading the plugin is all that is required from QEMU's side:
+
+.. code-block:: shell
+
+   qemu-x86_64 -plugin contrib/plugins/libdlcall.so <guest-program> ...
+
+`Lorelei <https://github.com/rover2024/lorelei>`_ is one end-to-end userspace
+implementation of this: it provides the guest and host runtimes and an
+automated toolchain that generates the thunks from a library's headers, so guest

docs/about/emulation.rst Count traps · line 1102

Quoted 10 lines
docs/about/emulation.rst +10 -0
+library calls run on the host's native libraries. Its prebuilt thunks are for an
+x86_64 guest, running on an x86_64, aarch64 or riscv64 host.
+
+A minimal end-to-end example wraps a one-function library, ``libhello.so``,
+declared by ``hello.h``:
+
+.. code-block:: c
+
+   void hello(const char *name, int lucky);
+

Please include full files for example:
hello.h, hello.c and main.c calling hello function.

Also, please include compiler commands for libhello.so and main. You can give a full example assuming it run on a x86_64 host.

Quoted 14 lines
docs/about/emulation.rst +14 -0
+The guest program ``main`` is an ordinary x86_64 executable, linked against a
+guest ``libhello.so`` and calling its ``hello()``. The host has its own
+``libhello.so``, the same library built for the host. The goal is to run
+``main``, but have each ``hello()`` call run on the host's ``libhello.so``.
+
+Lorelei ships a prebuilt toolchain (a "devkit") in its releases. Download one
+for your host and unpack it:
+
+.. code-block:: shell
+
+   # <arch> is your host architecture: x86_64, aarch64 or riscv64
+   wget https://github.com/rover2024/lorelei/releases/download/v<version>/lorelei-devkit-<arch>-<version>.tar.xz
+   tar -xf lorelei-devkit-<arch>-<version>.tar.xz
+   DEVKIT=lorelei-devkit-<arch>

docs/about/emulation.rst Count traps · line 1126

Quoted 10 lines
docs/about/emulation.rst +10 -0
+
+A single command reads the host ``libhello.so`` and ``hello.h`` and generates
+the thunk: a guest-side ``libhello.so`` that stands in for an ordinary guest
+build, and a host-side thunk library that dispatches to the real one:
+
+.. code-block:: shell
+
+   $DEVKIT/bin/LoreMakeThunk.py --name hello --lib libhello.so --header hello.h \
+       -o thunks -- -I.
+

Sounds good.

docs/about/emulation.rst Count traps · line 1138

Quoted 12 lines
docs/about/emulation.rst +12 -0
+Running ``main`` under the plugin forwards each ``hello()`` call to the host's
+real ``libhello.so``:
+
+.. code-block:: shell
+
+   LORELEI_THUNK_PATH=thunks \
+   LD_LIBRARY_PATH=$DEVKIT/lib:. \
+       qemu-x86_64 -plugin contrib/plugins/libdlcall.so \
+       -L $DEVKIT/x86_64/sysroot \
+       -E LD_LIBRARY_PATH=$DEVKIT/x86_64/lib:thunks/x86_64/lib/x86_64-LoreGTL \
+       ./main
+

I could not get it to work.
Following all the steps, the error message is:

[GRT] failed to load host runtime
qemu: uncaught target signal 6 (Aborted) - core dumped Aborted

We talked about not overriding sysroot, so please remove -L part. Also, Why do current dir is passed in LD_LIBRARY_PATH?

Quoted 25 lines
docs/about/emulation.rst +25 -0
+The guest ``LD_LIBRARY_PATH``, passed with ``-E``, controls what the emulated
+program loads:
+
+* ``$DEVKIT/x86_64/lib`` contains the guest runtime support shipped with the
+  devkit.
+* ``thunks/x86_64/lib/x86_64-LoreGTL`` contains the generated guest
+  ``libhello.so`` thunk, used in place of an ordinary guest library.
+
+The host ``LD_LIBRARY_PATH`` controls what the plugin and host thunk load:
+
+* ``$DEVKIT/lib`` contains the host runtime support shipped with the devkit.
+* ``.`` is the current directory, where the host's own ``libhello.so`` is
+  located.
+
+See the runnable
+`hello <https://github.com/rover2024/lorelei/tree/main/examples/hello>`_
+(minimal) and
+`demo <https://github.com/rover2024/lorelei/tree/main/examples/demo>`_
+(variadic functions and a callback that reenters the guest) examples, and
+`Lorelei <https://github.com/rover2024/lorelei>`_ for prebuilt thunk trees and
+the runtime environment they expect.
+
+.. list-table:: Dynamic Linking Call arguments
+  :widths: 20 80
+  :header-rows: 1

docs/about/emulation.rst Count traps · line 1173

Quoted 10 lines
docs/about/emulation.rst +7 -0
+
+  * - Option
+    - Description
+  * - syscall_num=N
+    - The magic syscall number the guest issues (default 4096). Must be high
+      enough not to clash with a real syscall.
+
 Other emulation features
 ------------------------
 

Regards,
Pierrick

#4 lore raw

Re: [PATCH v7 2/2] docs/about/emulation: document the dlcall plugin

Hi Pierrick,

Quoted 11 lines · Pierrick Bouvier

docs/about/emulation.rst Count traps · line 1102

Quoted 7 lines
docs/about/emulation.rst +7 -0
+A minimal end-to-end example wraps a one-function library, ``libhello.so``,
+declared by ``hello.h``:
+
+.. code-block:: c
+
+   void hello(const char *name, int lucky);
+

Please include full files for example:
hello.h, hello.c and main.c calling hello function.

Quoted 2 lines

Also, please include compiler commands for libhello.so and main. You can give a full example assuming it run on a x86_64 host.

Good idea. I will get it done in v8.

Quoted 6 lines

I could not get it to work.
Following all the steps, the error message is:

[GRT] failed to load host runtime
qemu: uncaught target signal 6 (Aborted) - core dumped Aborted

On the error. [GRT] failed to load host runtime is the host side (QEMU) failing to dlopen the Lorelei host runtime, which means $DEVKIT/lib was not on the host LD_LIBRARY_PATH, for example if $DEVKIT was not set in the shell that ran the command. -L only points QEMU at the guest's loader and libc, so it is unrelated.

I reproduced it: dropping just $DEVKIT/lib from the host LD_LIBRARY_PATH gives exactly that message and the abort. The real fix is making the example self-contained so nothing stays implicit, which is what v8 does.

Quoted 2 lines

We talked about not overriding sysroot, so please remove -L part. Also, Why do current dir is passed in LD_LIBRARY_PATH?

In this example it assumes that the host libhello.so is in the current directory, which must be able to be found in LD_LIBRARY_PATH.

Quoted 30 lines
Quoted 30 lines
docs/about/emulation.rst +30 -0
+The guest ``LD_LIBRARY_PATH``, passed with ``-E``, controls what the emulated
+program loads:
+
+* ``$DEVKIT/x86_64/lib`` contains the guest runtime support shipped with the
+  devkit.
+* ``thunks/x86_64/lib/x86_64-LoreGTL`` contains the generated guest
+  ``libhello.so`` thunk, used in place of an ordinary guest library.
+
+The host ``LD_LIBRARY_PATH`` controls what the plugin and host thunk load:
+
+* ``$DEVKIT/lib`` contains the host runtime support shipped with the devkit.
+* ``.`` is the current directory, where the host's own ``libhello.so`` is
+  located.
+
+See the runnable
+`hello <https://github.com/rover2024/lorelei/tree/main/examples/hello>`_
+(minimal) and
+`demo <https://github.com/rover2024/lorelei/tree/main/examples/demo>`_
+(variadic functions and a callback that reenters the guest) examples, and
+`Lorelei <https://github.com/rover2024/lorelei>`_ for prebuilt thunk trees and
+the runtime environment they expect.
+
+.. list-table:: Dynamic Linking Call arguments
+  :widths: 20 80
+  :header-rows: 1
+
+  * - Option
+    - Description
+  * - syscall_num=N
+    - The magic syscall number the guest issues (default 4096). Must be high
Quoted 8 lines

docs/about/emulation.rst Count traps · line 1172

Quoted 5 lines
docs/about/emulation.rst +2 -0
+      enough not to clash with a real syscall.
+
  Other emulation features
  ------------------------

Regards,
Pierrick

It looks unexplained today only because the walkthrough never shows building it. v8 will.

v8 will also include the full hello.h, hello.c and main.c, plus the cc and clang commands for libhello.so and main, as one runnable x86_64 sequence.

#5 lore raw

Re: [PATCH v7 2/2] docs/about/emulation: document the dlcall plugin

Quoted 31 lines · Ziyang Zhang

Hi Pierrick,

Quoted 12 lines · Pierrick Bouvier

docs/about/emulation.rst Count traps · line 1102

Quoted 8 lines

+A minimal end-to-end example wraps a one-function library, ``libhello.so``,

docs/about/emulation.rst +6 -0
+declared by ``hello.h``:
+
+.. code-block:: c
+
+   void hello(const char *name, int lucky);
+

Please include full files for example:
hello.h, hello.c and main.c calling hello function.

Quoted 2 lines

Also, please include compiler commands for libhello.so and main. You can give a full example assuming it run on a x86_64 host.

Good idea. I will get it done in v8.

Quoted 6 lines

I could not get it to work.
Following all the steps, the error message is:

[GRT] failed to load host runtime
qemu: uncaught target signal 6 (Aborted) - core dumped Aborted

On the error. [GRT] failed to load host runtime is the host side (QEMU) failing to dlopen the Lorelei host runtime, which means $DEVKIT/lib was not on the host LD_LIBRARY_PATH, for example if $DEVKIT was not set in the shell that ran the command. -L only points QEMU at the guest's loader and libc, so it is unrelated.

Quoted 4 lines

I reproduced it: dropping just $DEVKIT/lib from the host LD_LIBRARY_PATH gives exactly that message and the abort. The real fix is making the example self-contained so nothing stays implicit, which is what v8 does.

I paid attention to follow steps correctly, but maybe I missed something. Please see here a full dump of my env and commands:

$ git status
Untracked files:
  (use "git add <file>..." to include in what will be committed)
        a.out
        hello.c
        hello.h
        libhello.so
        lorelei-devkit-x86_64-1.0.4.0.tar.xz
        lorelei-devkit-x86_64/
        main.c
        thunks/

nothing added to commit but untracked files present (use "git add" to track)

$ ldd a.out
        linux-vdso.so.1 (0x00007f5855c3a000)
        libhello.so => not found
        libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007f5855a0a000)
        /lib64/ld-linux-x86-64.so.2 (0x00007f5855c3c000)
$ LD_LIBRARY_PATH=./ ldd a.out
        linux-vdso.so.1 (0x00007fef23831000)
        libhello.so => ./libhello.so (0x00007fef2381f000)
        libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007fef235fc000)
        /lib64/ld-linux-x86-64.so.2 (0x00007fef23833000)
$ env | grep DEVKIT
DEVKIT=/home/user/.work/qemu/lorelei-devkit-x86_64
$ tree thunks/
thunks/
├── lib
│   └── x86_64-LoreHTL
│       └── libhello_HTL.so
└── x86_64
    └── lib
        └── x86_64-LoreGTL
            └── libhello.so

6 directories, 2 files

$ LORELEI_THUNK_PATH=thunks LD_LIBRARY_PATH=$DEVKIT/lib:. \
build/qemu-x86_64 -plugin build/contrib/plugins/libdlcall.so \
-L $DEVKIT/x86_64/sysroot \
 -E LD_LIBRARY_PATH=$DEVKIT/x86_64/lib:thunks/x86_64/lib/x86_64-LoreGTL\
./a.out
[GRT] failed to load host runtime
qemu: uncaught target signal 6 (Aborted) - core dumped
Aborted

Any idea what could be missing?

Quoted 59 lines
Quoted 2 lines

We talked about not overriding sysroot, so please remove -L part. Also, Why do current dir is passed in LD_LIBRARY_PATH?

In this example it assumes that the host libhello.so is in the current directory, which must be able to be found in LD_LIBRARY_PATH.

Quoted 39 lines
Quoted 39 lines

+The guest ``LD_LIBRARY_PATH``, passed with ``-E``, controls what the emulated

docs/about/emulation.rst +3 -0
+program loads:
+
+* ``$DEVKIT/x86_64/lib`` contains the guest runtime support shipped

with the
+  devkit.

docs/about/emulation.rst +4 -0
+* ``thunks/x86_64/lib/x86_64-LoreGTL`` contains the generated guest
+  ``libhello.so`` thunk, used in place of an ordinary guest library.
+
+The host ``LD_LIBRARY_PATH`` controls what the plugin and host thunk

load:

(quoted diff) +2 -0
+
+* ``$DEVKIT/lib`` contains the host runtime support shipped with the

devkit.
+* ``.`` is the current directory, where the host's own ``libhello.so`` is
+  located.

docs/about/emulation.rst +3 -0
+
+See the runnable
+`hello <https://github.com/rover2024/lorelei/tree/main/examples/

hello>`_

docs/about/emulation.rst +3 -0
+(minimal) and
+`demo <https://github.com/rover2024/lorelei/tree/main/examples/demo>`_
+(variadic functions and a callback that reenters the guest)

examples, and
+Lorelei <https://github.com/rover2024/lorelei>_ for prebuilt thunk trees and

docs/about/emulation.rst +10 -0
+the runtime environment they expect.
+
+.. list-table:: Dynamic Linking Call arguments
+  :widths: 20 80
+  :header-rows: 1
+
+  * - Option
+    - Description
+  * - syscall_num=N
+    - The magic syscall number the guest issues (default 4096). Must

be high

Quoted 8 lines
Quoted 5 lines

+      enough not to clash with a real syscall.
+
  Other emulation features
  ------------------------

Regards,
Pierrick

It looks unexplained today only because the walkthrough never shows building it. v8 will.

v8 will also include the full hello.h, hello.c and main.c, plus the cc and clang commands for libhello.so and main, as one runnable x86_64 sequence.

#6 lore raw

Re: [PATCH v7 2/2] docs/about/emulation: document the dlcall plugin

Quoted 85 lines · Pierrick Bouvier
Quoted 31 lines · Ziyang Zhang

Hi Pierrick,

Quoted 12 lines · Pierrick Bouvier

docs/about/emulation.rst Count traps · line 1102

Quoted 8 lines

+A minimal end-to-end example wraps a one-function library, ``libhello.so``,

docs/about/emulation.rst +6 -0
+declared by ``hello.h``:
+
+.. code-block:: c
+
+   void hello(const char *name, int lucky);
+

Please include full files for example:
hello.h, hello.c and main.c calling hello function.

Quoted 2 lines

Also, please include compiler commands for libhello.so and main. You can give a full example assuming it run on a x86_64 host.

Good idea. I will get it done in v8.

Quoted 6 lines

I could not get it to work.
Following all the steps, the error message is:

[GRT] failed to load host runtime
qemu: uncaught target signal 6 (Aborted) - core dumped Aborted

On the error. [GRT] failed to load host runtime is the host side (QEMU) failing to dlopen the Lorelei host runtime, which means $DEVKIT/lib was not on the host LD_LIBRARY_PATH, for example if $DEVKIT was not set in the shell that ran the command. -L only points QEMU at the guest's loader and libc, so it is unrelated.

Quoted 4 lines

I reproduced it: dropping just $DEVKIT/lib from the host LD_LIBRARY_PATH gives exactly that message and the abort. The real fix is making the example self-contained so nothing stays implicit, which is what v8 does.

I paid attention to follow steps correctly, but maybe I missed something. Please see here a full dump of my env and commands:

$ git status
Untracked files:
   (use "git add <file>..." to include in what will be committed)
         a.out
         hello.c
         hello.h
         libhello.so
         lorelei-devkit-x86_64-1.0.4.0.tar.xz
         lorelei-devkit-x86_64/
         main.c
         thunks/

nothing added to commit but untracked files present (use "git add" to track)

$ ldd a.out
         linux-vdso.so.1 (0x00007f5855c3a000)
         libhello.so => not found
         libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007f5855a0a000)
         /lib64/ld-linux-x86-64.so.2 (0x00007f5855c3c000)
$ LD_LIBRARY_PATH=./ ldd a.out
         linux-vdso.so.1 (0x00007fef23831000)
         libhello.so => ./libhello.so (0x00007fef2381f000)
         libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007fef235fc000)
         /lib64/ld-linux-x86-64.so.2 (0x00007fef23833000)
$ env | grep DEVKIT
DEVKIT=/home/user/.work/qemu/lorelei-devkit-x86_64
$ tree thunks/
thunks/
├── lib
│   └── x86_64-LoreHTL
│       └── libhello_HTL.so
└── x86_64
     └── lib
         └── x86_64-LoreGTL
             └── libhello.so

6 directories, 2 files

$ LORELEI_THUNK_PATH=thunks LD_LIBRARY_PATH=$DEVKIT/lib:. \
build/qemu-x86_64 -plugin build/contrib/plugins/libdlcall.so \
-L $DEVKIT/x86_64/sysroot \
  -E LD_LIBRARY_PATH=$DEVKIT/x86_64/lib:thunks/x86_64/lib/x86_64-LoreGTL\
./a.out
[GRT] failed to load host runtime
qemu: uncaught target signal 6 (Aborted) - core dumped
Aborted
Quoted 61 lines

Any idea what could be missing?

Quoted 59 lines
Quoted 2 lines

We talked about not overriding sysroot, so please remove -L part. Also, Why do current dir is passed in LD_LIBRARY_PATH?

In this example it assumes that the host libhello.so is in the current directory, which must be able to be found in LD_LIBRARY_PATH.

Quoted 39 lines
Quoted 39 lines

+The guest ``LD_LIBRARY_PATH``, passed with ``-E``, controls what the emulated

docs/about/emulation.rst +3 -0
+program loads:
+
+* ``$DEVKIT/x86_64/lib`` contains the guest runtime support shipped

with the
+  devkit.

docs/about/emulation.rst +4 -0
+* ``thunks/x86_64/lib/x86_64-LoreGTL`` contains the generated guest
+  ``libhello.so`` thunk, used in place of an ordinary guest library.
+
+The host ``LD_LIBRARY_PATH`` controls what the plugin and host thunk

load:

(quoted diff) +2 -0
+
+* ``$DEVKIT/lib`` contains the host runtime support shipped with the

devkit.
+* ``.`` is the current directory, where the host's own ``libhello.so`` is
+  located.

docs/about/emulation.rst +3 -0
+
+See the runnable
+`hello <https://github.com/rover2024/lorelei/tree/main/examples/

hello>`_

docs/about/emulation.rst +3 -0
+(minimal) and
+`demo <https://github.com/rover2024/lorelei/tree/main/examples/demo>`_
+(variadic functions and a callback that reenters the guest)

examples, and
+Lorelei <https://github.com/rover2024/lorelei>_ for prebuilt thunk trees and

docs/about/emulation.rst +10 -0
+the runtime environment they expect.
+
+.. list-table:: Dynamic Linking Call arguments
+  :widths: 20 80
+  :header-rows: 1
+
+  * - Option
+    - Description
+  * - syscall_num=N
+    - The magic syscall number the guest issues (default 4096). Must

be high

Quoted 8 lines
Quoted 5 lines

+      enough not to clash with a real syscall.
+
  Other emulation features
  ------------------------

Regards,
Pierrick

It looks unexplained today only because the walkthrough never shows building it. v8 will.

v8 will also include the full hello.h, hello.c and main.c, plus the cc and clang commands for libhello.so and main, as one runnable x86_64 sequence.

Although I have tested in the empty containers of each ISA, it is not possible to cover all Linux distributions. Currently, the Lorelei Host Runtime (in the devkit, libLoreHostRT.so) fails to load and does not output dlerror(). At present, I am unable to analyze why there is an error on your end.

Perhaps you could set the LD_DEBUG for the host and use -U to unset LD_DEBUG for the guest, and then observe the output.

Regards,
Ziyang Zhang

#7 lore raw

Re: [PATCH v7 2/2] docs/about/emulation: document the dlcall plugin

In reply to Pierrick Bouvier
Quoted 85 lines · Pierrick Bouvier
Quoted 31 lines · Ziyang Zhang

Hi Pierrick,

Quoted 12 lines · Pierrick Bouvier

docs/about/emulation.rst Count traps · line 1102

Quoted 8 lines

+A minimal end-to-end example wraps a one-function library, ``libhello.so``,

docs/about/emulation.rst +6 -0
+declared by ``hello.h``:
+
+.. code-block:: c
+
+   void hello(const char *name, int lucky);
+

Please include full files for example:
hello.h, hello.c and main.c calling hello function.

Quoted 2 lines

Also, please include compiler commands for libhello.so and main. You can give a full example assuming it run on a x86_64 host.

Good idea. I will get it done in v8.

Quoted 6 lines

I could not get it to work.
Following all the steps, the error message is:

[GRT] failed to load host runtime
qemu: uncaught target signal 6 (Aborted) - core dumped Aborted

On the error. [GRT] failed to load host runtime is the host side (QEMU) failing to dlopen the Lorelei host runtime, which means $DEVKIT/lib was not on the host LD_LIBRARY_PATH, for example if $DEVKIT was not set in the shell that ran the command. -L only points QEMU at the guest's loader and libc, so it is unrelated.

Quoted 4 lines

I reproduced it: dropping just $DEVKIT/lib from the host LD_LIBRARY_PATH gives exactly that message and the abort. The real fix is making the example self-contained so nothing stays implicit, which is what v8 does.

I paid attention to follow steps correctly, but maybe I missed something. Please see here a full dump of my env and commands:

$ git status
Untracked files:
   (use "git add <file>..." to include in what will be committed)
         a.out
         hello.c
         hello.h
         libhello.so
         lorelei-devkit-x86_64-1.0.4.0.tar.xz
         lorelei-devkit-x86_64/
         main.c
         thunks/

nothing added to commit but untracked files present (use "git add" to track)

$ ldd a.out
         linux-vdso.so.1 (0x00007f5855c3a000)
         libhello.so => not found
         libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007f5855a0a000)
         /lib64/ld-linux-x86-64.so.2 (0x00007f5855c3c000)
$ LD_LIBRARY_PATH=./ ldd a.out
         linux-vdso.so.1 (0x00007fef23831000)
         libhello.so => ./libhello.so (0x00007fef2381f000)
         libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007fef235fc000)
         /lib64/ld-linux-x86-64.so.2 (0x00007fef23833000)
$ env | grep DEVKIT
DEVKIT=/home/user/.work/qemu/lorelei-devkit-x86_64
$ tree thunks/
thunks/
├── lib
│   └── x86_64-LoreHTL
│       └── libhello_HTL.so
└── x86_64
     └── lib
         └── x86_64-LoreGTL
             └── libhello.so

6 directories, 2 files

$ LORELEI_THUNK_PATH=thunks LD_LIBRARY_PATH=$DEVKIT/lib:. \
build/qemu-x86_64 -plugin build/contrib/plugins/libdlcall.so \
-L $DEVKIT/x86_64/sysroot \
  -E LD_LIBRARY_PATH=$DEVKIT/x86_64/lib:thunks/x86_64/lib/x86_64-LoreGTL\
./a.out
[GRT] failed to load host runtime
qemu: uncaught target signal 6 (Aborted) - core dumped
Aborted
Quoted 1 line

Any idea what could be missing?

The "[GRT] failed to load host runtime" message is the host side failing to dlopen libLoreHostRT.so, and until now it did not print why. The next Lorelei devkit (1.0.5.0) fixes that: the same failure now reads

[GRT] failed to load host runtime: <the exact dlerror>

so upgrading the devkit will usually tell you the cause directly, with nothing extra to run.

Set LD_DEBUG for the QEMU process, and unset it for the guest with -U so the guest loader does not also flood the output:

LD_DEBUG=libs LORELEI_THUNK_PATH=thunks \

LD_LIBRARY_PATH=$DEVKIT/lib:. \
    build/qemu-x86_64 -U LD_DEBUG -plugin 
build/contrib/plugins/libdlcall.so \
    -L $DEVKIT/x86_64/sysroot \
    -E 
LD_LIBRARY_PATH=$DEVKIT/x86_64/lib:thunks/x86_64/lib/x86_64-LoreGTL \
    ./a.out 2>ld.txt

Then look in ld.txt for the block that starts with find library=libLoreHostRT.so [0]; searching.

A healthy load tries $DEVKIT/lib first, finds it there, and ends in a matching "calling init" line. A failing load has no trying file=$DEVKIT/lib/libLoreHostRT.so line at all.

So the difference is a single line. If $DEVKIT/lib is never tried, then it did not reach the host LD_LIBRARY_PATH of the QEMU process for that command. If instead that line is present but the load still fails, the message after it (a missing dependency, an ABI mismatch) is the real reason, and that is what 1.0.5.0 would print.

Quoted 59 lines
Quoted 59 lines
Quoted 2 lines

We talked about not overriding sysroot, so please remove -L part. Also, Why do current dir is passed in LD_LIBRARY_PATH?

In this example it assumes that the host libhello.so is in the current directory, which must be able to be found in LD_LIBRARY_PATH.

Quoted 39 lines
Quoted 39 lines

+The guest ``LD_LIBRARY_PATH``, passed with ``-E``, controls what the emulated

docs/about/emulation.rst +3 -0
+program loads:
+
+* ``$DEVKIT/x86_64/lib`` contains the guest runtime support shipped

with the
+  devkit.

docs/about/emulation.rst +4 -0
+* ``thunks/x86_64/lib/x86_64-LoreGTL`` contains the generated guest
+  ``libhello.so`` thunk, used in place of an ordinary guest library.
+
+The host ``LD_LIBRARY_PATH`` controls what the plugin and host thunk

load:

(quoted diff) +2 -0
+
+* ``$DEVKIT/lib`` contains the host runtime support shipped with the

devkit.
+* ``.`` is the current directory, where the host's own ``libhello.so`` is
+  located.

docs/about/emulation.rst +3 -0
+
+See the runnable
+`hello <https://github.com/rover2024/lorelei/tree/main/examples/

hello>`_

docs/about/emulation.rst +3 -0
+(minimal) and
+`demo <https://github.com/rover2024/lorelei/tree/main/examples/demo>`_
+(variadic functions and a callback that reenters the guest)

examples, and
+Lorelei <https://github.com/rover2024/lorelei>_ for prebuilt thunk trees and

docs/about/emulation.rst +10 -0
+the runtime environment they expect.
+
+.. list-table:: Dynamic Linking Call arguments
+  :widths: 20 80
+  :header-rows: 1
+
+  * - Option
+    - Description
+  * - syscall_num=N
+    - The magic syscall number the guest issues (default 4096). Must

be high

Quoted 8 lines
Quoted 5 lines

+      enough not to clash with a real syscall.
+
  Other emulation features
  ------------------------

Regards,
Pierrick

It looks unexplained today only because the walkthrough never shows building it. v8 will.

v8 will also include the full hello.h, hello.c and main.c, plus the cc and clang commands for libhello.so and main, as one runnable x86_64 sequence.

#8 lore raw

Re: [PATCH v7 2/2] docs/about/emulation: document the dlcall plugin

Quoted 118 lines · Ziyang Zhang
Quoted 88 lines · Pierrick Bouvier
Quoted 31 lines · Ziyang Zhang

Hi Pierrick,

Quoted 12 lines · Pierrick Bouvier

docs/about/emulation.rst Count traps · line 1102

Quoted 8 lines

+A minimal end-to-end example wraps a one-function library, ``libhello.so``,

docs/about/emulation.rst +6 -0
+declared by ``hello.h``:
+
+.. code-block:: c
+
+   void hello(const char *name, int lucky);
+

Please include full files for example:
hello.h, hello.c and main.c calling hello function.

Quoted 2 lines

Also, please include compiler commands for libhello.so and main. You can give a full example assuming it run on a x86_64 host.

Good idea. I will get it done in v8.

Quoted 6 lines

I could not get it to work.
Following all the steps, the error message is:

[GRT] failed to load host runtime
qemu: uncaught target signal 6 (Aborted) - core dumped Aborted

On the error. [GRT] failed to load host runtime is the host side (QEMU) failing to dlopen the Lorelei host runtime, which means $DEVKIT/lib was not on the host LD_LIBRARY_PATH, for example if $DEVKIT was not set in the shell that ran the command. -L only points QEMU at the guest's loader and libc, so it is unrelated.

Quoted 4 lines

I reproduced it: dropping just $DEVKIT/lib from the host LD_LIBRARY_PATH gives exactly that message and the abort. The real fix is making the example self-contained so nothing stays implicit, which is what v8 does.

I paid attention to follow steps correctly, but maybe I missed something. Please see here a full dump of my env and commands:

$ git status
Untracked files:
   (use "git add <file>..." to include in what will be committed)
         a.out
         hello.c
         hello.h
         libhello.so
         lorelei-devkit-x86_64-1.0.4.0.tar.xz
         lorelei-devkit-x86_64/
         main.c
         thunks/

nothing added to commit but untracked files present (use "git add" to track)

$ ldd a.out
         linux-vdso.so.1 (0x00007f5855c3a000)
         libhello.so => not found
         libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6
(0x00007f5855a0a000)
         /lib64/ld-linux-x86-64.so.2 (0x00007f5855c3c000)
$ LD_LIBRARY_PATH=./ ldd a.out
         linux-vdso.so.1 (0x00007fef23831000)
         libhello.so => ./libhello.so (0x00007fef2381f000)
         libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6
(0x00007fef235fc000)
         /lib64/ld-linux-x86-64.so.2 (0x00007fef23833000)
$ env | grep DEVKIT
DEVKIT=/home/user/.work/qemu/lorelei-devkit-x86_64
$ tree thunks/
thunks/
├── lib
│   └── x86_64-LoreHTL
│       └── libhello_HTL.so
└── x86_64
     └── lib
         └── x86_64-LoreGTL
             └── libhello.so

6 directories, 2 files

$ LORELEI_THUNK_PATH=thunks LD_LIBRARY_PATH=$DEVKIT/lib:. \
build/qemu-x86_64 -plugin build/contrib/plugins/libdlcall.so \
-L $DEVKIT/x86_64/sysroot \
  -E LD_LIBRARY_PATH=$DEVKIT/x86_64/lib:thunks/x86_64/lib/x86_64-LoreGTL\
./a.out
[GRT] failed to load host runtime
qemu: uncaught target signal 6 (Aborted) - core dumped
Aborted
Quoted 1 line

Any idea what could be missing?

The "[GRT] failed to load host runtime" message is the host side failing to dlopen libLoreHostRT.so, and until now it did not print why. The next Lorelei devkit (1.0.5.0) fixes that: the same failure now reads

[GRT] failed to load host runtime: <the exact dlerror>

so upgrading the devkit will usually tell you the cause directly, with nothing extra to run.

Set LD_DEBUG for the QEMU process, and unset it for the guest with -U so the guest loader does not also flood the output:

LD_DEBUG=libs LORELEI_THUNK_PATH=thunks \
LD_LIBRARY_PATH=$DEVKIT/lib:. \
    build/qemu-x86_64 -U LD_DEBUG -plugin build/contrib/plugins/ libdlcall.so \
    -L $DEVKIT/x86_64/sysroot \
    -E LD_LIBRARY_PATH=$DEVKIT/x86_64/lib:thunks/x86_64/lib/x86_64- LoreGTL \
    ./a.out 2>ld.txt
Then look in ld.txt for the block that starts with find library=libLoreHostRT.so [0]; searching.

A healthy load tries $DEVKIT/lib first, finds it there, and ends in a matching "calling init" line. A failing load has no trying file=$DEVKIT/lib/libLoreHostRT.so line at all.

Quoted 6 lines

So the difference is a single line. If $DEVKIT/lib is never tried, then it did not reach the host LD_LIBRARY_PATH of the QEMU process for that command. If instead that line is present but the load still fails, the message after it (a missing dependency, an ABI mismatch) is the real reason, and that is what 1.0.5.0 would print.

Thanks, I'll try from v9 and latest release.

Quoted 61 lines
Quoted 60 lines
Quoted 60 lines
Quoted 2 lines

We talked about not overriding sysroot, so please remove -L part. Also, Why do current dir is passed in LD_LIBRARY_PATH?

In this example it assumes that the host libhello.so is in the current directory, which must be able to be found in LD_LIBRARY_PATH.

Quoted 40 lines
Quoted 40 lines

+The guest ``LD_LIBRARY_PATH``, passed with ``-E``, controls what the emulated

docs/about/emulation.rst +3 -0
+program loads:
+
+* ``$DEVKIT/x86_64/lib`` contains the guest runtime support shipped

with the
+  devkit.

docs/about/emulation.rst +4 -0
+* ``thunks/x86_64/lib/x86_64-LoreGTL`` contains the generated guest
+  ``libhello.so`` thunk, used in place of an ordinary guest library.
+
+The host ``LD_LIBRARY_PATH`` controls what the plugin and host thunk

load:

(quoted diff) +2 -0
+
+* ``$DEVKIT/lib`` contains the host runtime support shipped with the

devkit.
+* ``.`` is the current directory, where the host's own ``libhello.so`` is
+  located.

docs/about/emulation.rst +3 -0
+
+See the runnable
+`hello <https://github.com/rover2024/lorelei/tree/main/examples/

hello>`_
+(minimal) and
+`demo <https://github.com/rover2024/lorelei/tree/main/examples/
demo>`_
+(variadic functions and a callback that reenters the guest) examples, and
+Lorelei <https://github.com/rover2024/lorelei>_ for prebuilt thunk trees and

docs/about/emulation.rst +10 -0
+the runtime environment they expect.
+
+.. list-table:: Dynamic Linking Call arguments
+  :widths: 20 80
+  :header-rows: 1
+
+  * - Option
+    - Description
+  * - syscall_num=N
+    - The magic syscall number the guest issues (default 4096). Must

be high

Quoted 8 lines
Quoted 5 lines

+      enough not to clash with a real syscall.
+
   Other emulation features
   ------------------------

Regards,
Pierrick

It looks unexplained today only because the walkthrough never shows building it. v8 will.

v8 will also include the full hello.h, hello.c and main.c, plus the cc and clang commands for libhello.so and main, as one runnable x86_64 sequence.