Merge ~vanvugt/ubuntu/+source/mutter:fix-1809407-eoan into ~ubuntu-desktop/ubuntu/+source/mutter:ubuntu/master

[Daniel van Vugt]

Fix wallpaper corruption on resume from suspend on Nvidia

https://bugs.launchpad.net/bugs/1809407

[Marco Trevisan (Treviño) (3v1n0)]

This LGTM

review: Approve

[Daniel van Vugt (vanvugt)]

There are now stylistic changes being made upstream. Nothing of substance though so I probably wouldn't bother reflecting them here. This merge proposal exists to avoid being blocked waiting for upstream. If we are now waiting for upstream then I would more likely close this and just wait for the upstream fix to land via mutter 3.33/3.34 into eoan.

[Iain Lane (laney)]

I'll be uploading 3.33.4 once it's released next week. Ideally I'll just
have to do one upload, so this fix can be incorporated into that same
release. Double ideally it'll be in the upstream part of that upload, if
Marco stops nit-picking and presses merge at some point soon. :-)

Close this MP if it gets merged upstream. If it doesn't, I'll look to
merge it when the time comes.

On Fri, Jul 05, 2019 at 03:31:03AM -0000, Daniel van Vugt wrote:
> There are now stylistic changes being made upstream. Nothing of substance though so I probably wouldn't bother reflecting them here. This merge proposal exists to avoid being blocked waiting for upstream. If we are now waiting for upstream then I would more likely close this and just wait for the upstream fix to land via mutter 3.33/3.34 into eoan.
> --
> https://code.launchpad.net/~vanvugt/ubuntu/+source/mutter/+git/mutter/+merge/368536
> Your team Ubuntu Desktop is requested to review the proposed merge of ~vanvugt/ubuntu/+source/mutter:fix-1809407-eoan into ~ubuntu-desktop/ubuntu/+source/mutter:ubuntu/master.
>
> --
> ubuntu-desktop mailing list
> <email address hidden>
> https://lists.ubuntu.com/mailman/listinfo/ubuntu-desktop

--
Iain Lane [ <email address hidden> ]
Debian Developer [ <email address hidden> ]
Ubuntu Developer [ <email address hidden> ]

[Daniel van Vugt (vanvugt)]

Forget this MP. A simpler version has now landed in mutter master, so we'll get the fix from there.

[Daniel van Vugt (vanvugt)]

I would like to reject this instead of deleting it, so we retain history. But Launchpad gives me no Reject option. Can someone else?

[Daniel van Vugt (vanvugt)]

review: Disapprove

Unmerged commits

b0d514e... by Daniel van Vugt on 2019-06-07

Fix wallpaper corruption on resume from suspend on Nvidia

https://bugs.launchpad.net/bugs/1809407

