net/mlx5: disable ConnectX-4 Lx Multi Packet Send by default

Message ID 20180813070018.101262-1-shahafs@mellanox.com (mailing list archive)
State Superseded, archived
Headers
Series net/mlx5: disable ConnectX-4 Lx Multi Packet Send by default |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Shahaf Shuler Aug. 13, 2018, 7 a.m. UTC
  On ConnectX-4 Lx the Multi Packet Send (MPW) feature is considered
un-secure, as on some cases were the application provides incorrect mbufs
on the Tx burst the host or NIC can get stuck.

Hence, disabling the feature by default for this specific NIC.
Users can still enable this feature and enjoy the performance gain
(mostly for low number of cores) by using the txq_mpw_en devarg.

This patch will impact the out of the box performance of some application
using ConnectX-4 Lx for the sack of security and robustness.

Cc: stable@dpdk.org

Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
---
 doc/guides/nics/mlx5.rst       | 7 ++++++-
 drivers/net/mlx5/mlx5.c        | 9 +++++++--
 drivers/net/mlx5/mlx5_ethdev.c | 5 +++--
 drivers/net/mlx5/mlx5_prm.h    | 3 ++-
 4 files changed, 18 insertions(+), 6 deletions(-)
  

Comments

Yongseok Koh Aug. 14, 2018, 4:32 p.m. UTC | #1
On Mon, Aug 13, 2018 at 10:00:18AM +0300, Shahaf Shuler wrote:
> On ConnectX-4 Lx the Multi Packet Send (MPW) feature is considered
> un-secure, as on some cases were the application provides incorrect mbufs
> on the Tx burst the host or NIC can get stuck.
> 
> Hence, disabling the feature by default for this specific NIC.
> Users can still enable this feature and enjoy the performance gain
> (mostly for low number of cores) by using the txq_mpw_en devarg.
> 
> This patch will impact the out of the box performance of some application
> using ConnectX-4 Lx for the sack of security and robustness.
> 
> Cc: stable@dpdk.org
> 
> Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
> ---
>  doc/guides/nics/mlx5.rst       | 7 ++++++-
>  drivers/net/mlx5/mlx5.c        | 9 +++++++--
>  drivers/net/mlx5/mlx5_ethdev.c | 5 +++--
>  drivers/net/mlx5/mlx5_prm.h    | 3 ++-
>  4 files changed, 18 insertions(+), 6 deletions(-)
> 
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
> index 52e1213cf5..dbdb90b59b 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -339,7 +339,12 @@ Run-time configuration
>    When those offloads are requested the MPS send function will not be used.
>  
>    It is currently only supported on the ConnectX-4 Lx, ConnectX-5 and Bluefield
> -  families of adapters. Enabled by default.
> +  families of adapters.
> +  On ConnectX-4 Lx the MPW is considered un-secure hence disabled by default.
> +  Users which enable the MPW should be aware that application which provides incorrect
> +  mbuf descriptors in the Tx burst can lead to serious errors in the host including, on some cases,
> +  NIC to get stuck.
> +  On ConnectX-5 and Bluefield the MPW is secure and enabled by default.
>  
>  - ``txq_mpw_hdr_dseg_en`` parameter [int]
>  
> diff --git a/drivers/net/mlx5/mlx5.c b/drivers/net/mlx5/mlx5.c
> index ec63bc6e22..2e8f906f35 100644
> --- a/drivers/net/mlx5/mlx5.c
> +++ b/drivers/net/mlx5/mlx5.c
> @@ -477,7 +477,11 @@ mlx5_args_check(const char *key, const char *val, void *opaque)
>  	} else if (strcmp(MLX5_TXQS_MIN_INLINE, key) == 0) {
>  		config->txqs_inline = tmp;
>  	} else if (strcmp(MLX5_TXQ_MPW_EN, key) == 0) {
> -		config->mps = !!tmp ? config->mps : 0;
> +		tmp = !!tmp;
> +		if (tmp && config->mps == MLX5_MPW)
> +			config->mps = MLX5_MPW_USER_FORCED;
> +		else
> +			config->mps = tmp ? config->mps : 0;
>  	} else if (strcmp(MLX5_TXQ_MPW_HDR_DSEG_EN, key) == 0) {
>  		config->mpw_hdr_dseg = !!tmp;
>  	} else if (strcmp(MLX5_TXQ_MAX_INLINE_LEN, key) == 0) {
> @@ -1044,7 +1048,8 @@ mlx5_dev_spawn(struct rte_device *dpdk_dev,
>  	}
>  	DRV_LOG(INFO, "%sMPS is %s",
>  		config.mps == MLX5_MPW_ENHANCED ? "enhanced " : "",
> -		config.mps != MLX5_MPW_DISABLED ? "enabled" : "disabled");
> +		(config.mps != MLX5_MPW_DISABLED && config.mps != MLX5_MPW) ?
> +		"enabled" : "disabled");
>  	if (config.cqe_comp && !cqe_comp) {
>  		DRV_LOG(WARNING, "Rx CQE compression isn't supported");
>  		config.cqe_comp = 0;
> diff --git a/drivers/net/mlx5/mlx5_ethdev.c b/drivers/net/mlx5/mlx5_ethdev.c
> index 34c5b95ee6..48917b0f6b 100644
> --- a/drivers/net/mlx5/mlx5_ethdev.c
> +++ b/drivers/net/mlx5/mlx5_ethdev.c
> @@ -1224,11 +1224,12 @@ mlx5_select_tx_function(struct rte_eth_dev *dev)
>  				"port %u selected enhanced MPW Tx function",
>  				dev->data->port_id);
>  		}
> -	} else if (config->mps && (config->txq_inline > 0)) {
> +	} else if (config->mps == MLX5_MPW_USER_FORCED &&
> +		   (config->txq_inline > 0)) {
>  		tx_pkt_burst = mlx5_tx_burst_mpw_inline;
>  		DRV_LOG(DEBUG, "port %u selected MPW inline Tx function",
>  			dev->data->port_id);
> -	} else if (config->mps) {
> +	} else if (config->mps == MLX5_MPW_USER_FORCED) {
>  		tx_pkt_burst = mlx5_tx_burst_mpw;
>  		DRV_LOG(DEBUG, "port %u selected MPW Tx function",
>  			dev->data->port_id);
> diff --git a/drivers/net/mlx5/mlx5_prm.h b/drivers/net/mlx5/mlx5_prm.h
> index 0870d32fdb..b64cd45eee 100644
> --- a/drivers/net/mlx5/mlx5_prm.h
> +++ b/drivers/net/mlx5/mlx5_prm.h
> @@ -197,7 +197,8 @@ struct mlx5_wqe64 {
>  /* MPW mode. */
>  enum mlx5_mpw_mode {
>  	MLX5_MPW_DISABLED,
> -	MLX5_MPW,
> +	MLX5_MPW, /* MPW is supported by the device. */
> +	MLX5_MPW_USER_FORCED, /* MPW is supported and selected by the user. */
>  	MLX5_MPW_ENHANCED, /* Enhanced Multi-Packet Send WQE, a.k.a MPWv2. */
>  };

Any specific reason to save device capability in this case? Currently, all the
configurations made by PMD parameters are static in mlx5. We don't have an API
to change it in runtime. E.g., once MPRQ is disabled (by default), there's no
way to enable it even though HW supports it but to restart the app. How about
making it aligned with behavior of MPRQ (and others)?

Thanks,
Yongseok.
  

Patch

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 52e1213cf5..dbdb90b59b 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -339,7 +339,12 @@  Run-time configuration
   When those offloads are requested the MPS send function will not be used.
 
   It is currently only supported on the ConnectX-4 Lx, ConnectX-5 and Bluefield
-  families of adapters. Enabled by default.
+  families of adapters.
+  On ConnectX-4 Lx the MPW is considered un-secure hence disabled by default.
+  Users which enable the MPW should be aware that application which provides incorrect
+  mbuf descriptors in the Tx burst can lead to serious errors in the host including, on some cases,
+  NIC to get stuck.
+  On ConnectX-5 and Bluefield the MPW is secure and enabled by default.
 
 - ``txq_mpw_hdr_dseg_en`` parameter [int]
 
diff --git a/drivers/net/mlx5/mlx5.c b/drivers/net/mlx5/mlx5.c
index ec63bc6e22..2e8f906f35 100644
--- a/drivers/net/mlx5/mlx5.c
+++ b/drivers/net/mlx5/mlx5.c
@@ -477,7 +477,11 @@  mlx5_args_check(const char *key, const char *val, void *opaque)
 	} else if (strcmp(MLX5_TXQS_MIN_INLINE, key) == 0) {
 		config->txqs_inline = tmp;
 	} else if (strcmp(MLX5_TXQ_MPW_EN, key) == 0) {
-		config->mps = !!tmp ? config->mps : 0;
+		tmp = !!tmp;
+		if (tmp && config->mps == MLX5_MPW)
+			config->mps = MLX5_MPW_USER_FORCED;
+		else
+			config->mps = tmp ? config->mps : 0;
 	} else if (strcmp(MLX5_TXQ_MPW_HDR_DSEG_EN, key) == 0) {
 		config->mpw_hdr_dseg = !!tmp;
 	} else if (strcmp(MLX5_TXQ_MAX_INLINE_LEN, key) == 0) {
@@ -1044,7 +1048,8 @@  mlx5_dev_spawn(struct rte_device *dpdk_dev,
 	}
 	DRV_LOG(INFO, "%sMPS is %s",
 		config.mps == MLX5_MPW_ENHANCED ? "enhanced " : "",
-		config.mps != MLX5_MPW_DISABLED ? "enabled" : "disabled");
+		(config.mps != MLX5_MPW_DISABLED && config.mps != MLX5_MPW) ?
+		"enabled" : "disabled");
 	if (config.cqe_comp && !cqe_comp) {
 		DRV_LOG(WARNING, "Rx CQE compression isn't supported");
 		config.cqe_comp = 0;
diff --git a/drivers/net/mlx5/mlx5_ethdev.c b/drivers/net/mlx5/mlx5_ethdev.c
index 34c5b95ee6..48917b0f6b 100644
--- a/drivers/net/mlx5/mlx5_ethdev.c
+++ b/drivers/net/mlx5/mlx5_ethdev.c
@@ -1224,11 +1224,12 @@  mlx5_select_tx_function(struct rte_eth_dev *dev)
 				"port %u selected enhanced MPW Tx function",
 				dev->data->port_id);
 		}
