Skip to contentSkip to conversation

fbdev: wait for references go away

PATCH In review Gerd Hoffmann 4 participants 9 messages Jan 20, 2020 – Jan 28, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 fbdev: wait for references go away

Problem: do_unregister_framebuffer() might return before the device is fully cleaned up, due to userspace having a file handle for /dev/fb0 open. Which can result in drm driver not being able to grab resources (and fail initialization) because the firmware framebuffer still holds them. Reportedly plymouth can trigger this.

Fix this by trying to wait until all references are gone. Don't wait forever though given that userspace might keep the file handle open.

---
 drivers/video/fbdev/core/fbmem.c | 7 +++++++
 1 file changed, 7 insertions(+)
drivers/video/fbdev/core/fbmem.c +7 -0
index d04554959ea7..2ea8ac05b065 100644
@@ -35,6 +35,7 @@
 #include <linux/fbcon.h>
 #include <linux/mem_encrypt.h>
 #include <linux/pci.h>
+#include <linux/delay.h>
 
 #include <asm/fb.h>
 
@@ -1707,6 +1708,8 @@ static void unlink_framebuffer(struct fb_info *fb_info)
 
 static void do_unregister_framebuffer(struct fb_info *fb_info)
 {
+	int limit = 100;
+
 	unlink_framebuffer(fb_info);
 	if (fb_info->pixmap.addr &&
 	    (fb_info->pixmap.flags & FB_PIXMAP_DEFAULT))
@@ -1726,6 +1729,10 @@ static void do_unregister_framebuffer(struct fb_info *fb_info)
 	fbcon_fb_unregistered(fb_info);
 	console_unlock();
 
+	/* try wait until all references are gone */
+	while (atomic_read(&fb_info->count) > 1 && --limit > 0)
+		msleep(10);
+
 	/* this may free fb info */
 	put_fb_info(fb_info);
 }
Signature · 1 line
2.18.1
#1 lore raw

Hi,

Quoted 2 lines · Gerd Hoffmann

Problem: do_unregister_framebuffer() might return before the device is fully cleaned up, due to userspace having a file handle for /dev/fb0

do_unregister_framebuffer() doesn't guarantee that fb_info is freed after function's return (it only drops the kernel reference on fb_info).

Quoted 3 lines

open. Which can result in drm driver not being able to grab resources (and fail initialization) because the firmware framebuffer still holds them. Reportedly plymouth can trigger this.

Could you please describe issue some more?

I guess that a problem is happening during DRM driver load while fbdev driver is loaded? I assume do_unregister_framebuffer() is called inside do_remove_conflicting_framebuffers()?

At first glance it seems to be an user-space issue as it should not be holding references on /dev/fb0 while DRM driver is being loaded.

Quoted 2 lines

Fix this by trying to wait until all references are gone. Don't wait forever though given that userspace might keep the file handle open.

Where does the 1s maximum delay come from?

Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics

Quoted 38 lines
---
 drivers/video/fbdev/core/fbmem.c | 7 +++++++
 1 file changed, 7 insertions(+)
drivers/video/fbdev/core/fbmem.c +7 -0
index d04554959ea7..2ea8ac05b065 100644
@@ -35,6 +35,7 @@
 #include <linux/fbcon.h>
 #include <linux/mem_encrypt.h>
 #include <linux/pci.h>
+#include <linux/delay.h>
 
 #include <asm/fb.h>
 
@@ -1707,6 +1708,8 @@ static void unlink_framebuffer(struct fb_info *fb_info)
 
 static void do_unregister_framebuffer(struct fb_info *fb_info)
 {
+	int limit = 100;
+
 	unlink_framebuffer(fb_info);
 	if (fb_info->pixmap.addr &&
 	    (fb_info->pixmap.flags & FB_PIXMAP_DEFAULT))
@@ -1726,6 +1729,10 @@ static void do_unregister_framebuffer(struct fb_info *fb_info)
 	fbcon_fb_unregistered(fb_info);
 	console_unlock();
 
+	/* try wait until all references are gone */
+	while (atomic_read(&fb_info->count) > 1 && --limit > 0)
+		msleep(10);
+
 	/* this may free fb info */
 	put_fb_info(fb_info);
 }
#2 lore raw
Quoted 2 lines · Bartlomiej Zolnierkiewicz

