isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-12 17:27:03 -05:00
Code Issues Packages Projects Releases Wiki Activity

Deprecate clutter_threads_enter()/leave()

Browse Source 
Acquiring the Clutter lock to mark critical sections is not portable,
and not recommended to implement threaded applications with Clutter.

The recommended pattern is to use worker threads, and schedule UI
updates inside idle or timeout handlers within the main loop. We should
enforce this pattern by deprecating the threads_enter()/leave()
functions. For compatibility concerns, we need internal API to acquire
the main lock during frame processing dispatch.

https://bugzilla.gnome.org/show_bug.cgi?id=679450
This commit is contained in:
Emmanuele Bassi 2012-07-05 14:30:26 +01:00
parent 25be8e86f7
commit 0e4c6d0a87
13 changed files with 107 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
clutter/clutter-main.c
View File

@ -940,9 +940,9 @@ clutter_main (void)
if (g_main_loop_is_running (main_loops->data))
{
clutter_threads_leave ();
_clutter_threads_release_lock ();
g_main_loop_run (loop);
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
}
main_loops = g_slist_remove (main_loops, loop);
@ -1024,12 +1024,12 @@ _clutter_threads_dispatch (gpointer data)
ClutterThreadsDispatch *dispatch = data;
gboolean ret = FALSE;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
if (!g_source_is_destroyed (g_main_current_source ()))
ret = dispatch->func (dispatch->data);
clutter_threads_leave ();
_clutter_threads_release_lock ();
return ret;
}
@ -1265,18 +1265,37 @@ clutter_threads_add_timeout (guint interval,
NULL);
}
void
_clutter_threads_acquire_lock (void)
{
if (clutter_threads_lock != NULL)
(* clutter_threads_lock) ();
}
void
_clutter_threads_release_lock (void)
{
if (clutter_threads_unlock != NULL)
(* clutter_threads_unlock) ();
}
/**
* clutter_threads_enter:
*
* Locks the Clutter thread lock.
*
* Since: 0.4
*
* Deprecated: 1.12: This function should not be used by application
* code; marking critical sections is not portable on various
* platforms. Instead of acquiring the Clutter lock, schedule UI
* updates from the main loop using clutter_threads_add_idle() or
* clutter_threads_add_timeout().
*/
void
clutter_threads_enter (void)
{
if (clutter_threads_lock != NULL)
(* clutter_threads_lock) ();
_clutter_threads_acquire_lock ();
}
/**
@ -1285,12 +1304,17 @@ clutter_threads_enter (void)
* Unlocks the Clutter thread lock.
*
* Since: 0.4
*
* Deprecated: 1.12: This function should not be used by application
* code; marking critical sections is not portable on various
* platforms. Instead of acquiring the Clutter lock, schedule UI
* updates from the main loop using clutter_threads_add_idle() or
* clutter_threads_add_timeout().
*/
void
clutter_threads_leave (void)
{
if (clutter_threads_unlock != NULL)
(* clutter_threads_unlock) ();
_clutter_threads_release_lock ();
}

2
clutter/clutter-main.h
View File

