From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id D2C74C63797 for ; Mon, 16 Jan 2023 14:47:16 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230496AbjAPOrO (ORCPT ); Mon, 16 Jan 2023 09:47:14 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40614 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231683AbjAPOq5 (ORCPT ); Mon, 16 Jan 2023 09:46:57 -0500 Received: from gnuweeb.org (gnuweeb.org [51.81.211.47]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2D94923115 for ; Mon, 16 Jan 2023 06:28:49 -0800 (PST) Received: from localhost.localdomain (unknown [182.253.183.184]) by gnuweeb.org (Postfix) with ESMTPSA id 74D5981875; Mon, 16 Jan 2023 14:28:46 +0000 (UTC) X-GW-Data: lPqxHiMPbJw1wb7CM9QUryAGzr0yq5atzVDdxTR0iA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gnuweeb.org; s=default; t=1673879328; bh=uSwXcHjhVg5EFT9l3WjS0uSkZdDSM8perMQ03nudsWs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=LiMUaFCDPPLoaM6vPdc/DcDfJBbN5gExkueK7Um5ICrbAxgJFbE2uRMwzVaIXdEWp wd1XhV3HU+F1Nker9zsM/w9AUc/xfW6L0rXD9DshTWtXPneDYacHbNOB+JNpFemOk6 Of5F1e6rjc6ApY7lJiLjT8X638S8DxjSaGXgKbR5DCCQdxDEXabhngg1tscxMufCsz 3GMroQrqLwdp7jpsSVq94LRoDJIqPv43iCFn9LErI/m7K1/Ucjt4t54uuGx+pNr2KN AID09HBmfq0t8kQUZRXrKYOaRDRwwVVMOZhIP/mVgjP3zhY9FKraT22VKe9Q2L2eYz D3pXNNWC0ipZg== From: Ammar Faizi To: Jens Axboe Cc: Ammar Faizi , Pavel Begunkov , Christian Mazakas , Gilang Fachrezy , io-uring Mailing List , VNLX Kernel Department , GNU/Weeb Mailing List Subject: [RFC PATCH liburing v2 2/2] README: Explain about FFI support Date: Mon, 16 Jan 2023 21:28:22 +0700 Message-Id: <20230116142822.717320-3-ammar.faizi@intel.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230116142822.717320-1-ammar.faizi@intel.com> References: <20230116142822.717320-1-ammar.faizi@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: io-uring@vger.kernel.org From: Ammar Faizi Languages and applications that can't use 'static inline' functions in liburing.h should use the FFI variants. Co-authored-by: Christian Mazakas Signed-off-by: Christian Mazakas Signed-off-by: Ammar Faizi --- README | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README b/README index 4dd59f67fcbfbc5e..9c881ae75787795c 100644 --- a/README +++ b/README @@ -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 ------- -- Ammar Faizi