From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id 1EBA91F7 for ; Fri, 30 Jan 2015 18:13:44 +0100 (CET) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga103.jf.intel.com with ESMTP; 30 Jan 2015 09:09:17 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.09,492,1418112000"; d="scan'208";a="670400242" Received: from irsmsx154.ger.corp.intel.com ([163.33.192.96]) by fmsmga002.fm.intel.com with ESMTP; 30 Jan 2015 09:13:41 -0800 Received: from irsmsx108.ger.corp.intel.com ([169.254.11.64]) by IRSMSX154.ger.corp.intel.com ([169.254.12.111]) with mapi id 14.03.0195.001; Fri, 30 Jan 2015 17:13:40 +0000 From: "Gray, Mark D" To: Neil Horman , "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH v4 1/4] compat: Add infrastructure to support symbol versioning Thread-Index: AQHQMPqaCHkvdCo7AEOiQU6sQD4WvpzY+/Ow Date: Fri, 30 Jan 2015 17:13:40 +0000 Message-ID: <738D45BC1F695740A983F43CFE1B7EA92E199CA7@IRSMSX108.ger.corp.intel.com> References: <1419109299-9603-1-git-send-email-nhorman@tuxdriver.com> <1421350516-10628-1-git-send-email-nhorman@tuxdriver.com> In-Reply-To: <1421350516-10628-1-git-send-email-nhorman@tuxdriver.com> Accept-Language: en-IE, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [163.33.239.181] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v4 1/4] compat: Add infrastructure to support symbol versioning X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 30 Jan 2015 17:13:45 -0000 I agree in principle with this patchset. OVS links with DPDK and providing = stability in the ABI/API (and the Policy to manage this) makes deployment e= asier for OVS when linking with shared dpdk libs. It should also be easy fo= r us to track changes in the API through the deprecation notices making dev= elopment easier!=20 Good job. Acked-by: Mark D. Gray > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Neil Horman > Sent: Thursday, January 15, 2015 7:35 PM > To: dev@dpdk.org > Subject: [dpdk-dev] [PATCH v4 1/4] compat: Add infrastructure to support > symbol versioning >=20 > Add initial pass header files to support symbol versioning. >=20 > Signed-off-by: Neil Horman > CC: Thomas Monjalon > CC: "Richardson, Bruce" > CC: "Gonzalez Monroy, Sergio" >=20 > --- > Change Notes: > V2) > Moved ifeq to _INSTALL target >=20 > V3) > Undo V2 changes and make librte_compat use the rte.install.mk file > instead >=20 > v4) > changed --version-script to accept SRCDIR in this patch at per request > documented versioning macros > cleaned up macro parameter consistency > converted SA macro to RTE_STR macro > fixed copyright > --- > lib/Makefile | 1 + > lib/librte_compat/Makefile | 38 +++++++++++++ > lib/librte_compat/rte_compat.h | 117 > +++++++++++++++++++++++++++++++++++++++++ > mk/rte.lib.mk | 4 ++ > 4 files changed, 160 insertions(+) > create mode 100644 lib/librte_compat/Makefile create mode 100644 > lib/librte_compat/rte_compat.h >=20 > diff --git a/lib/Makefile b/lib/Makefile index 0ffc982..d617d81 100644 > --- a/lib/Makefile > +++ b/lib/Makefile > @@ -31,6 +31,7 @@ >=20 > include $(RTE_SDK)/mk/rte.vars.mk >=20 > +DIRS-y +=3D librte_compat > DIRS-$(CONFIG_RTE_LIBRTE_EAL) +=3D librte_eal > DIRS-$(CONFIG_RTE_LIBRTE_MALLOC) +=3D librte_malloc > DIRS-$(CONFIG_RTE_LIBRTE_RING) +=3D librte_ring diff --git > a/lib/librte_compat/Makefile b/lib/librte_compat/Makefile new file mode > 100644 index 0000000..0bab870 > --- /dev/null > +++ b/lib/librte_compat/Makefile > @@ -0,0 +1,38 @@ > +# BSD LICENSE > +# > +# Copyright(c) 2013 Neil Horman > +# All rights reserved. > +# > +# Redistribution and use in source and binary forms, with or without > +# modification, are permitted provided that the following conditions > +# are met: > +# > +# * Redistributions of source code must retain the above copyright > +# notice, this list of conditions and the following disclaimer. > +# * Redistributions in binary form must reproduce the above copyrigh= t > +# notice, this list of conditions and the following disclaimer in > +# the documentation and/or other materials provided with the > +# distribution. > +# * Neither the name of Intel Corporation nor the names of its > +# contributors may be used to endorse or promote products derived > +# from this software without specific prior written permission. > +# > +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND > CONTRIBUTORS > +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT > NOT > +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND > FITNESS FOR > +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE > COPYRIGHT > +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, > INCIDENTAL, > +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT > NOT > +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS > OF USE, > +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED > AND ON ANY > +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR > TORT > +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF > THE USE > +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH > DAMAGE. > + > +include $(RTE_SDK)/mk/rte.vars.mk > + > + > +# install includes > +SYMLINK-y-include :=3D rte_compat.h > + > +include $(RTE_SDK)/mk/rte.install.mk > diff --git a/lib/librte_compat/rte_compat.h > b/lib/librte_compat/rte_compat.h new file mode 100644 index > 0000000..d7cc176 > --- /dev/null > +++ b/lib/librte_compat/rte_compat.h > @@ -0,0 +1,117 @@ > +/*- > + * BSD LICENSE > + * > + * Copyright(c) 2010 Neil Horman . > + * All rights reserved. > + * > + * Redistribution and use in source and binary forms, with or without > + * modification, are permitted provided that the following conditions > + * are met: > + * > + * * Redistributions of source code must retain the above copyright > + * notice, this list of conditions and the following disclaimer. > + * * Redistributions in binary form must reproduce the above copyrig= ht > + * notice, this list of conditions and the following disclaimer in > + * the documentation and/or other materials provided with the > + * distribution. > + * * Neither the name of Intel Corporation nor the names of its > + * contributors may be used to endorse or promote products derived > + * from this software without specific prior written permission. > + * > + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND > CONTRIBUTORS > + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT > NOT > + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND > FITNESS FOR > + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE > COPYRIGHT > + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, > INCIDENTAL, > + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT > NOT > + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS > OF USE, > + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED > AND ON ANY > + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR > TORT > + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF > THE USE > + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH > DAMAGE. > + */ > + > +#ifndef _RTE_COMPAT_H_ > +#define _RTE_COMPAT_H_ > +#include > + > +#ifdef RTE_BUILD_SHARED_LIB > + > +/* > + * Provides backwards compatibility when updating exported functions. > + * When a symol is exported from a library to provide an API, it also > +provides a > + * calling convention (ABI) that is embodied in its name, return type, > + * arguments, etc. On occasion that function may need to change to > +accomodate > + * new functionality, behavior, etc. When that occurs, it is > +desireable to > + * allow for backwards compatibility for a time with older binaries > +that are > + * dynamically linked to the dpdk. To support that, the __vsym and > + * VERSION_SYMBOL macros are created. They, in conjunction with the > + * _version.map file for a given library allow for multiple > +versions of > + * a symbol to exist in a shared library so that older binaries need > +not be > + * immediately recompiled. Their use is outlined in the following exampl= e: > + * Assumptions: DPDK 1.(X) contains a function int foo(char *string) > + * DPDK 1.(X+1) needs to change foo to be int foo(int index= ) > + * > + * To accomplish this: > + * 1) Edit lib//library_version.map to add a DPDK_1.(X+1) > +node, in which > + * foo is exported as a global symbol. > + * > + * 2) rename the existing function int foo(char *string) to > + * int __vsym foo_v18(char *string) > + * > + * 3) Add this macro immediately below the function > + * VERSION_SYMBOL(foo, _v18, 1.8); > + * > + * 4) Implement a new version of foo. > + * char foo(int value, int otherval) { ...} > + * > + * 5) Mark the newest version as the default version > + * BIND_DEFAULT_SYMBOL(foo, 1.9); > + * > + */ > + > +/* > + * Macro Parameters: > + * b - function base name > + * e - function version extension, to be concatenated with base name > + * n - function symbol version string to be applied */ > + > +/* > + * VERSION_SYMBOL > + * Creates a symbol version table entry binding symbol @DPDK_ to > +the internal > + * function name _ > + */ > +#define VERSION_SYMBOL(b, e, n) __asm__(".symver " RTE_STR(b) > +RTE_STR(e) ", "RTE_STR(b)"@DPDK_"RTE_STR(n)) > + > +/* > + * BASE_SYMBOL > + * Creates a symbol version table entry binding unversioned symbol > + * to the internal function _ > + */ > +#define BASE_SYMBOL(b, e) __asm__(".symver " RTE_STR(b) RTE_STR(e) ", > +"RTE_STR(b)"@") > + > +/* > + * BNID_DEFAULT_SYMBOL > + * Creates a symbol version entry instructing the linker to bind > +references to > + * symbol to the internal symbol _ */ #define > +BIND_DEFAULT_SYMBOL(b, e, n) __asm__(".symver " RTE_STR(b) > RTE_STR(e) > +", "RTE_STR(b)"@@DPDK_"RTE_STR(n)) #define __vsym > __attribute__((used)) > + > +#else > +/* > + * No symbol versioning in use > + */ > +#define VERSION_SYMBOL(b, e, v) > +#define __vsym > +#define BASE_SYMBOL(b, n) > +#define BIND_DEFAULT_SYMBOL(b, v) > + > +/* > + * RTE_BUILD_SHARED_LIB=3Dn > + */ > +#endif > + > + > +#endif /* _RTE_COMPAT_H_ */ > diff --git a/mk/rte.lib.mk b/mk/rte.lib.mk index 81bf8e1..1d3b646 100644 > --- a/mk/rte.lib.mk > +++ b/mk/rte.lib.mk > @@ -40,8 +40,12 @@ VPATH +=3D $(SRCDIR) >=20 > ifeq ($(RTE_BUILD_SHARED_LIB),y) > LIB :=3D $(patsubst %.a,%.so,$(LIB)) > + > +CPU_LDFLAGS +=3D --version-script=3D$(SRCDIR)/$(EXPORT_MAP) > + > endif >=20 > + > _BUILD =3D $(LIB) > _INSTALL =3D $(INSTALL-FILES-y) $(SYMLINK-FILES-y) > $(RTE_OUTPUT)/lib/$(LIB) _CLEAN =3D doclean > -- > 2.1.0