-	} else if (config->mps && (config->txq_inline > 0)) {
+	} else if (config->mps == MLX5_MPW_USER_FORCED &&
+		   (config->txq_inline > 0)) {
 		tx_pkt_burst = mlx5_tx_burst_mpw_inline;
 		DRV_LOG(DEBUG, "port %u selected MPW inline Tx function",
 			dev->data->port_id);
-	} else if (config->mps) {
+	} else if (config->mps == MLX5_MPW_USER_FORCED) {
 		tx_pkt_burst = mlx5_tx_burst_mpw;
 		DRV_LOG(DEBUG, "port %u selected MPW Tx function",
 			dev->data->port_id);
diff --git a/drivers/net/mlx5/mlx5_prm.h b/drivers/net/mlx5/mlx5_prm.h
index 0870d32fdb..b64cd45eee 100644
--- a/drivers/net/mlx5/mlx5_prm.h
+++ b/drivers/net/mlx5/mlx5_prm.h
@@ -197,7 +197,8 @@  struct mlx5_wqe64 {
 /* MPW mode. */
 enum mlx5_mpw_mode {
 	MLX5_MPW_DISABLED,
-	MLX5_MPW,
+	MLX5_MPW, /* MPW is supported by the device. */
+	MLX5_MPW_USER_FORCED, /* MPW is supported and selected by the user. */
 	MLX5_MPW_ENHANCED, /* Enhanced Multi-Packet Send WQE, a.k.a MPWv2. */
 };