do_unregister_framebuffer() doesn't guarantee that fb_info is freed after function's return (it only drops the kernel reference on fb_info).

s/kernel/fbdev device driver/

Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics

#3 lore raw
In reply to Bartlomiej Zolnierkiewicz
Quoted 3 lines · Bartlomiej Zolnierkiewicz

I guess that a problem is happening during DRM driver load while fbdev driver is loaded? I assume do_unregister_framebuffer() is called inside do_remove_conflicting_framebuffers()?

Yes, exactly. More details here:
https://lists.linuxfoundation.org/pipermail/virtualization/2020-January/045026.html

Quoted 2 lines

At first glance it seems to be an user-space issue as it should not be holding references on /dev/fb0 while DRM driver is being loaded.

How plymouth would know when exactly it needs to release /dev/fb0?

Signature · 5 lines
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
#4 lore raw
In reply to Bartlomiej Zolnierkiewicz

Hi,

Quoted 9 lines
Quoted 3 lines

open. Which can result in drm driver not being able to grab resources (and fail initialization) because the firmware framebuffer still holds them. Reportedly plymouth can trigger this.

Could you please describe issue some more?

I guess that a problem is happening during DRM driver load while fbdev driver is loaded? I assume do_unregister_framebuffer() is called inside do_remove_conflicting_framebuffers()?

Yes. Specifically bochs-drm.ko and efifb in virtual machines.

Quoted 2 lines

At first glance it seems to be an user-space issue as it should not be holding references on /dev/fb0 while DRM driver is being loaded.

Well, the drm driver is loaded by udev like everything else.

Dunno what plymouth (graphical boot screen tool) does to handle the situation. I guess listening to udev events. So it should notice efifb going away and drop the /dev/fb0 reference, but this races against bochs-drm initializing.

Quoted 4 lines
Quoted 2 lines

Fix this by trying to wait until all references are gone. Don't wait forever though given that userspace might keep the file handle open.

Where does the 1s maximum delay come from?

Pulled out something out of thin air which I expect being on the safe side. plymouth responding on the udev event should need only a small fraction of that.

cheers,
Gerd

#5 lore raw
Quoted 17 lines · Gerd Hoffmann

Hi,

Quoted 9 lines
Quoted 3 lines

open. Which can result in drm driver not being able to grab resources (and fail initialization) because the firmware framebuffer still holds them. Reportedly plymouth can trigger this.

Could you please describe issue some more?

I guess that a problem is happening during DRM driver load while fbdev driver is loaded? I assume do_unregister_framebuffer() is called inside do_remove_conflicting_framebuffers()?

Yes. Specifically bochs-drm.ko and efifb in virtual machines.

Quoted 2 lines

At first glance it seems to be an user-space issue as it should not be holding references on /dev/fb0 while DRM driver is being loaded.

Quoted 6 lines

Well, the drm driver is loaded by udev like everything else.

Dunno what plymouth (graphical boot screen tool) does to handle the situation. I guess listening to udev events. So it should notice efifb going away and drop the /dev/fb0 reference, but this races against bochs-drm initializing.

It has been a week and there have been no alternative proposals to address the problem so I incline to accepting this approach..

However please rework the patch slightly:

- Don't wait in the usual fb_info removal code-path, only in the driver replacement one. You can achieve this by adding additional "bool wait" parameter to do_unregister_framebuffer()

- Add a FIXME comment just before the wait loop with the description of the issue (the above explanation of the race between plymouth and udev would be fine) so we will remember why this workaround is needed.

