net/mlx5e: Return in default case statement in tx_post_resync_params
Subsystems (5)
PATCH 1/1 net/mlx5e: Return in default case statement in tx_post_resync_params
clang warns:
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:251:2:
warning: variable 'rec_seq_sz' is used uninitialized whenever switch default is taken [-Wsometimes-uninitialized]
default:
^~~~~~~
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:255:46: note:
uninitialized use occurs here
skip_static_post = !memcmp(rec_seq, &rn_be, rec_seq_sz);
^~~~~~~~~~
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:239:16: note:
initialize the variable 'rec_seq_sz' to silence this warning
u16 rec_seq_sz;
^
= 01 warning generated.
This case statement was clearly designed to be one that should not be hit during runtime because of the WARN_ON statement so just return early to prevent copying uninitialized memory up into rn_be.
--- drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c | 1 + 1 file changed, 1 insertion(+)
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c +1 -0
@@ -250,6 +250,7 @@ tx_post_resync_params(struct mlx5e_txqsq *sq, }default :WARN_ON (1 ); +return ; } skip_static_post = !memcmp (rec_seq, &rn_be, rec_seq_sz);
Signature · 1 line
2.22.0
Quoted 35 lines · Nathan Chancellor
clang warns:
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:251:2:
warning: variable 'rec_seq_sz' is used uninitialized whenever switch default is taken [-Wsometimes-uninitialized]default: ^~~~~~~ drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:255:46: note: uninitialized use occurs here skip_static_post = !memcmp(rec_seq, &rn_be, rec_seq_sz); ^~~~~~~~~~ drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:239:16: note: initialize the variable 'rec_seq_sz' to silence this warning u16 rec_seq_sz; ^ = 01 warning generated.
This case statement was clearly designed to be one that should not be hit during runtime because of the
WARN_ONstatement so just return early to prevent copying uninitialized memory up intorn_be.Fixes d2ead1f360e8 ("net/mlx5e: Add kTLS TX HW offload support")Signed-off-by Nathan Chancellor <[email protected]>--- drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c | 1 + 1 file changed, 1 insertion(+)drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c +0
-0
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c tx_post_resync_params(struct mlx5e_txqsq *sq, · line 254
Quoted 5 lines
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c +1
-0@@ -250,6 +250,7 @@ tx_post_resync_params(struct mlx5e_txqsq *sq, }default :WARN_ON (1 ); +return ; }
hmm...a switch statement with a single case is a code smell. How about a single conditional with early return? Then the "meat" of the happy path doesn't need an additional level of indentation.
Signature · 2 lines
Thanks, ~Nick Desaulniers
Quoted 32 lines · Nick Desaulniers
Quoted 30 lines · Nathan Chancellor
clang warns:
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:251:2:
warning: variable 'rec_seq_sz' is used uninitialized whenever switch default is taken [-Wsometimes-uninitialized]default: ^~~~~~~ drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:255:46: note: uninitialized use occurs here skip_static_post = !memcmp(rec_seq, &rn_be, rec_seq_sz); ^~~~~~~~~~ drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:239:16: note: initialize the variable 'rec_seq_sz' to silence this warning u16 rec_seq_sz; ^ = 01 warning generated.
This case statement was clearly designed to be one that should not be hit during runtime because of the
WARN_ONstatement so just return early to prevent copying uninitialized memory up intorn_be.Fixes d2ead1f360e8 ("net/mlx5e: Add kTLS TX HW offload support")Signed-off-by Nathan Chancellor <[email protected]>--- drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c | 1 + 1 file changed, 1 insertion(+)
Quoted 17 lines
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c tx_post_resync_params(struct mlx5e_txqsq *sq, · line 254
Quoted 10 lines
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c +1
-0@@ -250,6 +250,7 @@ tx_post_resync_params(struct mlx5e_txqsq *sq, }default :WARN_ON (1 ); +return ; }hmm...a switch statement with a single case is a code smell. How about a single conditional with early return? Then the "meat" of the happy path doesn't need an additional level of indentation.
Signature · 2 lines
Thanks, ~Nick Desaulniers
I assume that the reason for this is there may be other cipher types added in the future? I suppose the maintainers can give more clarity to that.
Furthermore, if they want the switch statements to remain, it looks like fill_static_params_ctx also returns in the default statement so it seems like this is the right fix.
Cheers,
Nathan
Quoted 51 lines · Nathan Chancellor
Quoted 41 lines · Nick Desaulniers
Quoted 39 lines · Nathan Chancellor
clang warns:
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:251:2:
warning: variable 'rec_seq_sz' is used uninitialized whenever switch default is taken [-Wsometimes-uninitialized]default: ^~~~~~~ drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:255:46: note: uninitialized use occurs here skip_static_post = !memcmp(rec_seq, &rn_be, rec_seq_sz); ^~~~~~~~~~ drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:239:16: note: initialize the variable 'rec_seq_sz' to silence this warning u16 rec_seq_sz; ^ = 01 warning generated.
This case statement was clearly designed to be one that should not be hit during runtime because of the
WARN_ONstatement so just return early to prevent copying uninitialized memory up intorn_be.Fixes d2ead1f360e8 ("net/mlx5e: Add kTLS TX HW offload support")Signed-off-by Nathan Chancellor <[email protected]>--- drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c | 1 + 1 file changed, 1 insertion(+)drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c +1
-0@@ -250,6 +250,7 @@ tx_post_resync_params(struct mlx5e_txqsq *sq, }default :WARN_ON (1 ); +return ;Quoted 8 lines
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c tx_post_resync_params(struct mlx5e_txqsq *sq, · line 254
Quoted 1 line
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c +0
-0}hmm...a switch statement with a single case is a code smell. How about a single conditional with early return? Then the "meat" of the happy path doesn't need an additional level of indentation. --
Thanks,
~Nick Desaulniers
Quoted 3 lines
I assume that the reason for this is there may be other cipher types added in the future? I suppose the maintainers can give more clarity to that.
Our devices supports extra ciphers, for example TLS_CIPHER_AES_GCM_256. So I assume this was the reason for switch<->case, but because such implementation doesn't exist in any driver, I recommend to rewrite the code to have "if" statement and return early.
Quoted 7 lines
Furthermore, if they want the switch statements to remain, it looks like
fill_static_params_ctxalso returns in the default statement so it seems like this is the right fix.Cheers,
Nathan
PATCH v2 1/1 net/mlx5e: Refactor switch statements to avoid using uninitialized variables
In reply to Nathan Chancellorclang warns:
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:251:2:
warning: variable 'rec_seq_sz' is used uninitialized whenever switch default is taken [-Wsometimes-uninitialized]
default:
^~~~~~~
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:255:46: note:
uninitialized use occurs here
skip_static_post = !memcmp(rec_seq, &rn_be, rec_seq_sz);
^~~~~~~~~~
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:239:16: note:
initialize the variable 'rec_seq_sz' to silence this warning
u16 rec_seq_sz;
^
= 01 warning generated.
The default case statement should return in tx_post_resync_params like in fill_static_params_ctx. However, as Nick and Leon point out, the switch statements converted into if statements to clean up the code a bit since there is only one cipher supported. Do that to clear up the code.
---
v1 -> v2:
* Refactor switch statements into if statements
.../mellanox/mlx5/core/en_accel/ktls_tx.c | 33 +++++++------------ 1 file changed, 11 insertions(+), 22 deletions(-)
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c +11 -22
@@ -25,23 +25,17 @@ static void fill_static_params_ctx(void *ctx, struct mlx5e_ktls_offload_context_tx *priv_tx) {struct tls_crypto_info *crypto_info = priv_tx->crypto_info; +struct tls12_crypto_info_aes_gcm_128 *info;char *initial_rn, *gcm_iv;u16 salt_sz, rec_seq_sz;char *salt, *rec_seq;u8 tls_version; -switch (crypto_info->cipher_type) { -case TLS_CIPHER_AES_GCM_128 : { -struct tls12_crypto_info_aes_gcm_128 *info = - (struct tls12_crypto_info_aes_gcm_128 *)crypto_info; - -EXTRACT_INFO_FIELDS ; -break ; - } -default : -WARN_ON (1 ); +if (WARN_ON (crypto_info->cipher_type !=TLS_CIPHER_AES_GCM_128 ))return ; - } + + info = (struct tls12_crypto_info_aes_gcm_128 *)crypto_info; +EXTRACT_INFO_FIELDS ; gcm_iv =MLX5_ADDR_OF (tls_static_params, ctx, gcm_iv); initial_rn =MLX5_ADDR_OF (tls_static_params, ctx, initial_record_number);
@@ -234,23 +228,18 @@ tx_post_resync_params(struct mlx5e_txqsq *sq, u64 rcd_sn) {struct tls_crypto_info *crypto_info = priv_tx->crypto_info; +struct tls12_crypto_info_aes_gcm_128 *info;__be64 rn_be =cpu_to_be64 (rcd_sn);bool skip_static_post;u16 rec_seq_sz;char *rec_seq; -switch (crypto_info->cipher_type) { -case TLS_CIPHER_AES_GCM_128 : { -struct tls12_crypto_info_aes_gcm_128 *info = - (struct tls12_crypto_info_aes_gcm_128 *)crypto_info; +if (WARN_ON (crypto_info->cipher_type !=TLS_CIPHER_AES_GCM_128 )) +return ; - rec_seq = info->rec_seq; - rec_seq_sz =sizeof (info->rec_seq); -break ; - } -default : -WARN_ON (1 ); - } + info = (struct tls12_crypto_info_aes_gcm_128 *)crypto_info; + rec_seq = info->rec_seq; + rec_seq_sz =sizeof (info->rec_seq); skip_static_post = !memcmp (rec_seq, &rn_be, rec_seq_sz);if (!skip_static_post)
Signature · 1 line
2.22.0
Re: [PATCH v2] net/mlx5e: Refactor switch statements to avoid using uninitialized variables
Quoted 29 lines · Nathan Chancellor
clang warns:
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:251:2:
warning: variable 'rec_seq_sz' is used uninitialized whenever switch default is taken [-Wsometimes-uninitialized]default: ^~~~~~~ drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:255:46: note: uninitialized use occurs here skip_static_post = !memcmp(rec_seq, &rn_be, rec_seq_sz); ^~~~~~~~~~ drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c:239:16: note: initialize the variable 'rec_seq_sz' to silence this warning u16 rec_seq_sz; ^ = 01 warning generated.
The default case statement should return in
tx_post_resync_paramslike infill_static_params_ctx. However, as Nick and Leon point out, the switch statements converted into if statements to clean up the code a bit since there is only one cipher supported. Do that to clear up the code.Fixes d2ead1f360e8 ("net/mlx5e: Add kTLS TX HW offload support")Suggested-by Leon Romanovsky <[email protected]>Suggested-by Nick Desaulniers <[email protected]>Signed-off-by Nathan Chancellor <[email protected]>
Quoted 9 lines
---
v1 -> v2:
* Refactor switch statements into if statements
.../mellanox/mlx5/core/en_accel/ktls_tx.c | 33 +++++++------------ 1 file changed, 11 insertions(+), 22 deletions(-)
Thanks,
David Miller
maintainerRe: [PATCH v2] net/mlx5e: Refactor switch statements to avoid using uninitialized variables
In reply to Nathan ChancellorI applied your simpler addition of the return statement so that I could get the net-next pull request out tonight, just FYI...
Re: [PATCH v2] net/mlx5e: Refactor switch statements to avoid using uninitialized variables
Quoted 3 lines · David Miller
I applied your simpler addition of the return statement so that I could get the net-next pull request out tonight, just FYI...
Thanks for the heads up, I'll spin up a v3 just focusing on the refactoring.
Cheers,
Nathan
PATCH v3 1/1 net/mlx5e: Convert single case statement switch statements into if statements
In reply to Nathan ChancellorDuring the review of commit 1ff2f0fa450e ("net/mlx5e: Return in default case statement in tx_post_resync_params"), Leon and Nick pointed out that the switch statements can be converted to single if statements that return early so that the code is easier to follow.
---
v1 -> v2:
* Refactor switch statements into if statements
v2 -> v3:
* Rebase on net-next after v1 was already applied, patch just refactors switch statements to if statements.
.../mellanox/mlx5/core/en_accel/ktls_tx.c | 34 ++++++------------- 1 file changed, 11 insertions(+), 23 deletions(-)
drivers/net/ethernet/mellanox/mlx5/core/en_accel/ktls_tx.c +11 -23
@@ -25,23 +25,17 @@ static void fill_static_params_ctx(void *ctx, struct mlx5e_ktls_offload_context_tx *priv_tx) {struct tls_crypto_info *crypto_info = priv_tx->crypto_info; +struct tls12_crypto_info_aes_gcm_128 *info;char *initial_rn, *gcm_iv;u16 salt_sz, rec_seq_sz;char *salt, *rec_seq;u8 tls_version; -switch (crypto_info->cipher_type) { -case TLS_CIPHER_AES_GCM_128 : { -struct tls12_crypto_info_aes_gcm_128 *info = - (struct tls12_crypto_info_aes_gcm_128 *)crypto_info; - -EXTRACT_INFO_FIELDS ; -break ; - } -default : -WARN_ON (1 ); +if (WARN_ON (crypto_info->cipher_type !=TLS_CIPHER_AES_GCM_128 ))return ; - } + + info = (struct tls12_crypto_info_aes_gcm_128 *)crypto_info; +EXTRACT_INFO_FIELDS ; gcm_iv =MLX5_ADDR_OF (tls_static_params, ctx, gcm_iv); initial_rn =MLX5_ADDR_OF (tls_static_params, ctx, initial_record_number);
@@ -234,24 +228,18 @@ tx_post_resync_params(struct mlx5e_txqsq *sq, u64 rcd_sn) {struct tls_crypto_info *crypto_info = priv_tx->crypto_info; +struct tls12_crypto_info_aes_gcm_128 *info;__be64 rn_be =cpu_to_be64 (rcd_sn);bool skip_static_post;u16 rec_seq_sz;char *rec_seq; -switch (crypto_info->cipher_type) { -case TLS_CIPHER_AES_GCM_128 : { -struct tls12_crypto_info_aes_gcm_128 *info = - (struct tls12_crypto_info_aes_gcm_128 *)crypto_info; - - rec_seq = info->rec_seq; - rec_seq_sz =sizeof (info->rec_seq); -break ; - } -default : -WARN_ON (1 ); +if (WARN_ON (crypto_info->cipher_type !=TLS_CIPHER_AES_GCM_128 ))return ; - } + + info = (struct tls12_crypto_info_aes_gcm_128 *)crypto_info; + rec_seq = info->rec_seq; + rec_seq_sz =sizeof (info->rec_seq); skip_static_post = !memcmp (rec_seq, &rn_be, rec_seq_sz);if (!skip_static_post)
Signature · 1 line
2.22.0
Re: [PATCH net-next v3] net/mlx5e: Convert single case statement switch statements into if statements
Quoted 9 lines · Nathan Chancellor
During the review of commit
1ff2f0fa450e("net/mlx5e: Return in default case statement intx_post_resync_params"), Leon and Nick pointed out that the switch statements can be converted to single if statements that return early so that the code is easier to follow.Suggested-by Leon Romanovsky <[email protected]>Suggested-by Nick Desaulniers <[email protected]>Signed-off-by Nathan Chancellor <[email protected]>---
Thanks again,
Re: [PATCH net-next v3] net/mlx5e: Convert single case statement switch statements into if statements
In reply to Nathan ChancellorFrom: Nathan Chancellor <[email protected]>
Date: Tue, 9 Jul 2019 23:06:15 -0700
Quoted 8 lines
During the review of commit
1ff2f0fa450e("net/mlx5e: Return in default case statement intx_post_resync_params"), Leon and Nick pointed out that the switch statements can be converted to single if statements that return early so that the code is easier to follow.Suggested-by Leon Romanovsky <[email protected]>Suggested-by Nick Desaulniers <[email protected]>Signed-off-by Nathan Chancellor <[email protected]>
Applied, thanks for following up Nathan.