From: Jacek Anaszewski <j.anaszewski@samsung.com>
To: Hans de Goede <hdegoede@redhat.com>, linux-leds@vger.kernel.org
Cc: linux-kernel@vger.kernel.org,
Sakari Ailus <sakari.ailus@linux.intel.com>,
Pavel Machek <pavel@ucw.cz>, Andrew Lunn <andrew@lunn.ch>
Subject: Re: [PATCH] leds: Add mutex protection in brightness_show()
Date: Mon, 07 Nov 2016 10:11:10 +0100 [thread overview]
Message-ID: <32b106fa-1315-3e27-07b6-1f91ac9773c4@samsung.com> (raw)
In-Reply-To: <1189fd14-a0a6-867e-1082-e84771f29014@redhat.com>
Hi,
On 11/06/2016 03:52 PM, Hans de Goede wrote:
> Hi,
>
> On 04-11-16 17:46, Hans de Goede wrote:
>> Hi,
>>
>> On 04-11-16 17:06, Jacek Anaszewski wrote:
>>> Hi Hans,
>>>
>>> On 11/04/2016 12:53 PM, Hans de Goede wrote:
>>>> Hi,
>>>>
>>>> On 04-11-16 08:52, Jacek Anaszewski wrote:
>>>>> Initially the claim about no need for lock in brightness_show()
>>>>> was valid as the function was just returning unchanged
>>>>> LED brightness. After the addition of led_update_brightness() this
>>>>> is no longer true, as the function can change the brightness if
>>>>> a LED class driver implements brightness_get op. It can lead to
>>>>> races between led_update_brightness() and led_set_brightness(),
>>>>> resulting in overwriting new brightness with the old one before
>>>>> the former is written to the device.
>>>>>
>>>>> Signed-off-by: Jacek Anaszewski <j.anaszewski@samsung.com>
>>>>> Cc: Hans de Goede <hdegoede@redhat.com>
>>>>> Cc: Sakari Ailus <sakari.ailus@linux.intel.com>
>>>>> Cc: Pavel Machek <pavel@ucw.cz>
>>>>> Cc: Andrew Lunn <andrew@lunn.ch>
>>>>> ---
>>>>> drivers/leds/led-class.c | 3 ++-
>>>>> 1 file changed, 2 insertions(+), 1 deletion(-)
>>>>>
>>>>> diff --git a/drivers/leds/led-class.c b/drivers/leds/led-class.c
>>>>> index 731e4eb..0c2307b 100644
>>>>> --- a/drivers/leds/led-class.c
>>>>> +++ b/drivers/leds/led-class.c
>>>>> @@ -30,8 +30,9 @@ static ssize_t brightness_show(struct device *dev,
>>>>> {
>>>>> struct led_classdev *led_cdev = dev_get_drvdata(dev);
>>>>>
>>>>> - /* no lock needed for this */
>>>>> + mutex_lock(&led_cdev->led_access);
>>>>> led_update_brightness(led_cdev);
>>>>> + mutex_unlock(&led_cdev->led_access);
>>>>>
>>>>> return sprintf(buf, "%u\n", led_cdev->brightness);
>>>>> }
>>>>>
>>>>
>>>> I'm afraid that this fix is not enough, the led_access lock is only
>>>> held when the brightness is being updated through sysfs, not for
>>>> trigger / sw-blinking updates (which cannot take a mutex as they
>>>> may be called from non blocking contexts).
>>>>
>>>> We may need to consider to add a spinlock to the led_classdev and
>>>> always lock that when calling into the driver, except for when
>>>> the driver has a brightness_set_blocking callback. Which will need
>>>> special handling.
>>>
>>> led_update_brightness() currently has two users besides LED subsystem
>>> (at least grep reports those places):
>>>
>>> 1. v4l2-flash-led-class wrapper, for which led_access mutex was
>>> introduced. Its purpose was to disable LED sysfs interface while
>>> v4l2-flash wrapper takes over control of LED class device
>>> (not saying that the mutex wasn't missing even without this
>>> use case). Now I've realized that the call to
>>> led_sysfs_is_disabled() is missing in this patch.
>>> 2. /drivers/platform/x86/thinkpad_acpi.c - it calls
>>> led_update_brightness() on suspend
>>>
>>> I think that the best we can now do is to add
>>> lockdep_assert_held(&led_cdev->led_access) in led_update_brightness()
>>> and a description saying that the caller has to acquire led_access
>>> lock before calling it. Similarly as in case of
>>> led_sysfs_disable()/led_sysfs_disable().
>>
>> The problem is not only callers of led_update_brightness() not holding
>> led_cdev->led_access, the problem is also callers of led_set_brightness
>> not holding led_cdev->led_access and they cannot take this lock because
>> they may be called from a non-blocking context.
>
> Thinking more about this, using a spinlock is also not going to work
> because led_cdev->brightness_set_blocking and led_cdev->brightness_get
> can both block and thus cannot be called with a spinlock held.
>
> I think that we need to just make this a problem of the led drivers
> and in include/linux/leds.h document that the led-core does not do
> locking and that the drivers themselves need to protect against
> their brightness_set / brightness_get callbacks when necessary.
Thanks for the analysis. Either way, this patch, with the modification
I mentioned in my previous message is required to assure proper
LED sysfs locking.
Regarding the races between user and atomic context, I think that
it should be system root's responsibility to define LED access
policy. If a LED is registered for any trigger events then setting
brightness from user space should be made impossible. Such a hint
could be even added to the Documentation/leds/leds-class.txt.
--
Best regards,
Jacek Anaszewski
next prev parent reply other threads:[~2016-11-07 9:11 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-04 7:52 [PATCH] leds: Add mutex protection in brightness_show() Jacek Anaszewski
2016-11-04 11:53 ` Hans de Goede
2016-11-04 16:06 ` Jacek Anaszewski
2016-11-04 16:46 ` Hans de Goede
2016-11-06 14:52 ` Hans de Goede
2016-11-07 9:11 ` Jacek Anaszewski [this message]
2016-11-09 12:37 ` Pavel Machek
2016-11-09 20:26 ` Pavel Machek
2016-11-09 21:23 ` Jacek Anaszewski
2016-11-09 12:38 ` Pavel Machek
2016-11-09 21:23 ` Jacek Anaszewski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=32b106fa-1315-3e27-07b6-1f91ac9773c4@samsung.com \
--to=j.anaszewski@samsung.com \
--cc=andrew@lunn.ch \
--cc=hdegoede@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-leds@vger.kernel.org \
--cc=pavel@ucw.cz \
--cc=sakari.ailus@linux.intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).