nvme-hwmon: don't return errors from nvme_hwmon_init
Subsystems (2)
Christoph Hellwig
maintainerPATCH 1/1 nvme-hwmon: don't return errors from nvme_hwmon_init
An NVMe controller works perfectly fine even when the hwmon initialization fails. Stop returning errors from nvme_hwmon_init to handle this case consistently.
---
This should go before the patch from Serge to document and consistently handle the lack of initialization failure handling for hwmon.
drivers/nvme/host/core.c | 7 ++----- drivers/nvme/host/hwmon.c | 16 +++++++++------- drivers/nvme/host/nvme.h | 5 ++--- 3 files changed, 13 insertions(+), 15 deletions(-)
drivers/nvme/host/core.c +2 -5
@@ -3261,11 +3261,8 @@ int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl)if (ret <0 )return ret; -if (!ctrl->identified && !nvme_discovery_ctrl (ctrl)) { - ret =nvme_hwmon_init (ctrl); -if (ret <0 ) -return ret; - } +if (!ctrl->identified && !nvme_discovery_ctrl (ctrl)) +nvme_hwmon_init (ctrl); ctrl->identified = true;
drivers/nvme/host/hwmon.c +9 -7
@@ -221,7 +221,8 @@ static const struct hwmon_chip_info nvme_hwmon_chip_info = { .info = nvme_hwmon_info, }; -int nvme_hwmon_init (struct nvme_ctrl *ctrl) +/* do not return errors - nvme works fine without hwmon registration */ +void nvme_hwmon_init (struct nvme_ctrl *ctrl) {struct device *dev = ctrl->device;struct nvme_hwmon_data *data;
@@ -230,7 +231,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) data =kzalloc (sizeof (*data),GFP_KERNEL );if (!data) -return 0 ; +return ; data->ctrl = ctrl;mutex_init (&data->read_lock);
@@ -238,8 +239,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) err =nvme_hwmon_get_smart_log (data);if (err) {dev_warn (dev,"Failed to read smart log (error %d)\n" , err); -kfree (data); -return err; + goto out_free_data; } hwmon = hwmon_device_register_with_info(dev, "nvme",
@@ -247,11 +247,13 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) NULL);if (IS_ERR (hwmon)) {dev_warn (dev,"Failed to instantiate hwmon device\n" ); -kfree (data); -return PTR_ERR (hwmon); + goto out_free_data; } ctrl->hwmon_device = hwmon; -return 0 ; +return ; + +out_free_data: +kfree (data); }void nvme_hwmon_exit (struct nvme_ctrl *ctrl)
drivers/nvme/host/nvme.h +2 -3
@@ -1000,12 +1000,11 @@ static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev) }#ifdef CONFIG_NVME_HWMON -int nvme_hwmon_init (struct nvme_ctrl *ctrl); +void nvme_hwmon_init (struct nvme_ctrl *ctrl);void nvme_hwmon_exit (struct nvme_ctrl *ctrl);#else -static inline int nvme_hwmon_init (struct nvme_ctrl *ctrl) +static inline void nvme_hwmon_init (struct nvme_ctrl *ctrl) { -return 0 ; }static inline void nvme_hwmon_exit (struct nvme_ctrl *ctrl)
Signature · 1 line
2.30.2
Quoted 5 lines · Christoph Hellwig
An NVMe controller works perfectly fine even when the hwmon initialization fails. Stop returning errors from
nvme_hwmon_initto handle this case consistently.Signed-off-by Christoph Hellwig <[email protected]>
I was going to resubmit the series taking into account your resolution on this issue since patch #3 still needs to be resent. But you just submitted a fixup patch. Less worries to me. I'll resend patch #3 separately then. Thanks.
-Sergey
Quoted 100 lines
---
This should go before the patch from Serge to document and consistently handle the lack of initialization failure handling for hwmon.
drivers/nvme/host/core.c | 7 ++----- drivers/nvme/host/hwmon.c | 16 +++++++++------- drivers/nvme/host/nvme.h | 5 ++--- 3 files changed, 13 insertions(+), 15 deletions(-)drivers/nvme/host/core.c +2
-5@@ -3261,11 +3261,8 @@ int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl)if (ret <0 )return ret; -if (!ctrl->identified && !nvme_discovery_ctrl (ctrl)) { - ret =nvme_hwmon_init (ctrl); -if (ret <0 ) -return ret; - } +if (!ctrl->identified && !nvme_discovery_ctrl (ctrl)) +nvme_hwmon_init (ctrl); ctrl->identified = true;drivers/nvme/host/hwmon.c +9
-7@@ -221,7 +221,8 @@ static const struct hwmon_chip_info nvme_hwmon_chip_info = { .info = nvme_hwmon_info, }; -int nvme_hwmon_init (struct nvme_ctrl *ctrl) +/* do not return errors - nvme works fine without hwmon registration */ +void nvme_hwmon_init (struct nvme_ctrl *ctrl) {struct device *dev = ctrl->device;struct nvme_hwmon_data *data;@@ -230,7 +231,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) data =kzalloc (sizeof (*data),GFP_KERNEL );if (!data) -return 0 ; +return ; data->ctrl = ctrl;mutex_init (&data->read_lock);@@ -238,8 +239,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) err =nvme_hwmon_get_smart_log (data);if (err) {dev_warn (dev,"Failed to read smart log (error %d)\n" , err); -kfree (data); -return err; + goto out_free_data; } hwmon = hwmon_device_register_with_info(dev, "nvme",@@ -247,11 +247,13 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) NULL);if (IS_ERR (hwmon)) {dev_warn (dev,"Failed to instantiate hwmon device\n" ); -kfree (data); -return PTR_ERR (hwmon); + goto out_free_data; } ctrl->hwmon_device = hwmon; -return 0 ; +return ; + +out_free_data: +kfree (data); }void nvme_hwmon_exit (struct nvme_ctrl *ctrl)drivers/nvme/host/nvme.h +2
-3@@ -1000,12 +1000,11 @@ static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev) }#ifdef CONFIG_NVME_HWMON -int nvme_hwmon_init (struct nvme_ctrl *ctrl); +void nvme_hwmon_init (struct nvme_ctrl *ctrl);void nvme_hwmon_exit (struct nvme_ctrl *ctrl);#else -static inline int nvme_hwmon_init (struct nvme_ctrl *ctrl) +static inline void nvme_hwmon_init (struct nvme_ctrl *ctrl) { -return 0 ; }static inline void nvme_hwmon_exit (struct nvme_ctrl *ctrl)Signature · 1 line
2.30.2
Christoph Hellwig
maintainerQuoted 11 lines · Serge Semin
Quoted 5 lines · Christoph Hellwig
An NVMe controller works perfectly fine even when the hwmon initialization fails. Stop returning errors from
nvme_hwmon_initto handle this case consistently.Signed-off-by Christoph Hellwig <[email protected]>I was going to resubmit the series taking into account your resolution on this issue since patch #3 still needs to be resent. But you just submitted a fixup patch. Less worries to me. I'll resend patch #3 separately then. Thanks.
I already have a locally rebased version, so don't bother.
Quoted 8 lines · Christoph Hellwig
Quoted 7 lines · Serge Semin
Quoted 5 lines · Christoph Hellwig
An NVMe controller works perfectly fine even when the hwmon initialization fails. Stop returning errors from
nvme_hwmon_initto handle this case consistently.Signed-off-by Christoph Hellwig <[email protected]>
Quoted 7 lines
Quoted 4 lines
I was going to resubmit the series taking into account your resolution on this issue since patch #3 still needs to be resent. But you just submitted a fixup patch. Less worries to me. I'll resend patch #3 separately then. Thanks.
I already have a locally rebased version, so don't bother.
Just to clarify. Are you saying that you have already got a patch for the sed-opal driver which fixes opal_dev.{cmd,resp} buffers being used for DMA and takes the Jonathan Derrick note into account? Here is his note:
-Sergey
Christoph Hellwig
maintainerQuoted 3 lines · Serge Semin
Just to clarify. Are you saying that you have already got a patch for the sed-opal driver which fixes opal_dev.{cmd,resp} buffers being used for DMA and takes the Jonathan Derrick note into account?
No, just the nvme patch. For sed-opal please just resend it standalone to the linux-block list and the maintainers.
Quoted 8 lines · Christoph Hellwig
Quoted 3 lines · Serge Semin
Just to clarify. Are you saying that you have already got a patch for the sed-opal driver which fixes opal_dev.{cmd,resp} buffers being used for DMA and takes the Jonathan Derrick note into account?
No, just the nvme patch. For sed-opal please just resend it standalone to the linux-block list and the maintainers.
Ok. Thanks.
-Sergey
Keith Busch
maintainerdrivers/nvme/host/core.c int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl) · line 3265
Quoted 11 lines · Christoph Hellwig
drivers/nvme/host/core.c +2
-5@@ -3261,11 +3261,8 @@ int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl)if (ret <0 )return ret; -if (!ctrl->identified && !nvme_discovery_ctrl (ctrl)) { - ret =nvme_hwmon_init (ctrl); -if (ret <0 ) -return ret; - } +if (!ctrl->identified && !nvme_discovery_ctrl (ctrl)) +nvme_hwmon_init (ctrl);
We still need to check for < 0 since nvme_hwmon_init() sends an admin command. If the admin command times out, the controller is reset and -EINTR is returned, indicating we have to abort initialization. All other errors should be ignored, though, since the controller remains usable.
Christoph Hellwig
maintainerQuoted 5 lines · Keith Busch
We still need to check for < 0 since
nvme_hwmon_init()sends an admin command. If the admin command times out, the controller is reset and-EINTRis returned, indicating we have to abort initialization. All other errors should be ignored, though, since the controller remains usable.
So I guess we should just ignore everything but EINTR, e.g.:
drivers/nvme/host/hwmon.c +15 -5
@@ -230,7 +230,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) data =kzalloc (sizeof (*data),GFP_KERNEL );if (!data) -return 0 ; + goto err; data->ctrl = ctrl;mutex_init (&data->read_lock);
@@ -238,8 +238,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) err =nvme_hwmon_get_smart_log (data);if (err) {dev_warn (dev,"Failed to read smart log (error %d)\n" , err); -kfree (data); -return err; + goto err_free_data; } hwmon = hwmon_device_register_with_info(dev, "nvme",
@@ -247,11 +246,22 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) NULL);if (IS_ERR (hwmon)) {dev_warn (dev,"Failed to instantiate hwmon device\n" ); -kfree (data); -return PTR_ERR (hwmon); + err =PTR_ERR (hwmon); + goto err_free_data; } ctrl->hwmon_device = hwmon;return 0 ; + +err_free_data: +kfree (data); +err: +/* +* Do not return errors unless we are in a controller reset. +* The controller works perfectly fine without the hwmon registration. +*/ +if (err == -EINTR ) +return -EINTR ; +return 0 ; }void nvme_hwmon_exit (struct nvme_ctrl *ctrl)
Signature · 1 line
2.30.2
Keith Busch
maintainerQuoted 8 lines · Christoph Hellwig
Quoted 5 lines · Keith Busch
We still need to check for < 0 since
nvme_hwmon_init()sends an admin command. If the admin command times out, the controller is reset and-EINTRis returned, indicating we have to abort initialization. All other errors should be ignored, though, since the controller remains usable.So I guess we should just ignore everything but EINTR, e.g.:
Yep, this looks fine. You'll just need to initialize 'int err = 0;' at the beginning.
Quoted 51 lines
drivers/nvme/host/hwmon.c +15
-5@@ -230,7 +230,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) data =kzalloc (sizeof (*data),GFP_KERNEL );if (!data) -return 0 ; + goto err; data->ctrl = ctrl;mutex_init (&data->read_lock);@@ -238,8 +238,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) err =nvme_hwmon_get_smart_log (data);if (err) {dev_warn (dev,"Failed to read smart log (error %d)\n" , err); -kfree (data); -return err; + goto err_free_data; } hwmon = hwmon_device_register_with_info(dev, "nvme",@@ -247,11 +246,22 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) NULL);if (IS_ERR (hwmon)) {dev_warn (dev,"Failed to instantiate hwmon device\n" ); -kfree (data); -return PTR_ERR (hwmon); + err =PTR_ERR (hwmon); + goto err_free_data; } ctrl->hwmon_device = hwmon;return 0 ; + +err_free_data: +kfree (data); +err: +/* +* Do not return errors unless we are in a controller reset. +* The controller works perfectly fine without the hwmon registration. +*/ +if (err == -EINTR ) +return -EINTR ; +return 0 ; }void nvme_hwmon_exit (struct nvme_ctrl *ctrl)Signature · 1 line
2.30.2
Christoph Hellwig
maintainerQuoted 2 lines · Keith Busch
Yep, this looks fine. You'll just need to initialize 'int err = 0;' at the beginning.
Grr, stupid lack of uninitialized variable tracking in gcc..
Quoted 57 lines · Keith Busch
Quoted 8 lines · Christoph Hellwig
Quoted 5 lines · Keith Busch
We still need to check for < 0 since
nvme_hwmon_init()sends an admin command. If the admin command times out, the controller is reset and-EINTRis returned, indicating we have to abort initialization. All other errors should be ignored, though, since the controller remains usable.So I guess we should just ignore everything but EINTR, e.g.:
Yep, this looks fine. You'll just need to initialize 'int err = 0;' at the beginning.
Quoted 42 lines
drivers/nvme/host/hwmon.c +12
-5@@ -230,7 +230,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) data =kzalloc (sizeof (*data),GFP_KERNEL );if (!data) -return 0 ; + goto err; data->ctrl = ctrl;mutex_init (&data->read_lock);@@ -238,8 +238,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) err =nvme_hwmon_get_smart_log (data);if (err) {dev_warn (dev,"Failed to read smart log (error %d)\n" , err); -kfree (data); -return err; + goto err_free_data; } hwmon = hwmon_device_register_with_info(dev, "nvme",@@ -247,11 +246,22 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) NULL);if (IS_ERR (hwmon)) {dev_warn (dev,"Failed to instantiate hwmon device\n" ); -kfree (data); -return PTR_ERR (hwmon); + err =PTR_ERR (hwmon); + goto err_free_data; } ctrl->hwmon_device = hwmon;return 0 ; + +err_free_data: +kfree (data); +err: +/* +* Do not return errors unless we are in a controller reset. +* The controller works perfectly fine without the hwmon registration. +*/
Quoted 2 lines
drivers/nvme/host/hwmon.c int nvme_hwmon_init(struct nvme_ctrl *ctrl) · line 263
Quoted 2 lines
drivers/nvme/host/hwmon.c +2
-0+if (err == -EINTR ) +return -EINTR ;
What about just taking the -EINTR error into account by the nvme_hwmon_init() caller and ignore any other there? Meanwhile you can convert the nvme_hwmon_init() method to return any error including the ENOMEM. Thus the function will be more consistent and will have independent from the caller context design.
-Sergey
Quoted 7 lines
Quoted 7 lines
drivers/nvme/host/hwmon.c +1
-0+return 0 ; }void nvme_hwmon_exit (struct nvme_ctrl *ctrl)Signature · 1 line
2.30.2
Christoph Hellwig
maintainerQuoted 5 lines · Serge Semin
What about just taking the
-EINTRerror into account by thenvme_hwmon_init()caller and ignore any other there? Meanwhile you can convert thenvme_hwmon_init()method to return any error including the ENOMEM. Thus the function will be more consistent and will have independent from the caller context design.
Yeah, that actually looks a tad cleaner than what I just sent out:
drivers/nvme/host/core.c +5 -1
@@ -3261,9 +3261,13 @@ int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl)if (ret <0 )return ret; +/* +* Do not return errors unless we are in a controller reset. +* The controller works perfectly fine without the hwmon registration. +*/ if (!ctrl->identified && !nvme_discovery_ctrl (ctrl)) { ret =nvme_hwmon_init (ctrl); -if (ret <0 ) +if (err == -EINTR )return ret; }
drivers/nvme/host/hwmon.c +8 -5
@@ -230,7 +230,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) data =kzalloc (sizeof (*data),GFP_KERNEL );if (!data) -return 0 ; +return -ENOMEM ; data->ctrl = ctrl;mutex_init (&data->read_lock);
@@ -238,8 +238,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) err =nvme_hwmon_get_smart_log (data);if (err) {dev_warn (dev,"Failed to read smart log (error %d)\n" , err); -kfree (data); -return err; + goto err_free_data; } hwmon = hwmon_device_register_with_info(dev, "nvme",
@@ -247,11 +246,15 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) NULL);if (IS_ERR (hwmon)) {dev_warn (dev,"Failed to instantiate hwmon device\n" ); -kfree (data); -return PTR_ERR (hwmon); + err =PTR_ERR (hwmon); + goto err_free_data; } ctrl->hwmon_device = hwmon;return 0 ; + +err_free_data: +kfree (data); +return err; }void nvme_hwmon_exit (struct nvme_ctrl *ctrl)
Quoted 19 lines · Christoph Hellwig
Quoted 5 lines · Serge Semin
What about just taking the
-EINTRerror into account by thenvme_hwmon_init()caller and ignore any other there? Meanwhile you can convert thenvme_hwmon_init()method to return any error including the ENOMEM. Thus the function will be more consistent and will have independent from the caller context design.Yeah, that actually looks a tad cleaner than what I just sent out:
drivers/nvme/host/core.c +0
-0@@ -3261,9 +3261,13 @@ int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl)if (ret <0 )return ret;
drivers/nvme/host/core.c int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl) · line 3272
Quoted 10 lines
drivers/nvme/host/core.c +5
-1+/* +* Do not return errors unless we are in a controller reset. +* The controller works perfectly fine without the hwmon registration. +*/ if (!ctrl->identified && !nvme_discovery_ctrl (ctrl)) { ret =nvme_hwmon_init (ctrl); -if (ret <0 ) +if (err == -EINTR )return ret;
Note: s/err/ret
Exactly what I meant. Looks good to me.
-Sergey
Quoted 43 lines
drivers/nvme/host/core.c +0
-0}drivers/nvme/host/hwmon.c +8
-5@@ -230,7 +230,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) data =kzalloc (sizeof (*data),GFP_KERNEL );if (!data) -return 0 ; +return -ENOMEM ; data->ctrl = ctrl;mutex_init (&data->read_lock);@@ -238,8 +238,7 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) err =nvme_hwmon_get_smart_log (data);if (err) {dev_warn (dev,"Failed to read smart log (error %d)\n" , err); -kfree (data); -return err; + goto err_free_data; } hwmon = hwmon_device_register_with_info(dev, "nvme",@@ -247,11 +246,15 @@ int nvme_hwmon_init(struct nvme_ctrl *ctrl) NULL);if (IS_ERR (hwmon)) {dev_warn (dev,"Failed to instantiate hwmon device\n" ); -kfree (data); -return PTR_ERR (hwmon); + err =PTR_ERR (hwmon); + goto err_free_data; } ctrl->hwmon_device = hwmon;return 0 ; + +err_free_data: +kfree (data); +return err; }void nvme_hwmon_exit (struct nvme_ctrl *ctrl)