[dpdk-dev] [PATCH] drivers: make driver names consistent
On Tue, Oct 18, 2016 at 06:46:40PM +0200, Thomas Monjalon wrote: > 2016-10-18 22:18, Yuanhan Liu: > > On Tue, Oct 18, 2016 at 03:42:54PM +0200, Thomas Monjalon wrote: > > > 2016-10-18 21:06, Yuanhan Liu: > > > > On Tue, Oct 18, 2016 at 02:50:16PM +0200, Jan Blunck wrote: > > > > > >From my understanding this is a massive API breakage. This forces all > > > > > existing users of the virtual PMDs to change with zero benefit. Even > > > > > if that isn't enough it also makes it impossible to switch between > > > > > releases by recompiling. > > > > > > > > > > Can we please revert these changes and work on some aliasing support > > > > > for the PMDs to fix it long term? > > > > > > > > +1. Aliasing is also something I would suggest before making such > > > > renames. > > > > > > It is a brutal change, yes. > > > It was announced in 16.07 release notes though. > > > > Yes, but it still took me a while (by running git bisect) to figure out > > what went wrong: I wasn't aware of such note, that I was thinking maybe > > something is broken. > > > > Later I also got quite few same complains. It may also took them a while > > to know what's happened. > > > > Anyway, my point is, for this kind of change, we should have added the > > alias support firstly. > > Yes. > > > If that's been done, then the announcement is not > > needed at all? > > The announcement would be needed to remove the aliases, later. Why do you have to remove an aliase? What's wrong if they stay there forever. I think the naming will be switched (maybe slowly) when we haved updated the doc (whereas it states "net_vhost" but not "eth_vhost" only). After few releases, the name should have been switched fluently. And we should not care about those alias. --yliu
[dpdk-dev] [PATCH] drivers: make driver names consistent
On Tue, Oct 18, 2016 at 05:26:22PM +0200, Jan Blunck wrote: > On Tue, Oct 18, 2016 at 3:42 PM, Thomas Monjalon > wrote: > > 2016-10-18 21:06, Yuanhan Liu: > >> On Tue, Oct 18, 2016 at 02:50:16PM +0200, Jan Blunck wrote: > >> > >From my understanding this is a massive API breakage. This forces all > >> > existing users of the virtual PMDs to change with zero benefit. Even > >> > if that isn't enough it also makes it impossible to switch between > >> > releases by recompiling. > >> > > >> > Can we please revert these changes and work on some aliasing support > >> > for the PMDs to fix it long term? > >> > >> +1. Aliasing is also something I would suggest before making such renames. > > > > It is a brutal change, yes. > > It was announced in 16.07 release notes though. > > > > "But the plans were on display ..." (HHGTTG) > Yes, 16.07, better known as the "Beware of the leopard" release of DPDK. :-) /Bruce
[dpdk-dev] [PATCH] drivers: make driver names consistent
2016-10-19 18:05, Yuanhan Liu: > On Tue, Oct 18, 2016 at 06:46:40PM +0200, Thomas Monjalon wrote: > > 2016-10-18 22:18, Yuanhan Liu: > > > On Tue, Oct 18, 2016 at 03:42:54PM +0200, Thomas Monjalon wrote: > > > > 2016-10-18 21:06, Yuanhan Liu: > > > > > On Tue, Oct 18, 2016 at 02:50:16PM +0200, Jan Blunck wrote: > > > > > > >From my understanding this is a massive API breakage. This forces > > > > > > >all > > > > > > existing users of the virtual PMDs to change with zero benefit. Even > > > > > > if that isn't enough it also makes it impossible to switch between > > > > > > releases by recompiling. > > > > > > > > > > > > Can we please revert these changes and work on some aliasing support > > > > > > for the PMDs to fix it long term? > > > > > > > > > > +1. Aliasing is also something I would suggest before making such > > > > > renames. > > > > > > > > It is a brutal change, yes. > > > > It was announced in 16.07 release notes though. > > > > > > Yes, but it still took me a while (by running git bisect) to figure out > > > what went wrong: I wasn't aware of such note, that I was thinking maybe > > > something is broken. > > > > > > Later I also got quite few same complains. It may also took them a while > > > to know what's happened. > > > > > > Anyway, my point is, for this kind of change, we should have added the > > > alias support firstly. > > > > Yes. > > > > > If that's been done, then the announcement is not > > > needed at all? > > > > The announcement would be needed to remove the aliases, later. > > Why do you have to remove an aliase? What's wrong if they stay there > forever. I think the naming will be switched (maybe slowly) when we > haved updated the doc (whereas it states "net_vhost" but not "eth_vhost" > only). > > After few releases, the name should have been switched fluently. And > we should not care about those alias. Yes I was just thinking removing dead code later. And it's generally simpler to end with only one way of doing things.
[dpdk-dev] [PATCH] drivers: make driver names consistent
On Tue, Oct 18, 2016 at 03:42:54PM +0200, Thomas Monjalon wrote: > 2016-10-18 21:06, Yuanhan Liu: > > On Tue, Oct 18, 2016 at 02:50:16PM +0200, Jan Blunck wrote: > > > >From my understanding this is a massive API breakage. This forces all > > > existing users of the virtual PMDs to change with zero benefit. Even > > > if that isn't enough it also makes it impossible to switch between > > > releases by recompiling. > > > > > > Can we please revert these changes and work on some aliasing support > > > for the PMDs to fix it long term? > > > > +1. Aliasing is also something I would suggest before making such renames. > > It is a brutal change, yes. > It was announced in 16.07 release notes though. Yes, but it still took me a while (by running git bisect) to figure out what went wrong: I wasn't aware of such note, that I was thinking maybe something is broken. Later I also got quite few same complains. It may also took them a while to know what's happened. Anyway, my point is, for this kind of change, we should have added the alias support firstly. If that's been done, then the announcement is not needed at all? --yliu > > We can try to make this change more progressive by keeping old names > as aliases for some time. > Is there a volunteer to work on vdev names aliases, > with the target of integrating them in RC2 or RC3?
[dpdk-dev] [PATCH] drivers: make driver names consistent
On Tue, Oct 18, 2016 at 02:50:16PM +0200, Jan Blunck wrote: > >From my understanding this is a massive API breakage. This forces all > existing users of the virtual PMDs to change with zero benefit. Even > if that isn't enough it also makes it impossible to switch between > releases by recompiling. > > Can we please revert these changes and work on some aliasing support > for the PMDs to fix it long term? +1. Aliasing is also something I would suggest before making such renames. --yliu > > Thanks, > Jan > > > On Fri, Sep 16, 2016 at 11:58 AM, Thomas Monjalon > wrote: > > 2016-08-24 22:37, Mcnamara, John: > >> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Pablo de Lara > >> > > >> > ... > >> > > >> > -$RTE_TARGET/app/testpmd -c '0xf' -n 4 --vdev > >> > 'eth_pcap0,rx_pcap=/path/to/ file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' > >> > -- --port-topology=chained > >> > +$RTE_TARGET/app/testpmd -c '0xf' -n 4 --vdev > >> > 'net_pcap0,rx_pcap=/path/to/ file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' > >> > -- --port-topology=chained > >> > >> > >> I know that this is an existing issue but there shouldn't be a space in > >> "/path/to/ file". Perhaps you could fix that (in a number of places) as > >> part > >> of this patch. You could probably leave out the "/path/to/" part > >> altogether as > >> it may be clearer, see below. > >> > >> Also, could you wrap the long code lines in the sections that you change at > >> 80 chars using "\" to keep them on the page in the PDF docs, like: > >> > >> $RTE_TARGET/app/testpmd -c '0xf' -n 4 \ > >> --vdev > >> 'net_pcap0,rx_pcap=/path/to/file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' \ > >> -- --port-topology=chained > >> > >> Or without the path part: > >> > >> $RTE_TARGET/app/testpmd -c '0xf' -n 4 \ > >> --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ > >> -- --port-topology=chained > > > > Applied with above comments fixed and release notes updated, thanks.
[dpdk-dev] [PATCH] drivers: make driver names consistent
2016-10-18 22:18, Yuanhan Liu: > On Tue, Oct 18, 2016 at 03:42:54PM +0200, Thomas Monjalon wrote: > > 2016-10-18 21:06, Yuanhan Liu: > > > On Tue, Oct 18, 2016 at 02:50:16PM +0200, Jan Blunck wrote: > > > > >From my understanding this is a massive API breakage. This forces all > > > > existing users of the virtual PMDs to change with zero benefit. Even > > > > if that isn't enough it also makes it impossible to switch between > > > > releases by recompiling. > > > > > > > > Can we please revert these changes and work on some aliasing support > > > > for the PMDs to fix it long term? > > > > > > +1. Aliasing is also something I would suggest before making such renames. > > > > It is a brutal change, yes. > > It was announced in 16.07 release notes though. > > Yes, but it still took me a while (by running git bisect) to figure out > what went wrong: I wasn't aware of such note, that I was thinking maybe > something is broken. > > Later I also got quite few same complains. It may also took them a while > to know what's happened. > > Anyway, my point is, for this kind of change, we should have added the > alias support firstly. Yes. > If that's been done, then the announcement is not > needed at all? The announcement would be needed to remove the aliases, later. > > We can try to make this change more progressive by keeping old names > > as aliases for some time. > > Is there a volunteer to work on vdev names aliases, > > with the target of integrating them in RC2 or RC3?
[dpdk-dev] [PATCH] drivers: make driver names consistent
2016-10-18 17:26, Jan Blunck: > On Tue, Oct 18, 2016 at 3:42 PM, Thomas Monjalon > wrote: > > 2016-10-18 21:06, Yuanhan Liu: > >> On Tue, Oct 18, 2016 at 02:50:16PM +0200, Jan Blunck wrote: > >> > >From my understanding this is a massive API breakage. This forces all > >> > existing users of the virtual PMDs to change with zero benefit. Even > >> > if that isn't enough it also makes it impossible to switch between > >> > releases by recompiling. > >> > > >> > Can we please revert these changes and work on some aliasing support > >> > for the PMDs to fix it long term? > >> > >> +1. Aliasing is also something I would suggest before making such renames. > > > > It is a brutal change, yes. > > It was announced in 16.07 release notes though. > > > > "But the plans were on display ..." (HHGTTG) > > > We can try to make this change more progressive by keeping old names > > as aliases for some time. > > Is there a volunteer to work on vdev names aliases, > > with the target of integrating them in RC2 or RC3? > > > > I'll give it a try ... Thanks Jan
[dpdk-dev] [PATCH] drivers: make driver names consistent
On Tue, Oct 18, 2016 at 3:42 PM, Thomas Monjalon wrote: > 2016-10-18 21:06, Yuanhan Liu: >> On Tue, Oct 18, 2016 at 02:50:16PM +0200, Jan Blunck wrote: >> > >From my understanding this is a massive API breakage. This forces all >> > existing users of the virtual PMDs to change with zero benefit. Even >> > if that isn't enough it also makes it impossible to switch between >> > releases by recompiling. >> > >> > Can we please revert these changes and work on some aliasing support >> > for the PMDs to fix it long term? >> >> +1. Aliasing is also something I would suggest before making such renames. > > It is a brutal change, yes. > It was announced in 16.07 release notes though. > "But the plans were on display ..." (HHGTTG) > We can try to make this change more progressive by keeping old names > as aliases for some time. > Is there a volunteer to work on vdev names aliases, > with the target of integrating them in RC2 or RC3? > I'll give it a try ...
[dpdk-dev] [PATCH] drivers: make driver names consistent
2016-10-18 21:06, Yuanhan Liu: > On Tue, Oct 18, 2016 at 02:50:16PM +0200, Jan Blunck wrote: > > >From my understanding this is a massive API breakage. This forces all > > existing users of the virtual PMDs to change with zero benefit. Even > > if that isn't enough it also makes it impossible to switch between > > releases by recompiling. > > > > Can we please revert these changes and work on some aliasing support > > for the PMDs to fix it long term? > > +1. Aliasing is also something I would suggest before making such renames. It is a brutal change, yes. It was announced in 16.07 release notes though. We can try to make this change more progressive by keeping old names as aliases for some time. Is there a volunteer to work on vdev names aliases, with the target of integrating them in RC2 or RC3?
[dpdk-dev] [PATCH] drivers: make driver names consistent
>From my understanding this is a massive API breakage. This forces all existing users of the virtual PMDs to change with zero benefit. Even if that isn't enough it also makes it impossible to switch between releases by recompiling. Can we please revert these changes and work on some aliasing support for the PMDs to fix it long term? Thanks, Jan On Fri, Sep 16, 2016 at 11:58 AM, Thomas Monjalon wrote: > 2016-08-24 22:37, Mcnamara, John: >> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Pablo de Lara >> > >> > ... >> > >> > -$RTE_TARGET/app/testpmd -c '0xf' -n 4 --vdev >> > 'eth_pcap0,rx_pcap=/path/to/ file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' >> > -- --port-topology=chained >> > +$RTE_TARGET/app/testpmd -c '0xf' -n 4 --vdev >> > 'net_pcap0,rx_pcap=/path/to/ file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' >> > -- --port-topology=chained >> >> >> I know that this is an existing issue but there shouldn't be a space in >> "/path/to/ file". Perhaps you could fix that (in a number of places) as part >> of this patch. You could probably leave out the "/path/to/" part altogether >> as >> it may be clearer, see below. >> >> Also, could you wrap the long code lines in the sections that you change at >> 80 chars using "\" to keep them on the page in the PDF docs, like: >> >> $RTE_TARGET/app/testpmd -c '0xf' -n 4 \ >> --vdev >> 'net_pcap0,rx_pcap=/path/to/file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' \ >> -- --port-topology=chained >> >> Or without the path part: >> >> $RTE_TARGET/app/testpmd -c '0xf' -n 4 \ >> --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ >> -- --port-topology=chained > > Applied with above comments fixed and release notes updated, thanks.
[dpdk-dev] [PATCH] drivers: make driver names consistent
2016-08-24 22:37, Mcnamara, John: > From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Pablo de Lara > > > > ... > > > > -$RTE_TARGET/app/testpmd -c '0xf' -n 4 --vdev > > 'eth_pcap0,rx_pcap=/path/to/ file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' -- > > --port-topology=chained > > +$RTE_TARGET/app/testpmd -c '0xf' -n 4 --vdev > > 'net_pcap0,rx_pcap=/path/to/ file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' -- > > --port-topology=chained > > > I know that this is an existing issue but there shouldn't be a space in > "/path/to/ file". Perhaps you could fix that (in a number of places) as part > of this patch. You could probably leave out the "/path/to/" part altogether > as > it may be clearer, see below. > > Also, could you wrap the long code lines in the sections that you change at > 80 chars using "\" to keep them on the page in the PDF docs, like: > > $RTE_TARGET/app/testpmd -c '0xf' -n 4 \ > --vdev > 'net_pcap0,rx_pcap=/path/to/file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' \ > -- --port-topology=chained > > Or without the path part: > > $RTE_TARGET/app/testpmd -c '0xf' -n 4 \ > --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ > -- --port-topology=chained Applied with above comments fixed and release notes updated, thanks.
[dpdk-dev] [PATCH] drivers: make driver names consistent
As discussed in the past release, driver names are modified to be more consistent, and the future driver should follow this new convention. Driver names consist of: "driver category"_"driver folder name"_"optional extra name". For example: - Crypto null driver -> "crypto_null" - Network IXGBE VF driver -> "net_ixgbe_vf" Signed-off-by: Pablo de Lara --- app/pdump/main.c | 4 ++-- doc/guides/cryptodevs/aesni_gcm.rst | 6 +++--- doc/guides/cryptodevs/aesni_mb.rst| 6 +++--- doc/guides/cryptodevs/kasumi.rst | 6 +++--- doc/guides/cryptodevs/null.rst| 6 +++--- doc/guides/cryptodevs/snow3g.rst | 6 +++--- doc/guides/nics/pcap_ring.rst | 26 +- doc/guides/nics/vhost.rst | 2 +- doc/guides/xen/pkt_switch.rst | 10 +- drivers/net/af_packet/rte_eth_af_packet.c | 4 ++-- drivers/net/bnx2x/bnx2x_ethdev.c | 8 drivers/net/bnxt/bnxt_ethdev.c| 4 ++-- drivers/net/bonding/rte_eth_bond_pmd.c| 4 ++-- drivers/net/cxgbe/cxgbe_ethdev.c | 4 ++-- drivers/net/e1000/em_ethdev.c | 4 ++-- drivers/net/e1000/igb_ethdev.c| 8 drivers/net/ena/ena_ethdev.c | 4 ++-- drivers/net/enic/enic_ethdev.c| 4 ++-- drivers/net/fm10k/fm10k_ethdev.c | 4 ++-- drivers/net/i40e/i40e_ethdev.c| 4 ++-- drivers/net/i40e/i40e_ethdev_vf.c | 4 ++-- drivers/net/ixgbe/ixgbe_ethdev.c | 8 drivers/net/mlx4/mlx4.c | 4 ++-- drivers/net/mlx5/mlx5.c | 4 ++-- drivers/net/mpipe/mpipe_tilegx.c | 4 ++-- drivers/net/nfp/nfp_net.c | 4 ++-- drivers/net/null/rte_eth_null.c | 4 ++-- drivers/net/pcap/rte_eth_pcap.c | 4 ++-- drivers/net/qede/qede_ethdev.c| 8 drivers/net/ring/rte_eth_ring.c | 4 ++-- drivers/net/szedata2/rte_eth_szedata2.c | 2 +- drivers/net/thunderx/nicvf_ethdev.c | 4 ++-- drivers/net/vhost/rte_eth_vhost.c | 4 ++-- drivers/net/virtio/virtio_ethdev.c| 4 ++-- drivers/net/virtio/virtio_user_ethdev.c | 4 ++-- drivers/net/vmxnet3/vmxnet3_ethdev.c | 4 ++-- drivers/net/xenvirt/rte_eth_xenvirt.c | 4 ++-- lib/librte_cryptodev/rte_cryptodev.h | 12 ++-- 38 files changed, 105 insertions(+), 105 deletions(-) diff --git a/app/pdump/main.c b/app/pdump/main.c index b76cfd0..f3ef181 100644 --- a/app/pdump/main.c +++ b/app/pdump/main.c @@ -68,8 +68,8 @@ #define CMD_LINE_OPT_SER_SOCK_PATH "server-socket-path" #define CMD_LINE_OPT_CLI_SOCK_PATH "client-socket-path" -#define VDEV_PCAP "eth_pcap_%s_%d,tx_pcap=%s" -#define VDEV_IFACE "eth_pcap_%s_%d,tx_iface=%s" +#define VDEV_PCAP "net_pcap_%s_%d,tx_pcap=%s" +#define VDEV_IFACE "net_pcap_%s_%d,tx_iface=%s" #define TX_STREAM_SIZE 64 #define MP_NAME "pdump_pool_%d" diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst index 7ff1c6b..04bf43c 100644 --- a/doc/guides/cryptodevs/aesni_gcm.rst +++ b/doc/guides/cryptodevs/aesni_gcm.rst @@ -64,9 +64,9 @@ In order to enable this virtual crypto PMD, user must: To use the PMD in an application, user must: -* Call rte_eal_vdev_init("cryptodev_aesni_gcm_pmd") within the application. +* Call rte_eal_vdev_init("crypto_aesni_gcm") within the application. -* Use --vdev="cryptodev_aesni_gcm_pmd" in the EAL options, which will call rte_eal_vdev_init() internally. +* Use --vdev="crypto_aesni_gcm" in the EAL options, which will call rte_eal_vdev_init() internally. The following parameters (all optional) can be provided in the previous two calls: @@ -81,7 +81,7 @@ Example: .. code-block:: console -./l2fwd-crypto -c 40 -n 4 --vdev="cryptodev_aesni_gcm_pmd,socket_id=1,max_nb_sessions=128" +./l2fwd-crypto -c 40 -n 4 --vdev="crypto_aesni_gcm,socket_id=1,max_nb_sessions=128" Limitations --- diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst index 60a8914..a827751 100644 --- a/doc/guides/cryptodevs/aesni_mb.rst +++ b/doc/guides/cryptodevs/aesni_mb.rst @@ -96,9 +96,9 @@ In order to enable this virtual crypto PMD, user must: To use the PMD in an application, user must: -* Call rte_eal_vdev_init("cryptodev_aesni_mb_pmd") within the application. +* Call rte_eal_vdev_init("crypto_aesni_mb") within the application. -* Use --vdev="cryptodev_aesni_mb_pmd" in the EAL options, which will call rte_eal_vdev_init() internally. +* Use --vdev="crypto_aesni_mb" in the EAL options, which will call rte_eal_vdev_init() internally. The following parameters (all optional) can be provided in the previous two calls: @@ -113,4 +113,4 @@ Example: .. code-block:: console -./l2fwd-crypto -c 40 -n 4 --vdev="cryptodev_aesni_mb_pmd,socket_id=1,max_nb_sessions=128" +./l2fwd-crypto -c 40 -n 4
[dpdk-dev] [PATCH] drivers: make driver names consistent
> -Original Message- > From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Pablo de Lara > Sent: Wednesday, August 24, 2016 11:25 PM > To: dev at dpdk.org > Cc: De Lara Guarch, Pablo > Subject: [dpdk-dev] [PATCH] drivers: make driver names consistent > > ... > > -$RTE_TARGET/app/testpmd -c '0xf' -n 4 --vdev > 'eth_pcap0,rx_pcap=/path/to/ file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' -- > --port-topology=chained > +$RTE_TARGET/app/testpmd -c '0xf' -n 4 --vdev > 'net_pcap0,rx_pcap=/path/to/ file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' -- > --port-topology=chained I know that this is an existing issue but there shouldn't be a space in "/path/to/ file". Perhaps you could fix that (in a number of places) as part of this patch. You could probably leave out the "/path/to/" part altogether as it may be clearer, see below. Also, could you wrap the long code lines in the sections that you change at 80 chars using "\" to keep them on the page in the PDF docs, like: $RTE_TARGET/app/testpmd -c '0xf' -n 4 \ --vdev 'net_pcap0,rx_pcap=/path/to/file_rx.pcap,tx_pcap=/path/to/file_tx.pcap' \ -- --port-topology=chained Or without the path part: $RTE_TARGET/app/testpmd -c '0xf' -n 4 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ -- --port-topology=chained John
[dpdk-dev] [PATCH] drivers: make driver names consistent
> -Original Message- > From: De Lara Guarch, Pablo > Sent: Wednesday, August 24, 2016 3:25 PM > To: dev at dpdk.org > Cc: De Lara Guarch, Pablo > Subject: [PATCH] drivers: make driver names consistent > > As discussed in the past release, driver names are modified > to be more consistent, and the future driver should follow > this new convention. > > Driver names consist of: > "driver category"_"driver folder name"_"optional extra name". > > For example: > - Crypto null driver -> "crypto_null" > - Network IXGBE VF driver -> "net_ixgbe_vf" > > Signed-off-by: Pablo de Lara Some people asked to use "/" instead of "_", but there were compilation issues, so I had to use "_".