efl/legacy/ecore/src/lib/ecore/ecore_idle_exiter.c

180 lines
4.7 KiB
C
Raw Normal View History

#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdlib.h>
2004-03-16 21:44:17 -08:00
#include "Ecore.h"
#include "ecore_private.h"
2004-03-16 21:44:17 -08:00
struct _Ecore_Idle_Exiter
{
EINA_INLIST;
ECORE_MAGIC;
Ecore_Task_Cb func;
void *data;
int references;
Eina_Bool delete_me : 1;
};
GENERIC_ALLOC_SIZE_DECLARE(Ecore_Idle_Exiter);
2004-03-16 21:44:17 -08:00
static Ecore_Idle_Exiter *idle_exiters = NULL;
Fix idle_exiters when using recursive main loops. If an idle_exiter created a recursive main loop (just called ecore_main_loop_begin()), then this recursive main loop should continue to process idle_exiters from there and on, thus idle_exiter_current was added. When going back from recursion, the current iterator should be updated properly. This patch also fixes the deletion of idle_exiters from recursive main loops by reference counting them. This way, the node will not be free()d inside inner loop cleanups and then crash when going back to outer loop. The following test case used to crash but not anymore: #include <Ecore.h> #include <Eina.h> static int _log_dom; #define INF(...) EINA_LOG_DOM_INFO(_log_dom, __VA_ARGS__) static Ecore_Idle_Exiter *handle; static int idler(void *data) { INF("idler"); return 1; } static int timer(void *data) { INF("timer (exited idle!)"); return 0; } static int exit_idle(void *data) { INF("add request (timer) to exit idle"); ecore_timer_add(0.0, timer, NULL); return 0; } static int cb2(void *data) { INF("cb2 - delete cb1 handle"); ecore_idle_exiter_del(handle); ecore_main_loop_quit(); /* quits inner main loop */ return 0; } static int cb1(void *data) { INF("cb1: begin"); INF(" add cb2"); ecore_idle_exiter_add(cb2, NULL); INF(" add exit idler"); ecore_idler_add(exit_idle, NULL); INF(" inner main loop begin (recurse)"); ecore_main_loop_begin(); /* will it crash due ecore_idle_exiter_del(handle) * inside cb2()? It used to! */ INF("cb1: end"); ecore_main_loop_quit(); /* quits outer main loop */ return 0; } int main(void) { ecore_init(); _log_dom = eina_log_domain_register("test", EINA_COLOR_CYAN); /* * Creating a new main loop from inside an idle_exiter callback, * and inside this new (inner) main loop deleting the caller * callback used to crash since the handle would be effectively * free()d, but when the recursion is over the pointer would be * used. */ INF("main: begin"); handle = ecore_idle_exiter_add(cb1, NULL); ecore_idler_add(idler, NULL); ecore_idler_add(exit_idle, NULL); ecore_main_loop_begin(); INF("main: end"); return 0; } SVN revision: 46410
2010-02-23 14:25:35 -08:00
static Ecore_Idle_Exiter *idle_exiter_current = NULL;
static int idle_exiters_delete_me = 0;
2004-03-16 21:44:17 -08:00
static void *
_ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter);
2010-10-17 00:03:28 -07:00
/**
* @addtogroup Ecore_Idle_Group
2010-10-17 00:03:28 -07:00
*
* @{
*/
2004-03-16 21:44:17 -08:00
/**
* Add an idle exiter handler.
* @param func The function to call when exiting an idle state.
* @param data The data to be passed to the @p func call
2004-05-07 21:44:04 -07:00
* @return A handle to the idle exiter callback on success. NULL otherwise.
* @note The function func will be called every time the main loop is exiting
* idle state, as long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0
* (or ECORE_CALLBACK_CANCEL) deletes the idle exiter.
2004-03-16 21:44:17 -08:00
*/
EAPI Ecore_Idle_Exiter *
ecore_idle_exiter_add(Ecore_Task_Cb func,
const void *data)
2004-03-16 21:44:17 -08:00
{
Ecore_Idle_Exiter *ie = NULL;
2004-03-16 21:44:17 -08:00
EINA_MAIN_LOOP_CHECK_RETURN_VAL(NULL);
_ecore_lock();
if (!func) goto unlock;
2011-12-02 19:39:07 -08:00
ie = ecore_idle_exiter_calloc(1);
if (!ie) goto unlock;
2004-03-16 21:44:17 -08:00
ECORE_MAGIC_SET(ie, ECORE_MAGIC_IDLE_EXITER);
ie->func = func;
ie->data = (void *)data;
idle_exiters = (Ecore_Idle_Exiter *)eina_inlist_append(EINA_INLIST_GET(idle_exiters), EINA_INLIST_GET(ie));
unlock:
_ecore_unlock();
2004-03-16 21:44:17 -08:00
return ie;
}
/**
2004-05-07 21:44:04 -07:00
* Delete an idle exiter handler from the list to be run on exiting idle state.
2004-03-16 21:44:17 -08:00
* @param idle_exiter The idle exiter to delete
2004-05-07 21:44:04 -07:00
* @return The data pointer that was being being passed to the handler if
* successful. NULL otherwise.
2004-03-16 21:44:17 -08:00
*/
EAPI void *
2004-03-16 21:44:17 -08:00
ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter)
{
void *data;
EINA_MAIN_LOOP_CHECK_RETURN_VAL(NULL);
2004-03-16 21:44:17 -08:00
if (!ECORE_MAGIC_CHECK(idle_exiter, ECORE_MAGIC_IDLE_EXITER))
{
2010-09-29 23:09:20 -07:00
ECORE_MAGIC_FAIL(idle_exiter, ECORE_MAGIC_IDLE_EXITER,
"ecore_idle_exiter_del");
return NULL;
2004-03-16 21:44:17 -08:00
}
_ecore_lock();
data = _ecore_idle_exiter_del(idle_exiter);
_ecore_unlock();
return data;
2004-03-16 21:44:17 -08:00
}
2010-10-17 00:03:28 -07:00
/**
* @}
*/
static void *
_ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter)
{
EINA_SAFETY_ON_TRUE_RETURN_VAL(idle_exiter->delete_me, NULL);
idle_exiter->delete_me = 1;
idle_exiters_delete_me = 1;
return idle_exiter->data;
}
2004-03-16 21:44:17 -08:00
void
_ecore_idle_exiter_shutdown(void)
{
Ecore_Idle_Exiter *ie;
while ((ie = idle_exiters))
2004-03-16 21:44:17 -08:00
{
idle_exiters = (Ecore_Idle_Exiter *)eina_inlist_remove(EINA_INLIST_GET(idle_exiters), EINA_INLIST_GET(idle_exiters));
2010-09-29 23:09:20 -07:00
ECORE_MAGIC_SET(ie, ECORE_MAGIC_NONE);
2011-12-02 19:39:07 -08:00
ecore_idle_exiter_mp_free(ie);
2004-03-16 21:44:17 -08:00
}
idle_exiters_delete_me = 0;
Fix idle_exiters when using recursive main loops. If an idle_exiter created a recursive main loop (just called ecore_main_loop_begin()), then this recursive main loop should continue to process idle_exiters from there and on, thus idle_exiter_current was added. When going back from recursion, the current iterator should be updated properly. This patch also fixes the deletion of idle_exiters from recursive main loops by reference counting them. This way, the node will not be free()d inside inner loop cleanups and then crash when going back to outer loop. The following test case used to crash but not anymore: #include <Ecore.h> #include <Eina.h> static int _log_dom; #define INF(...) EINA_LOG_DOM_INFO(_log_dom, __VA_ARGS__) static Ecore_Idle_Exiter *handle; static int idler(void *data) { INF("idler"); return 1; } static int timer(void *data) { INF("timer (exited idle!)"); return 0; } static int exit_idle(void *data) { INF("add request (timer) to exit idle"); ecore_timer_add(0.0, timer, NULL); return 0; } static int cb2(void *data) { INF("cb2 - delete cb1 handle"); ecore_idle_exiter_del(handle); ecore_main_loop_quit(); /* quits inner main loop */ return 0; } static int cb1(void *data) { INF("cb1: begin"); INF(" add cb2"); ecore_idle_exiter_add(cb2, NULL); INF(" add exit idler"); ecore_idler_add(exit_idle, NULL); INF(" inner main loop begin (recurse)"); ecore_main_loop_begin(); /* will it crash due ecore_idle_exiter_del(handle) * inside cb2()? It used to! */ INF("cb1: end"); ecore_main_loop_quit(); /* quits outer main loop */ return 0; } int main(void) { ecore_init(); _log_dom = eina_log_domain_register("test", EINA_COLOR_CYAN); /* * Creating a new main loop from inside an idle_exiter callback, * and inside this new (inner) main loop deleting the caller * callback used to crash since the handle would be effectively * free()d, but when the recursion is over the pointer would be * used. */ INF("main: begin"); handle = ecore_idle_exiter_add(cb1, NULL); ecore_idler_add(idler, NULL); ecore_idler_add(exit_idle, NULL); ecore_main_loop_begin(); INF("main: end"); return 0; } SVN revision: 46410
2010-02-23 14:25:35 -08:00
idle_exiter_current = NULL;
2004-03-16 21:44:17 -08:00
}
void
_ecore_idle_exiter_call(void)
{
Fix idle_exiters when using recursive main loops. If an idle_exiter created a recursive main loop (just called ecore_main_loop_begin()), then this recursive main loop should continue to process idle_exiters from there and on, thus idle_exiter_current was added. When going back from recursion, the current iterator should be updated properly. This patch also fixes the deletion of idle_exiters from recursive main loops by reference counting them. This way, the node will not be free()d inside inner loop cleanups and then crash when going back to outer loop. The following test case used to crash but not anymore: #include <Ecore.h> #include <Eina.h> static int _log_dom; #define INF(...) EINA_LOG_DOM_INFO(_log_dom, __VA_ARGS__) static Ecore_Idle_Exiter *handle; static int idler(void *data) { INF("idler"); return 1; } static int timer(void *data) { INF("timer (exited idle!)"); return 0; } static int exit_idle(void *data) { INF("add request (timer) to exit idle"); ecore_timer_add(0.0, timer, NULL); return 0; } static int cb2(void *data) { INF("cb2 - delete cb1 handle"); ecore_idle_exiter_del(handle); ecore_main_loop_quit(); /* quits inner main loop */ return 0; } static int cb1(void *data) { INF("cb1: begin"); INF(" add cb2"); ecore_idle_exiter_add(cb2, NULL); INF(" add exit idler"); ecore_idler_add(exit_idle, NULL); INF(" inner main loop begin (recurse)"); ecore_main_loop_begin(); /* will it crash due ecore_idle_exiter_del(handle) * inside cb2()? It used to! */ INF("cb1: end"); ecore_main_loop_quit(); /* quits outer main loop */ return 0; } int main(void) { ecore_init(); _log_dom = eina_log_domain_register("test", EINA_COLOR_CYAN); /* * Creating a new main loop from inside an idle_exiter callback, * and inside this new (inner) main loop deleting the caller * callback used to crash since the handle would be effectively * free()d, but when the recursion is over the pointer would be * used. */ INF("main: begin"); handle = ecore_idle_exiter_add(cb1, NULL); ecore_idler_add(idler, NULL); ecore_idler_add(exit_idle, NULL); ecore_main_loop_begin(); INF("main: end"); return 0; } SVN revision: 46410
2010-02-23 14:25:35 -08:00
if (!idle_exiter_current)
{
2010-09-29 23:09:20 -07:00
/* regular main loop, start from head */
idle_exiter_current = idle_exiters;
Fix idle_exiters when using recursive main loops. If an idle_exiter created a recursive main loop (just called ecore_main_loop_begin()), then this recursive main loop should continue to process idle_exiters from there and on, thus idle_exiter_current was added. When going back from recursion, the current iterator should be updated properly. This patch also fixes the deletion of idle_exiters from recursive main loops by reference counting them. This way, the node will not be free()d inside inner loop cleanups and then crash when going back to outer loop. The following test case used to crash but not anymore: #include <Ecore.h> #include <Eina.h> static int _log_dom; #define INF(...) EINA_LOG_DOM_INFO(_log_dom, __VA_ARGS__) static Ecore_Idle_Exiter *handle; static int idler(void *data) { INF("idler"); return 1; } static int timer(void *data) { INF("timer (exited idle!)"); return 0; } static int exit_idle(void *data) { INF("add request (timer) to exit idle"); ecore_timer_add(0.0, timer, NULL); return 0; } static int cb2(void *data) { INF("cb2 - delete cb1 handle"); ecore_idle_exiter_del(handle); ecore_main_loop_quit(); /* quits inner main loop */ return 0; } static int cb1(void *data) { INF("cb1: begin"); INF(" add cb2"); ecore_idle_exiter_add(cb2, NULL); INF(" add exit idler"); ecore_idler_add(exit_idle, NULL); INF(" inner main loop begin (recurse)"); ecore_main_loop_begin(); /* will it crash due ecore_idle_exiter_del(handle) * inside cb2()? It used to! */ INF("cb1: end"); ecore_main_loop_quit(); /* quits outer main loop */ return 0; } int main(void) { ecore_init(); _log_dom = eina_log_domain_register("test", EINA_COLOR_CYAN); /* * Creating a new main loop from inside an idle_exiter callback, * and inside this new (inner) main loop deleting the caller * callback used to crash since the handle would be effectively * free()d, but when the recursion is over the pointer would be * used. */ INF("main: begin"); handle = ecore_idle_exiter_add(cb1, NULL); ecore_idler_add(idler, NULL); ecore_idler_add(exit_idle, NULL); ecore_main_loop_begin(); INF("main: end"); return 0; } SVN revision: 46410
2010-02-23 14:25:35 -08:00
}
else
{
2010-09-29 23:09:20 -07:00
/* recursive main loop, continue from where we were */
idle_exiter_current =
(Ecore_Idle_Exiter *)EINA_INLIST_GET(idle_exiter_current)->next;
Fix idle_exiters when using recursive main loops. If an idle_exiter created a recursive main loop (just called ecore_main_loop_begin()), then this recursive main loop should continue to process idle_exiters from there and on, thus idle_exiter_current was added. When going back from recursion, the current iterator should be updated properly. This patch also fixes the deletion of idle_exiters from recursive main loops by reference counting them. This way, the node will not be free()d inside inner loop cleanups and then crash when going back to outer loop. The following test case used to crash but not anymore: #include <Ecore.h> #include <Eina.h> static int _log_dom; #define INF(...) EINA_LOG_DOM_INFO(_log_dom, __VA_ARGS__) static Ecore_Idle_Exiter *handle; static int idler(void *data) { INF("idler"); return 1; } static int timer(void *data) { INF("timer (exited idle!)"); return 0; } static int exit_idle(void *data) { INF("add request (timer) to exit idle"); ecore_timer_add(0.0, timer, NULL); return 0; } static int cb2(void *data) { INF("cb2 - delete cb1 handle"); ecore_idle_exiter_del(handle); ecore_main_loop_quit(); /* quits inner main loop */ return 0; } static int cb1(void *data) { INF("cb1: begin"); INF(" add cb2"); ecore_idle_exiter_add(cb2, NULL); INF(" add exit idler"); ecore_idler_add(exit_idle, NULL); INF(" inner main loop begin (recurse)"); ecore_main_loop_begin(); /* will it crash due ecore_idle_exiter_del(handle) * inside cb2()? It used to! */ INF("cb1: end"); ecore_main_loop_quit(); /* quits outer main loop */ return 0; } int main(void) { ecore_init(); _log_dom = eina_log_domain_register("test", EINA_COLOR_CYAN); /* * Creating a new main loop from inside an idle_exiter callback, * and inside this new (inner) main loop deleting the caller * callback used to crash since the handle would be effectively * free()d, but when the recursion is over the pointer would be * used. */ INF("main: begin"); handle = ecore_idle_exiter_add(cb1, NULL); ecore_idler_add(idler, NULL); ecore_idler_add(exit_idle, NULL); ecore_main_loop_begin(); INF("main: end"); return 0; } SVN revision: 46410
2010-02-23 14:25:35 -08:00
}
Fix idle_exiters when using recursive main loops. If an idle_exiter created a recursive main loop (just called ecore_main_loop_begin()), then this recursive main loop should continue to process idle_exiters from there and on, thus idle_exiter_current was added. When going back from recursion, the current iterator should be updated properly. This patch also fixes the deletion of idle_exiters from recursive main loops by reference counting them. This way, the node will not be free()d inside inner loop cleanups and then crash when going back to outer loop. The following test case used to crash but not anymore: #include <Ecore.h> #include <Eina.h> static int _log_dom; #define INF(...) EINA_LOG_DOM_INFO(_log_dom, __VA_ARGS__) static Ecore_Idle_Exiter *handle; static int idler(void *data) { INF("idler"); return 1; } static int timer(void *data) { INF("timer (exited idle!)"); return 0; } static int exit_idle(void *data) { INF("add request (timer) to exit idle"); ecore_timer_add(0.0, timer, NULL); return 0; } static int cb2(void *data) { INF("cb2 - delete cb1 handle"); ecore_idle_exiter_del(handle); ecore_main_loop_quit(); /* quits inner main loop */ return 0; } static int cb1(void *data) { INF("cb1: begin"); INF(" add cb2"); ecore_idle_exiter_add(cb2, NULL); INF(" add exit idler"); ecore_idler_add(exit_idle, NULL); INF(" inner main loop begin (recurse)"); ecore_main_loop_begin(); /* will it crash due ecore_idle_exiter_del(handle) * inside cb2()? It used to! */ INF("cb1: end"); ecore_main_loop_quit(); /* quits outer main loop */ return 0; } int main(void) { ecore_init(); _log_dom = eina_log_domain_register("test", EINA_COLOR_CYAN); /* * Creating a new main loop from inside an idle_exiter callback, * and inside this new (inner) main loop deleting the caller * callback used to crash since the handle would be effectively * free()d, but when the recursion is over the pointer would be * used. */ INF("main: begin"); handle = ecore_idle_exiter_add(cb1, NULL); ecore_idler_add(idler, NULL); ecore_idler_add(exit_idle, NULL); ecore_main_loop_begin(); INF("main: end"); return 0; } SVN revision: 46410
2010-02-23 14:25:35 -08:00
while (idle_exiter_current)
2004-03-16 21:44:17 -08:00
{
2010-09-29 23:09:20 -07:00
Ecore_Idle_Exiter *ie = (Ecore_Idle_Exiter *)idle_exiter_current;
if (!ie->delete_me)
{
ie->references++;
if (!_ecore_call_task_cb(ie->func, ie->data))
2010-09-29 23:09:20 -07:00
{
if (!ie->delete_me) _ecore_idle_exiter_del(ie);
2010-09-29 23:09:20 -07:00
}
ie->references--;
}
if (idle_exiter_current) /* may have changed in recursive main loops */
idle_exiter_current =
(Ecore_Idle_Exiter *)EINA_INLIST_GET(idle_exiter_current)->next;
2004-03-16 21:44:17 -08:00
}
if (idle_exiters_delete_me)
{
2010-09-29 23:09:20 -07:00
Ecore_Idle_Exiter *l;
int deleted_idler_exiters_in_use = 0;
for (l = idle_exiters; l; )
2010-09-29 23:09:20 -07:00
{
Ecore_Idle_Exiter *ie = l;
l = (Ecore_Idle_Exiter *)EINA_INLIST_GET(l)->next;
2010-09-29 23:09:20 -07:00
if (ie->delete_me)
{
if (ie->references)
{
deleted_idler_exiters_in_use++;
continue;
}
idle_exiters = (Ecore_Idle_Exiter *)eina_inlist_remove(EINA_INLIST_GET(idle_exiters), EINA_INLIST_GET(ie));
2010-09-29 23:09:20 -07:00
ECORE_MAGIC_SET(ie, ECORE_MAGIC_NONE);
2011-12-02 19:39:07 -08:00
ecore_idle_exiter_mp_free(ie);
2010-09-29 23:09:20 -07:00
}
}
if (!deleted_idler_exiters_in_use)
idle_exiters_delete_me = 0;
2004-03-16 21:44:17 -08:00
}
}
int
_ecore_idle_exiter_exist(void)
{
if (idle_exiters) return 1;
return 0;
}