- Change patch summary to something more descriptive (i.e. to "fbdev:
workaround race on driver replacement").

Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics

Quoted 11 lines
Quoted 4 lines
Quoted 2 lines

Fix this by trying to wait until all references are gone. Don't wait forever though given that userspace might keep the file handle open.

Where does the 1s maximum delay come from?

Pulled out something out of thin air which I expect being on the safe side. plymouth responding on the udev event should need only a small fraction of that.

cheers,
Gerd

#6 lore raw
In reply to Gerd Hoffmann
Quoted 7 lines · Gerd Hoffmann

Problem: do_unregister_framebuffer() might return before the device is fully cleaned up, due to userspace having a file handle for /dev/fb0 open. Which can result in drm driver not being able to grab resources (and fail initialization) because the firmware framebuffer still holds them. Reportedly plymouth can trigger this.

Quoted 5 lines

Fix this by trying to wait until all references are gone. Don't wait forever though given that userspace might keep the file handle open.

(Missed this because lca, so a bit late)

This isn't really how driver unload is supposed to happen. Instead:

- Driver unload starts
- Driver calls the foo_unregister function, which stops new userspace from getting at the driver. If you're subsystem is good (i.e. drm since Noralf fixed it) this will also sufficiently synchronize with any pending ioctl.
- Important: This does _not_ wait until userspace closes all references. You can't force that.
- Driver releases all hw structures and mappings and everything else. With fbdev this is currently not fully race free because no one is synchronizing with userspace everywhere correctly.

... much time can pass ...

- Userspace releases the last references, which triggers the final destroy stuff and which releases the memory occupied by various structures still (but not anything releated to hw or anything else really).

So there's two bits:

1. Synchronizing with pending ioctls. This is mostly there already with lock_fb_info/unlock_fb_info. From a quick look the missing bit seems to be that the unregister code is not taking that lock, and so not sufficiently synchronizing against concurrent ioctl calls and other stuff. Plus would need to audit all entry points.

1a. fbcon works differently. Don't look too closely, but this is also not the problem your facing here.

2. Refcounting of the fb structure and hw teardown. That's what's tracked in fb_info->count. Most likely the fbdev driver you have has a wrong split between the hw teardown code and what's in fb_destroy. If you have any hw cleanup code in fb_destroy that driver is buggy. efifb is very buggy in that area :-) Same for offb, simplefb, vesafb and vesa16fb.

We might need a new fb_unregister callback for these drivers to be able to fix this properly. Because the unregister comes from the fbdev core, and not the driver as usual, so the usual driver unload sequence doesnt work:

drm_dev_unregister();
... release all hw resource ...

drm_dev_put();

Or in terms of fbdev:

unregister_framebuffer(info);
... release all hw resources ... <- everyone gets this wrong framebuffer_release(info); <- also wrong because not refcounted, hooray, this should be moved to to end of the ->fb_destroy callback

So we need a callback to put the "release all hw resources" step into the flow at the right place. Another option (slightly less midlayer) would be to add a fb_takeover hook, for these platforms drivers, which would then do the above sequence (like at driver unload).

Also adding Noralf, since he's fixed up all the drm stuff in this area in the past.

Cheers, Daniel

Quoted 43 lines
---
 drivers/video/fbdev/core/fbmem.c | 7 +++++++
 1 file changed, 7 insertions(+)
drivers/video/fbdev/core/fbmem.c +7 -1
index d04554959ea7..2ea8ac05b065 100644
@@ -35,6 +35,7 @@
 #include <linux/fbcon.h>
 #include <linux/mem_encrypt.h>
 #include <linux/pci.h>
+#include <linux/delay.h>
 
 #include <asm/fb.h>
 
@@ -1707,6 +1708,8 @@ static void unlink_framebuffer(struct fb_info *fb_info)
 
 static void do_unregister_framebuffer(struct fb_info *fb_info)
 {
+       int limit = 100;
+
        unlink_framebuffer(fb_info);
        if (fb_info->pixmap.addr &&
            (fb_info->pixmap.flags & FB_PIXMAP_DEFAULT))
@@ -1726,6 +1729,10 @@ static void do_unregister_framebuffer(struct fb_info *fb_info)
        fbcon_fb_unregistered(fb_info);
        console_unlock();
 
+       /* try wait until all references are gone */
+       while (atomic_read(&fb_info->count) > 1 && --limit > 0)
+               msleep(10);
+
        /* this may free fb info */
        put_fb_info(fb_info);
 }
--

2.18.1

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Signature · 3 lines
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch
#7 lore raw
Quoted 37 lines · Daniel Vetter
Quoted 7 lines · Gerd Hoffmann

Problem: do_unregister_framebuffer() might return before the device is fully cleaned up, due to userspace having a file handle for /dev/fb0 open. Which can result in drm driver not being able to grab resources (and fail initialization) because the firmware framebuffer still holds them. Reportedly plymouth can trigger this.

Quoted 5 lines

Fix this by trying to wait until all references are gone. Don't wait forever though given that userspace might keep the file handle open.

(Missed this because lca, so a bit late)

This isn't really how driver unload is supposed to happen. Instead:

- Driver unload starts
- Driver calls the foo_unregister function, which stops new userspace from getting at the driver. If you're subsystem is good (i.e. drm since Noralf fixed it) this will also sufficiently synchronize with any pending ioctl.
- Important: This does _not_ wait until userspace closes all references. You can't force that.
- Driver releases all hw structures and mappings and everything else. With fbdev this is currently not fully race free because no one is synchronizing with userspace everywhere correctly.

... much time can pass ...

- Userspace releases the last references, which triggers the final destroy stuff and which releases the memory occupied by various structures still (but not anything releated to hw or anything else really).

Quoted 7 lines

So there's two bits:

1. Synchronizing with pending ioctls. This is mostly there already with lock_fb_info/unlock_fb_info. From a quick look the missing bit seems to be that the unregister code is not taking that lock, and so not sufficiently synchronizing against concurrent ioctl calls and other stuff. Plus would need to audit all entry points.

Correction: The check here is file_fb_info(), which checks for unregister. Except it's totally racy and misses the end marker (unlike drm_dev_enter/exit in drm). So bunch of work to do here too. The lock_fb_info is purely locking, not lifetime (and I think in a bunch of places way too late).

Quoted 87 lines

1a. fbcon works differently. Don't look too closely, but this is also not the problem your facing here.

2. Refcounting of the fb structure and hw teardown. That's what's tracked in fb_info->count. Most likely the fbdev driver you have has a wrong split between the hw teardown code and what's in fb_destroy. If you have any hw cleanup code in fb_destroy that driver is buggy. efifb is very buggy in that area :-) Same for offb, simplefb, vesafb and vesa16fb.

We might need a new fb_unregister callback for these drivers to be able to fix this properly. Because the unregister comes from the fbdev core, and not the driver as usual, so the usual driver unload sequence doesnt work:

drm_dev_unregister();
... release all hw resource ...

drm_dev_put();

Or in terms of fbdev:

unregister_framebuffer(info);
... release all hw resources ... <- everyone gets this wrong framebuffer_release(info); <- also wrong because not refcounted, hooray, this should be moved to to end of the ->fb_destroy callback

So we need a callback to put the "release all hw resources" step into the flow at the right place. Another option (slightly less midlayer) would be to add a fb_takeover hook, for these platforms drivers, which would then do the above sequence (like at driver unload).

Also adding Noralf, since he's fixed up all the drm stuff in this area in the past.

Cheers, Daniel

Quoted 39 lines
---
 drivers/video/fbdev/core/fbmem.c | 7 +++++++
 1 file changed, 7 insertions(+)
drivers/video/fbdev/core/fbmem.c +7 -1
index d04554959ea7..2ea8ac05b065 100644
@@ -35,6 +35,7 @@
 #include <linux/fbcon.h>
 #include <linux/mem_encrypt.h>
 #include <linux/pci.h>
+#include <linux/delay.h>
 
 #include <asm/fb.h>
 
@@ -1707,6 +1708,8 @@ static void unlink_framebuffer(struct fb_info *fb_info)
 
 static void do_unregister_framebuffer(struct fb_info *fb_info)
 {
+       int limit = 100;
+
        unlink_framebuffer(fb_info);
        if (fb_info->pixmap.addr &&
            (fb_info->pixmap.flags & FB_PIXMAP_DEFAULT))
@@ -1726,6 +1729,10 @@ static void do_unregister_framebuffer(struct fb_info *fb_info)
        fbcon_fb_unregistered(fb_info);
        console_unlock();
 
+       /* try wait until all references are gone */
+       while (atomic_read(&fb_info->count) > 1 && --limit > 0)
+               msleep(10);
+
        /* this may free fb info */
        put_fb_info(fb_info);
 }
--

2.18.1

Quoted 4 lines

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

--
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch

Signature · 3 lines
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch
#8 lore raw
Quoted 47 lines · Daniel Vetter
Quoted 37 lines · Daniel Vetter
Quoted 7 lines · Gerd Hoffmann

Problem: do_unregister_framebuffer() might return before the device is fully cleaned up, due to userspace having a file handle for /dev/fb0 open. Which can result in drm driver not being able to grab resources (and fail initialization) because the firmware framebuffer still holds them. Reportedly plymouth can trigger this.

Quoted 5 lines

Fix this by trying to wait until all references are gone. Don't wait forever though given that userspace might keep the file handle open.

(Missed this because lca, so a bit late)

This isn't really how driver unload is supposed to happen. Instead:

- Driver unload starts
- Driver calls the foo_unregister function, which stops new userspace from getting at the driver. If you're subsystem is good (i.e. drm since Noralf fixed it) this will also sufficiently synchronize with any pending ioctl.
- Important: This does _not_ wait until userspace closes all references. You can't force that.
- Driver releases all hw structures and mappings and everything else. With fbdev this is currently not fully race free because no one is synchronizing with userspace everywhere correctly.

... much time can pass ...

- Userspace releases the last references, which triggers the final destroy stuff and which releases the memory occupied by various structures still (but not anything releated to hw or anything else really).

Quoted 7 lines

So there's two bits:

1. Synchronizing with pending ioctls. This is mostly there already with lock_fb_info/unlock_fb_info. From a quick look the missing bit seems to be that the unregister code is not taking that lock, and so not sufficiently synchronizing against concurrent ioctl calls and other stuff. Plus would need to audit all entry points.

Quoted 5 lines

Correction: The check here is file_fb_info(), which checks for unregister. Except it's totally racy and misses the end marker (unlike drm_dev_enter/exit in drm). So bunch of work to do here too. The lock_fb_info is purely locking, not lifetime (and I think in a bunch of places way too late).

Oh and since your patch is full of races too I expect you'll be able to get away with just adding the ->fb_remove hook, fix up drivers, and leave fixing the various races to someone else.
-Daniel

Quoted 95 lines
Quoted 77 lines

1a. fbcon works differently. Don't look too closely, but this is also not the problem your facing here.

2. Refcounting of the fb structure and hw teardown. That's what's tracked in fb_info->count. Most likely the fbdev driver you have has a wrong split between the hw teardown code and what's in fb_destroy. If you have any hw cleanup code in fb_destroy that driver is buggy. efifb is very buggy in that area :-) Same for offb, simplefb, vesafb and vesa16fb.

We might need a new fb_unregister callback for these drivers to be able to fix this properly. Because the unregister comes from the fbdev core, and not the driver as usual, so the usual driver unload sequence doesnt work:

drm_dev_unregister();
... release all hw resource ...

drm_dev_put();

Or in terms of fbdev:

unregister_framebuffer(info);
... release all hw resources ... <- everyone gets this wrong framebuffer_release(info); <- also wrong because not refcounted, hooray, this should be moved to to end of the ->fb_destroy callback

So we need a callback to put the "release all hw resources" step into the flow at the right place. Another option (slightly less midlayer) would be to add a fb_takeover hook, for these platforms drivers, which would then do the above sequence (like at driver unload).

Also adding Noralf, since he's fixed up all the drm stuff in this area in the past.

Cheers, Daniel

Quoted 39 lines
---
 drivers/video/fbdev/core/fbmem.c | 7 +++++++
 1 file changed, 7 insertions(+)
drivers/video/fbdev/core/fbmem.c +7 -1
index d04554959ea7..2ea8ac05b065 100644
@@ -35,6 +35,7 @@
 #include <linux/fbcon.h>
 #include <linux/mem_encrypt.h>
 #include <linux/pci.h>
+#include <linux/delay.h>
 
 #include <asm/fb.h>
 
@@ -1707,6 +1708,8 @@ static void unlink_framebuffer(struct fb_info *fb_info)
 
 static void do_unregister_framebuffer(struct fb_info *fb_info)
 {
+       int limit = 100;
+
        unlink_framebuffer(fb_info);
        if (fb_info->pixmap.addr &&
            (fb_info->pixmap.flags & FB_PIXMAP_DEFAULT))
@@ -1726,6 +1729,10 @@ static void do_unregister_framebuffer(struct fb_info *fb_info)
        fbcon_fb_unregistered(fb_info);
        console_unlock();
 
+       /* try wait until all references are gone */
+       while (atomic_read(&fb_info->count) > 1 && --limit > 0)
+               msleep(10);
+
        /* this may free fb info */
        put_fb_info(fb_info);
 }
--

2.18.1

Quoted 11 lines
Quoted 4 lines

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

--
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch

--
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch

Signature · 3 lines
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch