BUG: pinmux: release only taken pins on error
Subsystems (2)
PATCH 1/1 BUG: pinmux: release only taken pins on error
commit e38d457de7be63e6ced1ea254aa51466deb1fef0
pinctrl: pinmux: Release all taken pins in pinmux_enable_setting
Introduced a bug in the release pin mechanism.
All the pins (taken or not) where released.
For instance, if a i2c function has already taken pins 5 and 6. And the pins of function PHY are requested (pins 3 4 5 6 7). The pins 3 and 4 will be taken, pin 5 is already taken, so the function fails.
And we have pins 3 and 4 release, which is ok. But also pins 5 and 6 !. And also pin 7 (which will have its mux_usecount to -1...)
This patch reset the original behaviour.
--- drivers/pinctrl/pinmux.c | 2 ++ 1 files changed, 2 insertions(+), 0 deletions(-)
drivers/pinctrl/pinmux.c +2 -0
@@ -409,6 +409,8 @@ int pinmux_enable_setting(struct pinctrl_setting const *setting)dev_err (pctldev->dev,"could not request pin %d on device %s\n" , pins[i],pinctrl_dev_get_name (pctldev)); +/* On error release *only* taken pins */ + num_pins = i -1 ;/* this pin just failed */ goto err_pin_request; } }
Signature · 1 line
1.7.2.5
PATCH 1/1 BUG: pinmux: forbid mux_usecount to be set at UINT_MAX
If pin_free is called on a pin already freed, mux_usecount is set to UINT_MAX which is really a bad idea.
This will silently ignore a double call to pin_free
--- drivers/pinctrl/pinmux.c | 5 +++-- 1 files changed, 3 insertions(+), 2 deletions(-)
drivers/pinctrl/pinmux.c +3 -2
@@ -194,8 +194,9 @@ static const char *pin_free(struct pinctrl_dev *pctldev, int pin, }if (!gpio_range) { - desc->mux_usecount--; -if (desc->mux_usecount) +if (1 == desc->mux_usecount) + desc->mux_usecount =0 ; +else return NULL ; }
Signature · 1 line
1.7.2.5
Re: [PATCH] BUG: pinmux: forbid mux_usecount to be set at UINT_MAX
Quoted 3 lines · Richard Genoud
If
pin_freeis called on a pin already freed,mux_usecountis set toUINT_MAXwhich is really a bad idea.
This will silently ignore a double call topin_free
Shouldn't we WARN_ON(this case)?
drivers/pinctrl/pinmux.c static const char *pin_free(struct pinctrl_dev *pctldev, int pin, · line 200
Quoted 9 lines
drivers/pinctrl/pinmux.c +3
-2if (!gpio_range) { - desc->mux_usecount--; -if (desc->mux_usecount) +if (1 == desc->mux_usecount) + desc->mux_usecount =0 ; +else return NULL ;
What if desc-mux_usecount was 2; this patch prevents the use-count from being decremented to 1 in this case. Shouldn't this be:
if (!gpio_range) {
+ if (WARN_ON(!desc->mux_usecount))
+ return NULL;
desc->mux_usecount--;
Re: [PATCH] BUG: pinmux: forbid mux_usecount to be set at UINT_MAX
2013/3/20 Stephen Warren <[email protected]>:
Quoted 6 lines · Richard Genoud
Quoted 3 lines
If
pin_freeis called on a pin already freed,mux_usecountis set toUINT_MAXwhich is really a bad idea.
This will silently ignore a double call topin_freeShouldn't we
WARN_ON(this case)?
yes indeed, it may be better to issue a big warning because AFAIK that's not normal.
Quoted 16 lines
drivers/pinctrl/pinmux.c static const char *pin_free(struct pinctrl_dev *pctldev, int pin, · line 200
Quoted 10 lines
drivers/pinctrl/pinmux.c +3
-2if (!gpio_range) { - desc->mux_usecount--; -if (desc->mux_usecount) +if (1 == desc->mux_usecount) + desc->mux_usecount =0 ; +else return NULL ;What if desc-mux_usecount was 2; this patch prevents the use-count from being decremented to 1 in this case. Shouldn't this be:
if (!gpio_range) {
Review
Quoted 3 lines
(quoted diff) +2
-0+ if (WARN_ON(!desc->mux_usecount)) + return NULL; desc->mux_usecount--;
Well, I'm not very familiar with this code, but can mux_usecount be higher than 1 ?
Re: [PATCH] BUG: pinmux: forbid mux_usecount to be set at UINT_MAX
Quoted 24 lines · Richard Genoud
2013/3/20 Stephen Warren <[email protected]>:
Quoted 6 lines · Richard Genoud
Quoted 3 lines
If
pin_freeis called on a pin already freed,mux_usecountis set toUINT_MAXwhich is really a bad idea.
This will silently ignore a double call topin_freeShouldn't we
WARN_ON(this case)?yes indeed, it may be better to issue a big warning because AFAIK that's not normal.
Quoted 14 lines
drivers/pinctrl/pinmux.c static const char *pin_free(struct pinctrl_dev *pctldev, int pin, · line 200
Quoted 10 lines
drivers/pinctrl/pinmux.c +3
-2if (!gpio_range) { - desc->mux_usecount--; -if (desc->mux_usecount) +if (1 == desc->mux_usecount) + desc->mux_usecount =0 ; +else return NULL ;What if desc-mux_usecount was 2; this patch prevents the use-count from being decremented to 1 in this case. Shouldn't this be:
Quoted 7 lines
Review
Quoted 4 lines
if (!gpio_range) {(quoted diff) +2
-0+ if (WARN_ON(!desc->mux_usecount)) + return NULL; desc->mux_usecount--;Well, I'm not very familiar with this code, but can
mux_usecountbe higher than 1 ?
Possibly not, but isn't that more something that the resource-acquisition code (i.e. whatever does mux_usecount++) should enforce; the cleanup code should probably support all cases in case the enforcement rules change in the future. Either that, or convert the field to a bool so it's clear what the range is.
PATCH 1/1 BUG: pinmux: forbid mux_usecount to be set at UINT_MAX
If pin_free is called on a pin already freed, mux_usecount is set to UINT_MAX which is really a bad idea.
This will issue a warning, so that we can correct the code responsible for the double free.
---
Ok Stephen, your idea (and code) seems better. I signed-off it, but it's really yours... Feel free to transform my Signed-off-by in a Tested-by
drivers/pinctrl/pinmux.c | 5 +++++ 1 files changed, 5 insertions(+), 0 deletions(-)
drivers/pinctrl/pinmux.c +5 -0
@@ -194,6 +194,11 @@ static const char *pin_free(struct pinctrl_dev *pctldev, int pin, }if (!gpio_range) { +/* +* A pin should not be freed more times than allocated. +*/ +if (WARN_ON (!desc->mux_usecount)) +return NULL ; desc->mux_usecount--;if (desc->mux_usecount)return NULL ;
Signature · 1 line
1.7.2.5
Re: [PATCH] BUG: pinmux: forbid mux_usecount to be set at UINT_MAX
Quoted 10 lines · Richard Genoud
If
pin_freeis called on a pin already freed,mux_usecountis set toUINT_MAXwhich is really a bad idea.
This will issue a warning, so that we can correct the code responsible for the double free.Signed-off-by Richard Genoud <[email protected]>---
Ok Stephen, your idea (and code) seems better. I signed-off it, but it's really yours... Feel free to transform my Signed-off-by in a Tested-by
In this situation, I think you'd often say:
FWIW,
Re: [PATCH] BUG: pinmux: forbid mux_usecount to be set at UINT_MAX
In reply to Richard GenoudQuoted 6 lines · Richard Genoud
If
pin_freeis called on a pin already freed,mux_usecountis set toUINT_MAXwhich is really a bad idea.
This will issue a warning, so that we can correct the code responsible for the double free.Signed-off-by Richard Genoud <[email protected]>
This version of the patch applied with Stephen's Reviewed-by and BUG prefix stripped, it's applied to the fixes branch for the v3.9 release candidates.
Yours,
Linus Walleij
PATCH 1/1 BUG: [RFC] pinctrl: pins are freed 2 times in pinctrl_bind_pins
In reply to Richard GenoudIf the function pinctrl_select_state() fails because one pin is already taken elsewhere, pinmux_enable_setting makes all the necessary pin_free calls (and not more than necessary).
The problem here is that devm_pinctrl_put() will be called on the pin group, and each pin in this group has already been freed.
Example:
If a i2c function has already sucessfully taken pins 5 and 6. And now, pinctrl_bind_pins() is called for function PHY (pins 3 4 5 6 7). pinmux_enable_setting() will fail AND call pin_free on necessary pins. But if devm_pinctrl_put() is called, it will call again pin_free on pins 3 4 5 6 7.
So, the pins 5 and 6 will be released (and pins 3 4 7 double freed). Which means that even if the i2c function has claim the pins, they will be available for other functions.
This patch simply doesn't call devm_pinctrl_put when pinctrl_select_state fails, but I'm not sure it's the right thing to do.
--- drivers/base/pinctrl.c | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
drivers/base/pinctrl.c +1 -1
@@ -45,7 +45,7 @@ int pinctrl_bind_pins(struct device *dev) ret =pinctrl_select_state (dev->pins->p, dev->pins->default_state);if (ret) {dev_dbg (dev,"failed to activate default pinctrl state\n" ); - goto cleanup_get; + goto cleanup_alloc;/* pins already un-muxed */ }return 0 ;
Signature · 1 line
1.7.2.5
Re: [PATCH] BUG: [RFC] pinctrl: pins are freed 2 times in pinctrl_bind_pins
Quoted 16 lines · Richard Genoud
If the function
pinctrl_select_state()fails because one pin is already taken elsewhere,pinmux_enable_settingmakes all the necessarypin_freecalls (and not more than necessary).
The problem here is thatdevm_pinctrl_put()will be called on the pin group, and each pin in this group has already been freed.Example:
If a i2c function has already sucessfully taken pins 5 and 6. And now,pinctrl_bind_pins()is called for function PHY (pins 3 4 5 6 7).pinmux_enable_setting()will fail AND callpin_freeon necessary pins. But ifdevm_pinctrl_put()is called, it will call againpin_freeon pins 3 4 5 6 7.
So, the pins 5 and 6 will be released (and pins 3 4 7 double freed). Which means that even if the i2c function has claim the pins, they will be available for other functions.
Quoted 2 lines
This patch simply doesn't call
devm_pinctrl_putwhenpinctrl_select_statefails, but I'm not sure it's the right thing to do.
The correct fix here is not to skip the call to devm_pinctrl_put(), since that undoes a lot of other things besides the current state selection.
Instead, pinctrl_select_state_locked() needs to be fixed so that:
a)
Change "p->state = state;" to "p->state = NULL;" or similar, to indicate that no state is selected. (Please validate if a NULL value in that variable will cause problems elsewhere)
b)
Add back the assignment "p->state = state;" at the end of the function, if no error occurred.
c)
Fix the list_for_each_entry() call that applies all the settings for the
new state so that if it fails, it undoes everything that it's applied so far. That's the hard part, unless there's a list_for_each_entry_before_the_current_one_that_list_for_each_entry_iterated_over_already() macro!
Re: [PATCH] BUG: [RFC] pinctrl: pins are freed 2 times in pinctrl_bind_pins
2013/3/20 Stephen Warren <[email protected]>:
Quoted 36 lines · Richard Genoud
Quoted 16 lines
If the function
pinctrl_select_state()fails because one pin is already taken elsewhere,pinmux_enable_settingmakes all the necessarypin_freecalls (and not more than necessary).
The problem here is thatdevm_pinctrl_put()will be called on the pin group, and each pin in this group has already been freed.Example:
If a i2c function has already sucessfully taken pins 5 and 6. And now,pinctrl_bind_pins()is called for function PHY (pins 3 4 5 6 7).pinmux_enable_setting()will fail AND callpin_freeon necessary pins. But ifdevm_pinctrl_put()is called, it will call againpin_freeon pins 3 4 5 6 7.
So, the pins 5 and 6 will be released (and pins 3 4 7 double freed). Which means that even if the i2c function has claim the pins, they will be available for other functions.Quoted 2 lines
This patch simply doesn't call
devm_pinctrl_putwhenpinctrl_select_statefails, but I'm not sure it's the right thing to do.The correct fix here is not to skip the call to
devm_pinctrl_put(), since that undoes a lot of other things besides the current state selection.Instead,
pinctrl_select_state_locked()needs to be fixed so that:a)
Change "
p->state= state;" to "p->state= NULL;" or similar, to indicate that no state is selected. (Please validate if a NULL value in that variable will cause problems elsewhere)b)
Add back the assignment "
p->state= state;" at the end of the function, if no error occurred.
Quoted 7 lines
c)
Fix the
list_for_each_entry()call that applies all the settings for the
new state so that if it fails, it undoes everything that it's applied so far. That's the hard part, unless there's alist_for_each_entry_before_the_current_one_that_list_for_each_entry_iterated_over_already()macro!
ok, I'll look into that.
Thanks for your advices !
PS: with its 90chars long, your macro won't please checkpatch.pl ! :)
Regards,
Richard
2013/3/20 Richard Genoud <[email protected]>:
Quoted 24 lines
commit
e38d457de7be63e6ced1ea254aa51466deb1fef0
pinctrl: pinmux: Release all taken pins inpinmux_enable_settingIntroduced a bug in the release pin mechanism.
All the pins (taken or not) where released.
For instance, if a i2c function has already taken pins 5 and 6. And the pins of function PHY are requested (pins 3 4 5 6 7). The pins 3 and 4 will be taken, pin 5 is already taken, so the function fails.
And we have pins 3 and 4 release, which is ok. But also pins 5 and 6 !. And also pin 7 (which will have itsmux_usecountto -1...)This patch reset the original behaviour.
Signed-off-by Richard Genoud <[email protected]>--- drivers/pinctrl/pinmux.c | 2 ++ 1 files changed, 2 insertions(+), 0 deletions(-)drivers/pinctrl/pinmux.c +0
-0
drivers/pinctrl/pinmux.c int pinmux_enable_setting(struct pinctrl_setting const *setting) · line 413
Quoted 5 lines
drivers/pinctrl/pinmux.c +2
-0@@ -409,6 +409,8 @@ int pinmux_enable_setting(struct pinctrl_setting const *setting)dev_err (pctldev->dev,"could not request pin %d on device %s\n" , pins[i],pinctrl_dev_get_name (pctldev)); +/* On error release *only* taken pins */ + num_pins = i -1 ;/* this pin just failed */
This seems pointless, in the goto err_pin_request path, the code does not use num_pins variable at all.
drivers/pinctrl/pinmux.c int pinmux_enable_setting(struct pinctrl_setting const *setting) · line 414
Quoted 1 line
drivers/pinctrl/pinmux.c +0
-0goto err_pin_request;
see the code in err_pin_request,
it actually does "while (--i>-0", so it won't call pin_free for the just failed pin.
err_pin_request:
/* On error release all taken pins */
while (--i >= 0)
pin_free(pctldev, pins[i], NULL);
return ret;2013/3/20 Axel Lin <[email protected]>:
Quoted 39 lines
2013/3/20 Richard Genoud <[email protected]>:
Quoted 24 lines
commit
e38d457de7be63e6ced1ea254aa51466deb1fef0
pinctrl: pinmux: Release all taken pins inpinmux_enable_settingIntroduced a bug in the release pin mechanism.
All the pins (taken or not) where released.
For instance, if a i2c function has already taken pins 5 and 6. And the pins of function PHY are requested (pins 3 4 5 6 7). The pins 3 and 4 will be taken, pin 5 is already taken, so the function fails.
And we have pins 3 and 4 release, which is ok. But also pins 5 and 6 !. And also pin 7 (which will have itsmux_usecountto -1...)This patch reset the original behaviour.
Signed-off-by Richard Genoud <[email protected]>--- drivers/pinctrl/pinmux.c | 2 ++ 1 files changed, 2 insertions(+), 0 deletions(-)drivers/pinctrl/pinmux.c +0
-0drivers/pinctrl/pinmux.c int pinmux_enable_setting(struct pinctrl_setting const *setting) · line 413
Quoted 5 lines
drivers/pinctrl/pinmux.c +2
-0@@ -409,6 +409,8 @@ int pinmux_enable_setting(struct pinctrl_setting const *setting)dev_err (pctldev->dev,"could not request pin %d on device %s\n" , pins[i],pinctrl_dev_get_name (pctldev)); +/* On error release *only* taken pins */ + num_pins = i -1 ;/* this pin just failed */ This seems pointless, in the goto
err_pin_requestpath, the code does not usenum_pinsvariable at all.drivers/pinctrl/pinmux.c int pinmux_enable_setting(struct pinctrl_setting const *setting) · line 414
Quoted 1 line
drivers/pinctrl/pinmux.c +0
-0goto err_pin_request;see the code in
err_pin_request,
it actually does "while (--i>-0", so it won't callpin_freefor the just failed pin.
Quoted 6 lines
err_pin_request:/* On error release all taken pins */ while (--i >= 0) pin_free(pctldev, pins[i], NULL); return ret;
arrrrgg !
it's only Wednesday, and I'm already doing such mistakes ! sorry for that...
This patch can be tossed away with no regret.
The other 2 patches are better I guess