diff --git a/debian/changelog b/debian/changelog
index 531a23e..fb2b934 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+mutter (3.32.2+git20190626-1ubuntu2) UNRELEASED; urgency=medium
+
+  * Add fix-lp1809407-3.32.patch to fix background wallpaper corruption on
+    Nvidia when resuming from suspend (LP: #1809407)
+
+ -- Daniel van Vugt <[e-mail]>  Wed, 03 Jul 2019 17:41:52 +0800
+
 mutter (3.32.2+git20190626-1ubuntu1) eoan; urgency=medium
 
   * Merge with debian (LP: #1834493). Remaining changes:
diff --git a/debian/patches/fix-lp1809407-3.32.patch b/debian/patches/fix-lp1809407-3.32.patch
new file mode 100644
index 0000000..685edc7
--- /dev/null
+++ b/debian/patches/fix-lp1809407-3.32.patch
@@ -0,0 +1,234 @@
+Description: Refresh desktop wallpaper upon resume from suspend
+ The Nvidia driver loses/corrupts its texture memory upon resuming from
+ suspend. This is a *feature* that is officially documented in OpenGL
+ extension "NV_robustness_video_memory_purge". To accomodate this we need
+ to refresh textures kept long-term in GPU memory, most noticeably the
+ desktop wallpaper and clutter canvases like the rounded panel corners
+ (if enabled).
+Author: Daniel van Vugt <[e-mail]>
+Origin: https://gitlab.gnome.org/GNOME/mutter/merge_requests/600
+Bug: https://gitlab.gnome.org/GNOME/gnome-shell/issues/1084
+Bug-Ubuntu: https://bugs.launchpad.net/bugs/1809407
+Forwarded: yes
+Last-Update: 2019-06-07
+
+Index: mutter/clutter/clutter/clutter-canvas.c
+===================================================================
+--- mutter.orig/clutter/clutter/clutter-canvas.c
++++ mutter/clutter/clutter/clutter-canvas.c
+@@ -76,6 +76,8 @@ struct _ClutterCanvasPrivate
+   gboolean dirty;
+ 
+   CoglBitmap *buffer;
++
++  ClutterStage *stage;
+ };
+ 
+ enum
+@@ -130,6 +132,14 @@ clutter_cairo_context_draw_marshaller (G
+ }
+ 
+ static void
++clutter_canvas_dispose (GObject *gobject)
++{
++  ClutterCanvasPrivate *priv = CLUTTER_CANVAS (gobject)->priv;
++
++  g_clear_object (&priv->stage);
++}
++
++static void
+ clutter_canvas_finalize (GObject *gobject)
+ {
+   ClutterCanvasPrivate *priv = CLUTTER_CANVAS (gobject)->priv;
+@@ -312,6 +322,7 @@ clutter_canvas_class_init (ClutterCanvas
+ 
+   gobject_class->set_property = clutter_canvas_set_property;
+   gobject_class->get_property = clutter_canvas_get_property;
++  gobject_class->dispose = clutter_canvas_dispose;
+   gobject_class->finalize = clutter_canvas_finalize;
+ 
+   g_object_class_install_properties (gobject_class, LAST_PROP, obj_props);
+@@ -328,6 +339,12 @@ clutter_canvas_init (ClutterCanvas *self
+ }
+ 
+ static void
++clutter_canvas_video_memory_purged (ClutterCanvas *self)
++{
++  clutter_content_invalidate (CLUTTER_CONTENT (self));
++}
++
++static void
+ clutter_canvas_paint_content (ClutterContent   *content,
+                               ClutterActor     *actor,
+                               ClutterPaintNode *root)
+@@ -335,6 +352,7 @@ clutter_canvas_paint_content (ClutterCon
+   ClutterCanvas *self = CLUTTER_CANVAS (content);
+   ClutterCanvasPrivate *priv = self->priv;
+   ClutterPaintNode *node;
++  ClutterActor *stage;
+ 
+   if (priv->buffer == NULL)
+     return;
+@@ -356,6 +374,17 @@ clutter_canvas_paint_content (ClutterCon
+   clutter_paint_node_unref (node);
+ 
+   priv->dirty = FALSE;
++
++  stage = clutter_actor_get_stage (actor);
++  if (stage != (ClutterActor *) priv->stage)
++    {
++      g_set_object (&priv->stage, CLUTTER_STAGE (stage));
++
++      g_signal_connect_object (stage, "gl-video-memory-purged",
++                               G_CALLBACK (clutter_canvas_video_memory_purged),
++                               self,
++                               G_CONNECT_SWAPPED);
++    }
+ }
+ 
+ static void
+Index: mutter/clutter/clutter/clutter-stage.c
+===================================================================
+--- mutter.orig/clutter/clutter/clutter-stage.c
++++ mutter/clutter/clutter/clutter-stage.c
+@@ -192,6 +192,7 @@ enum
+   DELETE_EVENT,
+   AFTER_PAINT,
+   PRESENTED,
++  GL_VIDEO_MEMORY_PURGED,
+ 
+   LAST_SIGNAL
+ };
+@@ -2268,6 +2269,22 @@ clutter_stage_class_init (ClutterStageCl
+                   G_TYPE_NONE, 2,
+                   G_TYPE_INT, G_TYPE_POINTER);
+ 
++  /**
++   * ClutterStage::gl-video-memory-purged: (skip)
++   * @stage: the stage that received the event
++   *
++   * Signals that the underlying GL driver has had its texture memory purged
++   * so anything presently held in texture memory is now invalidated, and
++   * likely corrupt. It needs redrawing.
++   */
++  stage_signals[GL_VIDEO_MEMORY_PURGED] =
++    g_signal_new (I_("gl-video-memory-purged"),
++                  G_TYPE_FROM_CLASS (gobject_class),
++                  G_SIGNAL_RUN_LAST,
++                  0,
++                  NULL, NULL, NULL,
++                  G_TYPE_NONE, 0);
++
+   klass->fullscreen = clutter_stage_real_fullscreen;
+   klass->activate = clutter_stage_real_activate;
+   klass->deactivate = clutter_stage_real_deactivate;
+Index: mutter/src/compositor/compositor.c
+===================================================================
+--- mutter.orig/src/compositor/compositor.c
++++ mutter/src/compositor/compositor.c
+@@ -1323,6 +1323,7 @@ meta_post_paint_func (gpointer data)
+ 
+     case COGL_GRAPHICS_RESET_STATUS_PURGED_CONTEXT_RESET:
+       g_signal_emit_by_name (compositor->display, "gl-video-memory-purged");
++      g_signal_emit_by_name (compositor->stage , "gl-video-memory-purged");
+       clutter_actor_queue_redraw (CLUTTER_ACTOR (compositor->stage));
+       break;
+ 
+Index: mutter/src/compositor/meta-background.c
+===================================================================
+--- mutter.orig/src/compositor/meta-background.c
++++ mutter/src/compositor/meta-background.c
+@@ -252,12 +252,11 @@ static void
+ set_file (MetaBackground       *self,
+           GFile               **filep,
+           MetaBackgroundImage **imagep,
+-          GFile                *file)
++          GFile                *file,
++          gboolean              force_reload)
+ {
+-  if (!file_equal0 (*filep, file))
++  if (force_reload || !file_equal0 (*filep, file))
+     {
+-      g_clear_object (filep);
+-
+       if (*imagep)
+         {
+           g_signal_handlers_disconnect_by_func (*imagep,
+@@ -267,11 +266,12 @@ set_file (MetaBackground       *self,
+           *imagep = NULL;
+         }
+ 
++      g_set_object (filep, file);
++
+       if (file)
+         {
+           MetaBackgroundImageCache *cache = meta_background_image_cache_get_default ();
+ 
+-          *filep = g_object_ref (file);
+           *imagep = meta_background_image_cache_load (cache, file);
+           g_signal_connect (*imagep, "loaded",
+                             G_CALLBACK (on_background_loaded), self);
+@@ -280,6 +280,32 @@ set_file (MetaBackground       *self,
+ }
+ 
+ static void
++on_gl_video_memory_purged (MetaBackground *self)
++{
++  MetaBackgroundImageCache *cache = meta_background_image_cache_get_default ();
++
++  /* The GPU memory that just got invalidated is the texture inside
++   * self->background_image1,2 and/or its mipmaps. However, to save memory the
++   * original pixbuf isn't kept in RAM so we can't do a simple re-upload. The
++   * only copy of the image was the one in texture memory that got invalidated.
++   * So we need to do a full reload from disk.
++   */
++  if (self->file1)
++    {
++      meta_background_image_cache_purge (cache, self->file1);
++      set_file (self, &self->file1, &self->background_image1, self->file1, TRUE);
++    }
++
++  if (self->file2)
++    {
++      meta_background_image_cache_purge (cache, self->file2);
++      set_file (self, &self->file2, &self->background_image2, self->file2, TRUE);
++    }
++
++  mark_changed (self);
++}
++
++static void
+ meta_background_dispose (GObject *object)
+ {
+   MetaBackground        *self = META_BACKGROUND (object);
+@@ -287,8 +313,8 @@ meta_background_dispose (GObject *object
+   free_color_texture (self);
+   free_wallpaper_texture (self);
+ 
+-  set_file (self, &self->file1, &self->background_image1, NULL);
+-  set_file (self, &self->file2, &self->background_image2, NULL);
++  set_file (self, &self->file1, &self->background_image1, NULL, FALSE);
++  set_file (self, &self->file2, &self->background_image2, NULL, FALSE);
+ 
+   set_display (self, NULL);
+ 
+@@ -312,7 +338,7 @@ meta_background_constructed (GObject *ob
+   G_OBJECT_CLASS (meta_background_parent_class)->constructed (object);
+ 
+   g_signal_connect_object (self->display, "gl-video-memory-purged",
+-                           G_CALLBACK (mark_changed), object, G_CONNECT_SWAPPED);
++                           G_CALLBACK (on_gl_video_memory_purged), object, G_CONNECT_SWAPPED);
+ 
+   g_signal_connect_object (monitor_manager, "monitors-changed",
+                            G_CALLBACK (on_monitors_changed), self,
+@@ -937,8 +963,8 @@ meta_background_set_blend (MetaBackgroun
+   g_return_if_fail (META_IS_BACKGROUND (self));
+   g_return_if_fail (blend_factor >= 0.0 && blend_factor <= 1.0);
+ 
+-  set_file (self, &self->file1, &self->background_image1, file1);
+-  set_file (self, &self->file2, &self->background_image2, file2);
++  set_file (self, &self->file1, &self->background_image1, file1, FALSE);
++  set_file (self, &self->file2, &self->background_image2, file2, FALSE);
+ 
+   self->blend_factor = blend_factor;
+   self->style = style;
diff --git a/debian/patches/series b/debian/patches/series
index 5e2b370..cd3cd05 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -3,3 +3,4 @@ theme-load-icons-as-Gtk-does-with-fallback-and-RTL-suppor.patch
 meson-add-back-default_driver-option.patch
 debian/synaptics-support.patch
 x11-Add-support-for-fractional-scaling-using-Randr.patch
+fix-lp1809407-3.32.patch