clk: fix clk_get_rate() always return ulong
PATCH 1/1 clk: fix clk_get_rate() always return ulong
When we call clk_get_rate(), we expect to get clock rate value as ulong.
In that case we should not use log_ret() macro since it use internally an int.
Otherwise we may return an invalid/truncated clock rate value.
--- drivers/clk/clk-uclass.c | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-)
drivers/clk/clk-uclass.c +1 -5
@@ -488,11 +488,7 @@ ulong clk_get_rate(struct clk *clk)if (!ops->get_rate)return -ENOSYS ; - ret = ops->get_rate (clk); -if (ret) -return log_ret (ret); - -return 0 ; +return ops->get_rate (clk); }struct clk *clk_get_parent (struct clk *clk)
Signature · 1 line
2.41.0
Hi Julien,
Thank you for the patch.
Quoted 4 lines · Julien Masson
When we call
clk_get_rate(), we expect to get clock rate value as ulong.
In that case we should not uselog_ret()macro since it use internally an int.
This is quite subtle, it only happens when log_reg is enabled via CONFIG_LOG_ERROR_RETURN.
Quoted 3 lines
Otherwise we may return an invalid/truncated clock rate value.
Signed-off-by Julien Masson <[email protected]>
I'm wondering if there are any other places where this happens, but this change looks good to me.
Quoted 23 lines
--- drivers/clk/clk-uclass.c | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-)drivers/clk/clk-uclass.c +1
-5@@ -488,11 +488,7 @@ ulong clk_get_rate(struct clk *clk)if (!ops->get_rate)return -ENOSYS ; - ret = ops->get_rate (clk); -if (ret) -return log_ret (ret); - -return 0 ; +return ops->get_rate (clk); }struct clk *clk_get_parent (struct clk *clk)Signature · 1 line
2.41.0
Quoted 14 lines · Mattijs Korpershoek
Hi Julien,
Thank you for the patch.
Quoted 4 lines · Julien Masson
When we call
clk_get_rate(), we expect to get clock rate value as ulong.
In that case we should not uselog_ret()macro since it use internally an int.This is quite subtle, it only happens when
log_regis enabled viaCONFIG_LOG_ERROR_RETURN.
Quoted 8 lines
Quoted 3 lines
Otherwise we may return an invalid/truncated clock rate value.
Signed-off-by Julien Masson <[email protected]>I'm wondering if there are any other places where this happens, but this change looks good to me.
Reviewed-by Mattijs Korpershoek <[email protected]>
Thinking a bit more about this, shouldn't we add some check for downcasting in log.h in order to make sure this does not happen in the future?
Something like this should work:
include/log.h +1 -0
@@ -332,12 +332,14 @@ void __assert_fail(const char *assertion, const char *file, unsigned int line,* use 4 bytes in rodata */ #define log_ret (_ret) ({ \ + _Static_assert(sizeof(_ret) <= sizeof(int), "Cannot log without downcasting"); \ int __ret = (_ret); \ if (__ret < 0) \ log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \ __ret; \ })
Downcasting just when logs are enabled can be the cause for quite some subtle bugs so breaking the build in these cases might be a good warning.
Any thoughts?
Quoted 24 lines
Quoted 24 lines
--- drivers/clk/clk-uclass.c | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-)drivers/clk/clk-uclass.c +1
-5@@ -488,11 +488,7 @@ ulong clk_get_rate(struct clk *clk)if (!ops->get_rate)return -ENOSYS ; - ret = ops->get_rate (clk); -if (ret) -return log_ret (ret); - -return 0 ; +return ops->get_rate (clk); }struct clk *clk_get_parent (struct clk *clk)Signature · 1 line
2.41.0
Sorry for the noise but I miss a (obvious) warning:
drivers/clk/clk-uclass.c:474:8: warning: unused variable ‘ret’ [-Wunused-variable]
474 | ulong ret;
| ^~~I will send a V2.
Quoted 31 lines · Julien Masson
When we call
clk_get_rate(), we expect to get clock rate value as ulong.
In that case we should not uselog_ret()macro since it use internally an int.
Otherwise we may return an invalid/truncated clock rate value.Signed-off-by Julien Masson <[email protected]>--- drivers/clk/clk-uclass.c | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-)drivers/clk/clk-uclass.c +1
-5@@ -488,11 +488,7 @@ ulong clk_get_rate(struct clk *clk)if (!ops->get_rate)return -ENOSYS ; - ret = ops->get_rate (clk); -if (ret) -return log_ret (ret); - -return 0 ; +return ops->get_rate (clk); }struct clk *clk_get_parent (struct clk *clk)Signature · 1 line
2.41.0
Signature · 1 line
Julien Masson
Hi Mattijs,
Thanks for the review.
Quoted 49 lines · Mattijs Korpershoek
Quoted 14 lines · Mattijs Korpershoek
Hi Julien,
Thank you for the patch.
Quoted 4 lines · Julien Masson
When we call
clk_get_rate(), we expect to get clock rate value as ulong.
In that case we should not uselog_ret()macro since it use internally an int.This is quite subtle, it only happens when
log_regis enabled viaCONFIG_LOG_ERROR_RETURN.Quoted 8 lines
Quoted 3 lines
Otherwise we may return an invalid/truncated clock rate value.
Signed-off-by Julien Masson <[email protected]>I'm wondering if there are any other places where this happens, but this change looks good to me.
Reviewed-by Mattijs Korpershoek <[email protected]>Thinking a bit more about this, shouldn't we add some check for downcasting in
log.hin order to make sure this does not happen in the future?Something like this should work:
include/log.h +1
-0@@ -332,12 +332,14 @@ void __assert_fail(const char *assertion, const char *file, unsigned int line,* use 4 bytes in rodata */ #define log_ret (_ret) ({ \ + _Static_assert(sizeof(_ret) <= sizeof(int), "Cannot log without downcasting"); \ int __ret = (_ret); \ if (__ret < 0) \ log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \ __ret; \ })Downcasting just when logs are enabled can be the cause for quite some subtle bugs so breaking the build in these cases might be a good warning.
Quoted 2 lines
Any thoughts?
I agree with the suggestion but in that case all the macros in log.h may need to be updated with the same kind of checks.
And that is not the initial intention of this patch, we should do that in a separate patch I guess.
Quoted 24 lines
Quoted 24 lines
Quoted 24 lines
---
drivers/clk/clk-uclass.c| 6 +-----1 file changed, 1 insertion(+), 5 deletions(-)drivers/clk/clk-uclass.c +1
-5@@ -488,11 +488,7 @@ ulong clk_get_rate(struct clk *clk)if (!ops->get_rate)return -ENOSYS ; - ret = ops->get_rate (clk); -if (ret) -return log_ret (ret); - -return 0 ; +return ops->get_rate (clk); }struct clk *clk_get_parent (struct clk *clk)Signature · 1 line
2.41.0
Signature · 1 line
Julien Masson