From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas@monjalon.net>
Subject: Re: [PATCH v3 4/6] eal/memory: rename memory API to iova
	types
Date: Fri, 03 Nov 2017 12:11:47 +0100
Message-ID: <5335497.nnbAZL8Naz@xps>
References: <20170905103119.20511-1-santosh.shukla@caviumnetworks.com>
 <20171020123136.10557-1-santosh.shukla@caviumnetworks.com>
 <20171020123136.10557-5-santosh.shukla@caviumnetworks.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org, olivier.matz@6wind.com, jerin.jacob@caviumnetworks.com,
 hemant.agrawal@nxp.com, anatoly.burakov@intel.com
To: Santosh Shukla <santosh.shukla@caviumnetworks.com>
Return-path: <dev-bounces@dpdk.org>
Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com
 [66.111.4.28]) by dpdk.org (Postfix) with ESMTP id E6A3B1B659
 for <dev@dpdk.org>; Fri,  3 Nov 2017 12:11:49 +0100 (CET)
In-Reply-To: <20171020123136.10557-5-santosh.shukla@caviumnetworks.com>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

20/10/2017 14:31, Santosh Shukla:
> Renamed memory translational api to _iova types.
> The following api renamed from:
> 
> rte_mempool_populate_phys()
> rte_mempool_populate_phys_tab()

These functions still have "physical addresses" in their description.
It is not consistent.

Please provide ABI compatibility for mempool functions.

> rte_eal_using_phys_addrs()

Why renaming rte_eal_using_phys_addrs?
I think we need to review how it is used.
Maybe it requires a rework.

> rte_mem_virt2phy()
> rte_dump_physmem_layout()
> rte_eal_get_physmem_layout()
> rte_eal_get_physmem_size()

Those 3 functions deal with physical memory layout.
I don't see a need to rename them.

But the dump function needs a change to avoid printing
"phys" even in VA case.

> rte_malloc_virt2phy()
> rte_mem_phy2mch()

This last function was removed with Xen.
It is wrong to rename it in the release notes.
It should just be removed from the map file (I will send a patch).

> To the following iova types api:
> 
> rte_mempool_populate_iova()
> rte_mempool_populate_iova_tab()
> rte_eal_using_iova_addrs()
> rte_mem_virt2iova()
[...]
> rte_malloc_virt2iova()

I am not convinced by the names virt2iova.
I sounds like "virt to virt".
What about "virt2io" or "virt2io_addr"?

As the ABI is broken in EAL 17.11, we do not care about compatibility.
But we must keep an alias to the old function name in order to allow
a smooth API transition for applications.
I suggest to add static inline functions with the old names and set
the deprecated attribute.