Skip to contentSkip to conversation

Explain about FFI support and how to build liburing

RFC PATCH Applied Ammar Faizi 2 participants 5 messages Jan 16, 2023 io_uring

lore
Share & tools
lore
#0 lore raw

v2 cover Explain about FFI support and how to build liburing

From: Ammar Faizi <[email protected]>

v
v

---

Ammar Faizi (2):
README: Explain how to build liburing
README: Explain about FFI support

 README | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

base-commit: 19424b0baa5999918701e1972b901b0937331581

Signature · 1 line
Ammar Faizi
#1 lore raw

RFC PATCH v2 1/2 README: Explain how to build liburing

From: Ammar Faizi <[email protected]>

Tell people how to build liburing.

---
 README | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
README +24 -0
index 80d2b3dc5d5eaf76..4dd59f67fcbfbc5e 100644
@@ -47,6 +47,30 @@ the kernel io_uring support. Please note that this suite isn't expected to
 pass on older kernels, and may even crash or hang older kernels!
 
 
+Building liburing
+-----------------
+
+    #
+    # Prepare build config (optional).
+    #
+    #  --cc  specifies the C   compiler.
+    #  --cxx speficies the C++ compiler.
+    #
+    ./configure --cc=gcc --cxx=g++;
+
+    #
+    # Build liburing.
+    #
+    make -j$(nproc);
+
+    #
+    # Install liburing (headers, shared/static libs, and manpage).
+    #
+    sudo make install;
+
+See './configure --help' for more information about build config options.
+
+
 License
 -------
 
Signature · 1 line
Ammar Faizi
#2 lore raw

RFC PATCH v2 2/2 README: Explain about FFI support

In reply to Ammar Faizi

From: Ammar Faizi <[email protected]>

Languages and applications that can't use 'static inline' functions in liburing.h should use the FFI variants.

---
 README | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
README +24 -0
index 4dd59f67fcbfbc5e..9c881ae75787795c 100644
@@ -71,6 +71,30 @@ Building liburing
 See './configure --help' for more information about build config options.
 
 
+FFI support
+-----------
+
+By default, the build results in 4 lib files:
+
+    2 shared libs:
+
+        liburing.so
+        liburing-ffi.so
+
+    2 static libs:
+
+        liburing.a
+        liburing-ffi.a
+
+Languages and applications that can't use 'static inline' functions in
+liburing.h should use the FFI variants.
+
+liburing's main public interface lives in liburing.h as 'static inline'
+functions. Users wishing to consume liburing purely as a binary dependency
+should link against liburing-ffi. It contains definitions for every 'static
+inline' function.
+
+
 License
 -------
 
Signature · 1 line
Ammar Faizi
maintainer Applied
#4 lore raw
In reply to Ammar Faizi
Quoted 4 lines · Ammar Faizi

v
v

Applied, thanks!

[1/2] README: Explain how to build liburing

      commit: 888e608937c2a052e01bc3730dc4ae9bcff4b3e2
[2/2] README: Explain about FFI support
      commit: 808b972006716090c18ee1305a23f2148ed97434

Best regards,

Signature · 1 line
Jens Axboe