From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id B20EBA04F0; Tue, 10 Dec 2019 17:39:08 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id D515537A2; Tue, 10 Dec 2019 17:39:07 +0100 (CET) Received: from new1-smtp.messagingengine.com (new1-smtp.messagingengine.com [66.111.4.221]) by dpdk.org (Postfix) with ESMTP id 8D38E23D for <dev@dpdk.org>; Tue, 10 Dec 2019 17:39:05 +0100 (CET) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailnew.nyi.internal (Postfix) with ESMTP id D5E355AEA; Tue, 10 Dec 2019 11:39:04 -0500 (EST) Received: from mailfrontend2 ([10.202.2.163]) by compute1.internal (MEProxy); Tue, 10 Dec 2019 11:39:04 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=mesmtp; bh=HJEvlMf0gNc/+RJ5oHFA13WcTXfeS5Frse5ZXXj9JX8=; b=awzy8iRHn40a JFZqvSsYthoK3TSfi4idrnXgIhTRyVgj6XLt39JYF6tYz9ESSDFD6nnFoiPFqYQC svO/1H4dSNOhZ49Eom/Uh0yfvFWa3L/1tJc8+gqCP0Ldwdr1McCV7F8PxPijtld/ 9KQD6ZsKRUL02XsH4zSVGpKRewBmIJY= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm1; bh=HJEvlMf0gNc/+RJ5oHFA13WcTXfeS5Frse5ZXXj9J X8=; b=ZcWeemzkeKXV71uv26lHN6O/SEc6zwNXFz5/SjLx+M/mMmsLG9A0O5EOu eGZZ1MPMk6VUtplhFmJeQaQdCxzSgNQoUtwTZ5wqsqrhl4abyMdtP7mER2vG+moU YrlZNKFSj28YjQQdq/Mud2rSlCTz36AvtXps2BaQQim3C3Bv+/9nhCeqqwXcmVdo RM4dBNMwPX77e9CLEMqUkY6lYt+vI1RCcpshz/tYRiBfJHgp70IBb1btMuBLQf48 92kIkRxRxNJnI4IhnfZ2Cd6kD5pHSC2keJ1mg8gZVjlkJ9UFzKUrd7VIHEWGf+gb Ym2rSFDGummqC7nccwSQQQSYm41qA== X-ME-Sender: <xms:J8rvXfgJNuHS3vGBLR7lNMQ1vbCUzQsJuFe9CTAvKR3rqE8wpIWmDw> X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedufedrudelfedgledtucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne goufhushhpvggtthffohhmrghinhculdegledmnecujfgurhephffvufffkfgjfhgggfgt sehtufertddttddvnecuhfhrohhmpefvhhhomhgrshcuofhonhhjrghlohhnuceothhhoh hmrghssehmohhnjhgrlhhonhdrnhgvtheqnecuffhomhgrihhnpeguphgukhdrohhrghen ucfkphepjeejrddufeegrddvtdefrddukeegnecurfgrrhgrmhepmhgrihhlfhhrohhmpe hthhhomhgrshesmhhonhhjrghlohhnrdhnvghtnecuvehluhhsthgvrhfuihiivgeptd X-ME-Proxy: <xmx:J8rvXX5OVPpRCzM_3E5QjkZ4dCVytRUYALaYp4-nEvToqwCKGoDpwA> <xmx:J8rvXX6wbmZvP7B6ZBakNshDnqKioCIPoWa9-SmOqcRWFQ4AYpc5tw> <xmx:J8rvXVGsota8OY5asd3giXbj5i2UGbsJkY3DGLiaCE9nYBHgSQT1og> <xmx:KMrvXf0bunm8YwX2xst3bzFDfN07KskzrjXSTlThD7t2dHOALl6Lag> Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id AC3C530600DC; Tue, 10 Dec 2019 11:39:02 -0500 (EST) From: Thomas Monjalon <thomas@monjalon.net> To: Luca Boccassi <bluca@debian.org>, Bruce Richardson <bruce.richardson@intel.com>, Ferruh Yigit <ferruh.yigit@intel.com> Cc: "Kinsella, Ray" <ray.kinsella@intel.com>, David Marchand <david.marchand@redhat.com>, Christian Ehrhardt <christian.ehrhardt@canonical.com>, Timothy Redaelli <tredaelli@redhat.com>, Kevin Traynor <ktraynor@redhat.com>, dpdk-dev <dev@dpdk.org>, "Laatz, Kevin" <kevin.laatz@intel.com>, Andrew Rybchenko <arybchenko@solarflare.com>, Neil Horman <nhorman@redhat.com> Date: Tue, 10 Dec 2019 17:39:00 +0100 Message-ID: <3980613.7Ici8vhY7Y@xps> In-Reply-To: <8ce12dcd655b77fe20e35237684afedb11a51445.camel@debian.org> References: <5df1a33b-b338-bde1-6834-e8b5fbe65a04@intel.com> <20191210154652.GA115@bricha3-MOBL.ger.corp.intel.com> <8ce12dcd655b77fe20e35237684afedb11a51445.camel@debian.org> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] How to manage new APIs added after major ABI release? X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org> 10/12/2019 17:20, Luca Boccassi: > On Tue, 2019-12-10 at 15:46 +0000, Bruce Richardson wrote: > > On Tue, Dec 10, 2019 at 03:03:51PM +0000, Luca Boccassi wrote: > > > On Tue, 2019-12-10 at 14:36 +0000, Bruce Richardson wrote: > > > > On Tue, Dec 10, 2019 at 12:40:53PM +0000, Ferruh Yigit wrote: > > > > > On 12/10/2019 12:04 PM, Bruce Richardson wrote: > > > > > > On Tue, Dec 10, 2019 at 11:56:28AM +0000, Ferruh Yigit wrote: > > > > > > > Hi, > > > > > > > > > > > > > > With new process, the major ABI releases will be compatible > > > > > > > until it is > > > > > > > deprecated (until next LTS for now), > > > > > > > like current ABI version is 20 in DPDK_19.11 and DPDK > > > > > > > versions > > > > > > > until DPDK_20.11 > > > > > > > will be ABI compatible with this version. > > > > > > > > > > > > > > But if we introduce a new API after major ABI, say in 20.02 > > > > > > > release, are we > > > > > > > allowed to break the ABI for that API before DPDK_20.11? > > > > > > > > > > > > > > If we allow it break, following problem will be observed: > > > > > > > Assume an application using .so.20.1 library, and using the > > > > > > > new > > > > > > > API introduced > > > > > > > in 20.02, lets say foo(), > > > > > > > but when application switches to .so.20.2 (released via > > > > > > > DPDK_20.05), application > > > > > > > will fail because of ABI breakage in foo(). > > > > > > > > > > > > > > I think it is fair that application expects forward > > > > > > > compatibility in minor > > > > > > > versions of a shared library. > > > > > > > Like if application linked against .so.20.2, fair to expect > > > > > > > .so.20.3, .so.20.4 > > > > > > > etc will work fine. I think currently only .so.20.0 is > > > > > > > fully > > > > > > > forward compatible. > > > > > > > > > > > > > > If we all agree on this, we may need to tweak the process a > > > > > > > little, but before > > > > > > > diving into implementation details, I would like to be sure > > > > > > > we > > > > > > > are in same page. > > > > > > > > > > > > > > > > > > > Well, any new API's generally come in as experimental, in > > > > > > which > > > > > > case > > > > > > changes are allowed, and breakage can be expected. If they > > > > > > are > > > > > > not > > > > > > experiemental, then the ABI policy applies to them in that > > > > > > they > > > > > > cannot > > > > > > change since they are part of the .21 ABI, even if that ABI > > > > > > is > > > > > > not fully > > > > > > complete yet. For any application only using stable, non- > > > > > > experimental > > > > > > functions, forward compatibility must be maintained IMHO. > > > > > > > > > > > > > > > > Talking about not experimental APIs, experimental ones free > > > > > from > > > > > the process. > > > > > > > > > > And when and API added in 20.02 (ABI_20.1) it is kind of still > > > > > ABI_20, because > > > > > it should be supported for following ABI_20.x, instead of > > > > > calling > > > > > it ABI_21, and > > > > > this minor tweak (and mind shift) in .map files can be our > > > > > solution. > > > > > > > > Related at what to do with adding versions between major ABI > > > > versions, when > > > > investigating with Kevin the ABI checking we have made an > > > > unpleasant > > > > discovery: > > > > > > > > This minor version bumping from 20.0 to 20.1 has apparently > > > > already > > > > broken > > > > our ABI according to libabigail. > > > > > > > > The Gory Details [skip to the end for suggestions to fix] > > > > ------------------------------------------------------------ > > > > > > > > The reason for this is that the soversion encoded in each library > > > > - > > > > whether > > > > built with meson or make - is the full 20.0 version, not just the > > > > major ABI > > > > .20 part. Then when apps link against DPDK, they actually encode > > > > the > > > > 20.0. > > > > > > > > So what this means is that currently - using a make build as an > > > > example > > > > here - ldd on the latest head build gives: > > > > > > > > LD_LIBRARY_PATH=$(pwd)/x86_64-native-linux-gcc/lib ldd x86_64- > > > > native-linux-gcc/app/testpmd | head > > > > linux-vdso.so.1 (0x00007fff6813d000) > > > > librte_pmd_bond.so.20.1 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc/lib/librte_pmd_bond.so.20.1 (0x00007f36d723c000) > > > > librte_pmd_dpaa.so.20.1 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc/lib/librte_pmd_dpaa.so.20.1 (0x00007f36d7229000) > > > > librte_mempool_dpaa.so.20.1 => > > > > /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc/lib/librte_mempool_dpaa.so.20.1 > > > > (0x00007f36d7224000) > > > > librte_pmd_ixgbe.so.20.1 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc/lib/librte_pmd_ixgbe.so.20.1 > > > > (0x00007f36d71ba000) > > > > librte_pmd_i40e.so.20.1 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc/lib/librte_pmd_i40e.so.20.1 (0x00007f36d7126000) > > > > librte_pmd_bnxt.so.20.1 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc/lib/librte_pmd_bnxt.so.20.1 (0x00007f36d70e5000) > > > > librte_pmd_softnic.so.20.1 => > > > > /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc/lib/librte_pmd_softnic.so.20.1 > > > > (0x00007f36d70b7000) > > > > librte_flow_classify.so.0.201 => > > > > /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc/lib/librte_flow_classify.so.0.201 > > > > (0x00007f36d70b1000) > > > > librte_pipeline.so.20.1 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc/lib/librte_pipeline.so.20.1 (0x00007f36d7088000) > > > > ... > > > > > > > > Similarly ldd on a 19.11 checkout gives: > > > > > > > > LD_LIBRARY_PATH=$(pwd)/x86_64-native-linux-gcc_v19.11/lib ldd > > > > x86_64- > > > > native-linux-gcc_v19.11/app/testpmd | head > > > > linux-vdso.so.1 (0x00007ffc2a964000) > > > > librte_pmd_bond.so.20.0 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc_v19.11/lib/librte_pmd_bond.so.20.0 > > > > (0x00007fd4dc6b6000) > > > > librte_pmd_dpaa.so.20.0 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc_v19.11/lib/librte_pmd_dpaa.so.20.0 > > > > (0x00007fd4dc6a3000) > > > > librte_mempool_dpaa.so.20.0 => > > > > /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc_v19.11/lib/librte_mempool_dpaa.so.20.0 > > > > (0x00007fd4dc69e000) > > > > librte_pmd_ixgbe.so.20.0 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc_v19.11/lib/librte_pmd_ixgbe.so.20.0 > > > > (0x00007fd4dc634000) > > > > librte_pmd_i40e.so.20.0 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc_v19.11/lib/librte_pmd_i40e.so.20.0 > > > > (0x00007fd4dc5a0000) > > > > librte_pmd_bnxt.so.20.0 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc_v19.11/lib/librte_pmd_bnxt.so.20.0 > > > > (0x00007fd4dc55d000) > > > > librte_pmd_softnic.so.20.0 => > > > > /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc_v19.11/lib/librte_pmd_softnic.so.20.0 > > > > (0x00007fd4dc531000) > > > > librte_flow_classify.so.0.200 => > > > > /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc_v19.11/lib/librte_flow_classify.so.0.200 > > > > (0x00007fd4dc52b000) > > > > librte_pipeline.so.20.0 => /home/bruce/dpdk.org/x86_64- > > > > native-linux-gcc_v19.11/lib/librte_pipeline.so.20.0 > > > > (0x00007fd4dc502000) > > > > > > > > The final check - using the 19.11 compiled testpmd with the > > > > library > > > > path > > > > set to 20.02 versionned libs: > > > > > > > > LD_LIBRARY_PATH=$(pwd)/x86_64-native-linux-gcc/lib ldd x86_64- > > > > native- > > > > linux-gcc_v19.11/app/testpmd | head > > > > linux-vdso.so.1 (0x00007ffc711fc000) > > > > librte_pmd_bond.so.20.0 => not found > > > > librte_pmd_dpaa.so.20.0 => not found > > > > librte_mempool_dpaa.so.20.0 => not found > > > > librte_pmd_ixgbe.so.20.0 => not found > > > > librte_pmd_i40e.so.20.0 => not found > > > > librte_pmd_bnxt.so.20.0 => not found > > > > librte_pmd_softnic.so.20.0 => not found > > > > librte_flow_classify.so.0.200 => not found > > > > librte_pipeline.so.20.0 => not found > > > > > > > > Fixing This > > > > ----------- > > > > > > > > To fix this, we need to ensure that the SONAME remains constant > > > > across the > > > > releases. Therefore, I currently see two options: > > > > > > > > 1. keep 20.0 as the version and soname across all releases in > > > > 2020, > > > > i.e. > > > > just revert the ABIVERSION change patch. Trouble there is how > > > > to > > > > track > > > > 20.02 vs 20.05 etc. etc. > > > > > > > > 2. remove the .0, .1 from the SONAMES stored in the libraries. > > > > This > > > > has the > > > > advantage of keeping the existing planned schemes, but has the > > > > really big > > > > downside of breaking ABI compatibility with anyone who has > > > > already > > > > compiled with 19.11. > > > > > > > > Personally, of the two options - unless someone can come up with > > > > a > > > > third > > > > option - I'd tend towards the second, fixing the builds to remove > > > > the > > > > .0 in > > > > the soname, and releasing that ASAP as 19.11.1 before 19.11 gets > > > > widespread > > > > adoption. Since this ABI stability is new, teething problems may > > > > be > > > > expected. > > > > > > > > Thoughts and comments? > > > > /Bruce > > > > > > > > BTW: For meson, the patch for option 2 is just to remove the > > > > so_version > > > > variable and all references to it from lib/meson.build and > > > > drivers/meson.build. Haven't looked into a "make" fix yet. > > > > > > Hi, > > > > > > With libtool and its (arguably arcane) format, only the first digit > > > is > > > the ABI current version and gets encoded in the elf header. The > > > other > > > digits can be used to track compatible minor increments, and are > > > mostly > > > ignored. On the system a symlink libfoo.so.major -> > > > libfoo.so.major.minor is added. > > > > > > Eg: > > > > > > $ readelf -d /usr/lib/x86_64-linux-gnu/libzmq.so.5.2.3 | grep > > > SONAME > > > 0x000000000000000e (SONAME) Library soname: > > > [libzmq.so.5] > > > $ ls -l /usr/lib/x86_64-linux-gnu/libzmq.so.5 > > > lrwxrwxrwx 1 root root 15 Dec 31 2014 /usr/lib/x86_64-linux- > > > gnu/libzmq.so.5 -> libzmq.so.5.2.3 > > > > > > Can we do the same? Not sure what the right incantation is for > > > Meson, > > > but it should be possibly. > > > > > > > That's essentially option 2, and it's still an ABI break because > > existing > > builds of 19.11 have the soname will the full version number in it. > > The > > default behaviour for meson is exactly how you described it, except > > that > > previously we needed more exact control over the version info (for > > your > > dpdk-specific versions in the sonames) and so overrode the soversion > > explicitly. The fix for meson is to remove this overriding i.e. > > remove > > "soversion:" parameter for each shared_library() call. > > > > > > > Also, we should leave the current at 20.0 - let's not break > > > compatibility already, please :-) > > > > > > > If we do this, maybe we can use 20.0.1 and 20.0.2 version numbers? > > Yes, that's what I meant - IMHO we should just take the hit and use the > slightly weird 20.0 format until next year, and add a third digit for > compatible updates. Then for v21 we can drop it. I am not sure to understand everything above. My understanding is that the soname must include major and minor: libfoo.major.minor and the package system must install 2 symlinks: libfoo.major points to latest installed minor libfoo points to latest major We are missing the symlink libfoo.major in 19.11.0. I suggest to just add this symlink in 19.11.1 and 20.02. The other question is to know what the internal apps should link? Is there any sense linking testpmd to libfoo.major?