@ -101,8 +101,6 @@ void clutter_do_event (ClutterEvent *e
gboolean clutter_get_accessibility_enabled (void);
/* Threading functions */
void clutter_threads_enter (void);
void clutter_threads_leave (void);
void clutter_threads_set_lock_functions (GCallback enter_fn,
GCallback leave_fn);
guint clutter_threads_add_idle (GSourceFunc func,

13
clutter/clutter-master-clock.c
View File

@ -429,7 +429,7 @@ clutter_clock_prepare (GSource *source,
ClutterMasterClock *master_clock = clock_source->master_clock;
int delay;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
if (G_UNLIKELY (clutter_paint_debug_flags &
CLUTTER_DEBUG_CONTINUOUS_REDRAW))
@ -445,7 +445,8 @@ clutter_clock_prepare (GSource *source,
}
delay = master_clock_next_frame_delay (master_clock);
clutter_threads_leave ();
_clutter_threads_release_lock ();
*timeout = delay;
@ -459,9 +460,9 @@ clutter_clock_check (GSource *source)
ClutterMasterClock *master_clock = clock_source->master_clock;
int delay;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
delay = master_clock_next_frame_delay (master_clock);
clutter_threads_leave ();
_clutter_threads_release_lock ();
return delay == 0;
}
@ -487,7 +488,7 @@ clutter_clock_dispatch (GSource *source,
CLUTTER_NOTE (SCHEDULER, "Master clock [tick]");
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
/* Get the time to use for this frame */
master_clock->cur_tick = g_source_get_time (source);
@ -528,7 +529,7 @@ clutter_clock_dispatch (GSource *source,
master_clock->prev_tick = master_clock->cur_tick;
clutter_threads_leave ();
_clutter_threads_release_lock ();
CLUTTER_TIMER_STOP (_clutter_uprof_context, master_dispatch_timer);

3
clutter/clutter-private.h
View File

@ -193,6 +193,9 @@ typedef struct
gboolean _clutter_threads_dispatch (gpointer data);
void _clutter_threads_dispatch_free (gpointer data);
void _clutter_threads_acquire_lock (void);
void _clutter_threads_release_lock (void);
ClutterMainContext * _clutter_context_get_default (void);
void _clutter_context_lock (void);
void _clutter_context_unlock (void);

6
clutter/deprecated/clutter-main.h
View File

@ -34,6 +34,12 @@ G_BEGIN_DECLS
CLUTTER_DEPRECATED_IN_1_10
void clutter_threads_init (void);
CLUTTER_DEPRECATED_IN_1_12
void clutter_threads_enter (void);
CLUTTER_DEPRECATED_IN_1_12
void clutter_threads_leave (void);
CLUTTER_DEPRECATED_IN_1_6
guint clutter_threads_add_frame_source (guint fps,
GSourceFunc func,

1
clutter/deprecated/clutter-timeout-pool.c
View File

@ -35,6 +35,7 @@
#endif
#define CLUTTER_DISABLE_DEPRECATION_WARNINGS
#include "deprecated/clutter-main.h"
#include "clutter-timeout-pool.h"

12
clutter/evdev/clutter-device-manager-evdev.c
View File

@ -120,12 +120,12 @@ clutter_event_prepare (GSource *source,
{
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
*timeout = -1;
retval = clutter_events_pending ();
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -136,12 +136,12 @@ clutter_event_check (GSource *source)
ClutterEventSource *event_source = (ClutterEventSource *) source;
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
retval = ((event_source->event_poll_fd.revents & G_IO_IN) ||
clutter_events_pending ());
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -297,7 +297,7 @@ clutter_event_dispatch (GSource *g_source,
uint32_t _time;
ClutterStage *stage;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
stage = _clutter_input_device_get_stage (input_device);
@ -428,7 +428,7 @@ clutter_event_dispatch (GSource *g_source,
}
out:
clutter_threads_leave ();
_clutter_threads_release_lock ();
return TRUE;
}

4
clutter/gdk/clutter-event-gdk.c
View File

@ -102,7 +102,7 @@ clutter_gdk_handle_event (GdkEvent *gdk_event)
if (stage == NULL)
return GDK_FILTER_CONTINUE;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
switch (gdk_event->type)
{
@ -315,7 +315,7 @@ clutter_gdk_handle_event (GdkEvent *gdk_event)
result = GDK_FILTER_REMOVE;
}
clutter_threads_leave ();
_clutter_threads_release_lock ();
return result;
}

33
clutter/osx/clutter-event-loop-osx.c
View File

@ -32,7 +32,9 @@
#include <sys/types.h>
#include <sys/uio.h>
#include <unistd.h>
#include <clutter/clutter-debug.h>
#include "clutter-debug.h"
#include "clutter-private.h"
/*
* This file implementations integration between the GLib main loop and
@ -643,13 +645,13 @@ clutter_event_prepare (GSource *source,
{
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
*timeout = -1;
retval = (clutter_events_pending () || _clutter_osx_event_loop_check_pending ());
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -659,7 +661,7 @@ clutter_event_check (GSource *source)
{
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
/* XXX: This check isn't right it won't handle a recursive GLib main
* loop run within an outer CFRunLoop run. Such loops will pile up
@ -678,7 +680,7 @@ clutter_event_check (GSource *source)
retval = (clutter_events_pending () || _clutter_osx_event_loop_check_pending ());
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -691,16 +693,19 @@ clutter_event_dispatch (GSource *source,
NSEvent *nsevent;
ClutterEvent *event;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
nsevent = _clutter_osx_event_loop_get_pending ();
if (nsevent) {
clutter_threads_leave ();
[NSApp sendEvent:nsevent];
clutter_threads_enter ();
_clutter_osx_event_loop_release_event (nsevent);
}
if (nsevent)
{
_clutter_threads_release_lock ();
[NSApp sendEvent:nsevent];
_clutter_threads_acquire_lock ();
_clutter_osx_event_loop_release_event (nsevent);
}
event = clutter_event_get ();
@ -711,7 +716,7 @@ clutter_event_dispatch (GSource *source,
clutter_event_free (event);
}
clutter_threads_leave ();
_clutter_threads_release_lock ();
return TRUE;
}

13
clutter/tslib/clutter-event-tslib.c
View File

@ -173,12 +173,12 @@ clutter_event_prepare (GSource *source,
{
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
*timeout = -1;
retval = clutter_events_pending ();
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -189,12 +189,12 @@ clutter_event_check (GSource *source)
ClutterEventSource *event_source = (ClutterEventSource *) source;
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
retval = ((event_source->event_poll_fd.revents & G_IO_IN) ||
clutter_events_pending ());
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -208,7 +208,7 @@ clutter_event_dispatch (GSource *source,
struct ts_sample tsevent;
ClutterEvent *event;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
/* FIXME while would be better here but need to deal with lockups */
if ((!clutter_events_pending()) &&
@ -272,8 +272,7 @@ clutter_event_dispatch (GSource *source,
}
out:
clutter_threads_leave ();
_clutter_threads_release_lock ();
return TRUE;
}

18
clutter/wayland/clutter-event-wayland.c
View File

@ -32,8 +32,10 @@
#include <stdlib.h>
#include <wayland-client.h>
#include "../clutter-event.h"
#include "../clutter-main.h"
#include "clutter-event.h"
#include "clutter-main.h"
#include "clutter-private.h"
#include "clutter-event-wayland.h"
typedef struct _ClutterEventSourceWayland
@ -50,7 +52,7 @@ clutter_event_source_wayland_prepare (GSource *base, gint *timeout)
ClutterEventSourceWayland *source = (ClutterEventSourceWayland *) base;
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
*timeout = -1;
@ -61,7 +63,7 @@ clutter_event_source_wayland_prepare (GSource *base, gint *timeout)
retval = clutter_events_pending ();
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -72,11 +74,11 @@ clutter_event_source_wayland_check (GSource *base)
ClutterEventSourceWayland *source = (ClutterEventSourceWayland *) base;
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
retval = clutter_events_pending () || source->pfd.revents;
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -89,7 +91,7 @@ clutter_event_source_wayland_dispatch (GSource *base,
ClutterEventSourceWayland *source = (ClutterEventSourceWayland *) base;
ClutterEvent *event;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
if (source->pfd.revents)
{
@ -106,7 +108,7 @@ clutter_event_source_wayland_dispatch (GSource *base,
clutter_event_free (event);
}
clutter_threads_leave ();
_clutter_threads_release_lock ();
return TRUE;
}

12
clutter/win32/clutter-event-win32.c
View File

@ -246,12 +246,12 @@ clutter_event_prepare (GSource *source,
{
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
*timeout = -1;
retval = (clutter_events_pending () || check_msg_pending ());
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -262,14 +262,14 @@ clutter_event_check (GSource *source)
ClutterEventSource *event_source = (ClutterEventSource *) source;
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
if ((event_source->event_poll_fd.revents & G_IO_IN))
retval = (clutter_events_pending () || check_msg_pending ());
else
retval = FALSE;
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -282,7 +282,7 @@ clutter_event_dispatch (GSource *source,
ClutterEvent *event;
MSG msg;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
/* Process Windows messages until we've got one that translates into
the clutter event queue */
@ -298,7 +298,7 @@ clutter_event_dispatch (GSource *source,
clutter_event_free (event);
}
clutter_threads_leave ();
_clutter_threads_release_lock ();
return TRUE;
}

17
clutter/x11/clutter-event-x11.c
View File

@ -33,6 +33,7 @@
#include "clutter-debug.h"
#include "clutter-event-private.h"
#include "clutter-main.h"
#include "clutter-private.h"
#include <string.h>
@ -182,7 +183,7 @@ clutter_x11_handle_event (XEvent *xevent)
result = CLUTTER_X11_FILTER_CONTINUE;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
backend = clutter_get_default_backend ();
@ -230,7 +231,7 @@ out:
XFreeEventData (xdisplay, &xevent->xcookie);
#endif
clutter_threads_leave ();
_clutter_threads_release_lock ();
return result;
}
@ -242,12 +243,12 @@ clutter_event_prepare (GSource *source,
ClutterBackendX11 *backend = ((ClutterEventSource *) source)->backend;
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
*timeout = -1;
retval = (clutter_events_pending () || XPending (backend->xdpy));
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -259,14 +260,14 @@ clutter_event_check (GSource *source)
ClutterBackendX11 *backend = event_source->backend;
gboolean retval;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
if (event_source->event_poll_fd.revents & G_IO_IN)
retval = (clutter_events_pending () || XPending (backend->xdpy));
else
retval = FALSE;
clutter_threads_leave ();
_clutter_threads_release_lock ();
return retval;
}
@ -308,7 +309,7 @@ clutter_event_dispatch (GSource *source,
ClutterBackendX11 *backend = ((ClutterEventSource *) source)->backend;
ClutterEvent *event;
clutter_threads_enter ();
_clutter_threads_acquire_lock ();
/* Grab the event(s), translate and figure out double click.
* The push onto queue (stack) if valid.
@ -324,7 +325,7 @@ clutter_event_dispatch (GSource *source,
clutter_event_free (event);
}
clutter_threads_leave ();
_clutter_threads_release_lock ();
return TRUE;
}