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 B66985A29 for ; Wed, 17 Jun 2015 13:06:46 +0200 (CEST) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga103.jf.intel.com with ESMTP; 17 Jun 2015 04:06:46 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.13,632,1427785200"; d="scan'208";a="748271733" Received: from irsmsx104.ger.corp.intel.com ([163.33.3.159]) by orsmga002.jf.intel.com with ESMTP; 17 Jun 2015 04:06:45 -0700 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.216]) by IRSMSX104.ger.corp.intel.com ([169.254.5.171]) with mapi id 14.03.0224.002; Wed, 17 Jun 2015 12:06:43 +0100 From: "Richardson, Bruce" To: Neil Horman , Thomas Monjalon Thread-Topic: [dpdk-dev] [dpdk-announce] important design choices - statistics - ABI Thread-Index: AQHQqOsvsdq4k1VJSkK3G8vnjLgUZZ2wiU8w Date: Wed, 17 Jun 2015 11:06:42 +0000 Message-ID: <59AF69C657FD0841A61C55336867B5B034558F92@IRSMSX103.ger.corp.intel.com> References: <9092314.MoyqUJ5VU2@xps13> <20150617103521.GB24677@hmsreliant.think-freely.org> In-Reply-To: <20150617103521.GB24677@hmsreliant.think-freely.org> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [163.33.239.182] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Cc: "dev@dpdk.org" Subject: Re: [dpdk-dev] [dpdk-announce] important design choices - statistics - ABI 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: Wed, 17 Jun 2015 11:06:47 -0000 > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Neil Horman > Sent: Wednesday, June 17, 2015 11:35 AM > To: Thomas Monjalon > Cc: announce@dpdk.org > Subject: Re: [dpdk-dev] [dpdk-announce] important design choices - > statistics - ABI >=20 > On Wed, Jun 17, 2015 at 01:29:47AM +0200, Thomas Monjalon wrote: > > Hi all, > > > > Sometimes there are some important discussions about architecture or > > design which require opinions from several developers. Unfortunately, > > we cannot read every threads. Maybe that using the announce mailing > > list will help to bring more audience to these discussions. > > Please note that > > - the announce@ ML is moderated to keep a low traffic, > > - every announce email is forwarded to dev@ ML. > > In case you want to reply to this email, please use dev@dpdk.org > address. > > > > There were some debates about software statistics disabling. > > Should they be always on or possibly disabled when compiled? > > We need to take a decision shortly and discuss (or agree) this proposal= : > > http://dpdk.org/ml/archives/dev/2015-June/019461.html > > > > During the development of the release 2.0, there was an agreement to > > keep ABI compatibility or to bring new ABI while keeping old one during > one release. > > In case it's not possible to have this transition, the (exceptional) > > break should be acknowledged by several developers. > > http://dpdk.org/doc/guides-2.0/rel_notes/abi.html > > There were some interesting discussions but not a lot of participants: > > > > http://thread.gmane.org/gmane.comp.networking.dpdk.devel/8367/focus=3D8= 4 > > 61 > > > > During the current development cycle for the release 2.1, the ABI > > question arises many times in different threads. > > To add the hash key size field, it is proposed to use a struct padding > gap: > > http://dpdk.org/ml/archives/dev/2015-June/019386.html > > To support the flow director for VF, there is no proposal yet: > > http://dpdk.org/ml/archives/dev/2015-June/019343.html > > To add the speed capability, it is proposed to break ABI in the release > 2.2: > > http://dpdk.org/ml/archives/dev/2015-June/019225.html > > To support vhost-user multiqueues, it is proposed to break ABI in 2.2: > > http://dpdk.org/ml/archives/dev/2015-June/019443.html > > To add the interrupt mode, it is proposed to add a build-time option > > CONFIG_RTE_EAL_RX_INTR to switch between compatible and ABI breaking > binary: > > http://dpdk.org/ml/archives/dev/2015-June/018947.html > > To add the packet type, there is a proposal to add a build-time option > > CONFIG_RTE_NEXT_ABI common to every ABI breaking features: > > http://dpdk.org/ml/archives/dev/2015-June/019172.html > > We must also better document how to remove a deprecated ABI: > > http://dpdk.org/ml/archives/dev/2015-June/019465.html > > The ABI compatibility is a new constraint and we need to better > > understand what it means and how to proceed. Even the macros are not ye= t > well documented: > > http://dpdk.org/ml/archives/dev/2015-June/019357.html > > > > Thanks for your attention and your participation in these important > choices. > > >=20 > Thomas- > Just to re-iterate what you said earlier, and what was discussed in > the previous ABI discussions >=20 > 1) ABI stability was introduced to promote DPDK's ability to be included > with various linux and BSD distributions. Distributions, by and large, > favor building libraries as DSO's, favoring security and updatability in > favor of all out performance. >=20 > 2) The desire was to put DPDK developers in a mindset whereby ABI > stability was something they needed to think about during development, as > the DPDK exposes many data structures and instances that cannot be change= d > without breaking ABI >=20 > 3) The versioning mechanism was introduced to allow for backward > compatibility during periods in which we needed to support both an old an > new ABI >=20 > 4) As Stephan and others point out, its not expected that we will always > be able to maintain ABI, and as such an easy library versioning mechanism > was introduced to prevent the loading of an incompatible library with an > older application >=20 > 5) The ABI policy was introduced to create a method by which new ABI > facets could be scheduled while allowing distros to prepare their > downstream users for the upcomming changes. >=20 >=20 > It seems to me, looking back over these last few months, that we're > falling down a bit on our use of (3). I've seen several people take > advantage of the ABI scheduled updates, but no one has tried the > versioning interface, and as a result patches are getting delayed, which > was never my intent. Not sure whats to be done about that, but we should > probably address it. Is use of the versionnig interface just too hard or > convoluted? >=20 > Neil Hi Neil, =20 on my end, some suggestions: 1. the documentation on changing an API function provided in rte_compat.h is really good, but I don't think this is present in our documentation in the docs folder or on website is it (apologies if it is and I've missed it)? This needs to go into programmers guide or some other doc (perhaps the new doc that the coding style went into). 2. The documentation also needs an example of: this is how you add a new function and update the map file, and this is how you a) mark a function as deprecated and b) remove it completely. That way we could have one guide covering API versioning, how to add, modify and remove functions. 3. This doc should also cover how to use the API checker tool, something I haven't had the chance to look at yet, but should do in the near future! :-) Regards, /Bruce