glib/tests/mainloop.c

   1 /* Unit tests for GMainLoop
   2  * Copyright (C) 2011 Red Hat, Inc
   3  * Author: Matthias Clasen
   4  *
   5  * This work is provided "as is"; redistribution and modification
   6  * in whole or in part, in any medium, physical or electronic is
   7  * permitted without restriction.
   8  *
   9  * This work is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12  *
  13  * In no event shall the authors or contributors be liable for any
  14  * direct, indirect, incidental, special, exemplary, or consequential
  15  * damages (including, but not limited to, procurement of substitute
  16  * goods or services; loss of use, data, or profits; or business
  17  * interruption) however caused and on any theory of liability, whether
  18  * in contract, strict liability, or tort (including negligence or
  19  * otherwise) arising in any way out of the use of this software, even
  20  * if advised of the possibility of such damage.
  21  */
  22
  23 #include <glib.h>
  24
  25 static gboolean cb (gpointer data)
  26 {
  27   return FALSE;
  28 }
  29
  30 static gboolean prepare (GSource *source, gint *time)
  31 {
  32   return FALSE;
  33 }
  34 static gboolean check (GSource *source)
  35 {
  36   return FALSE;
  37 }
  38 static gboolean dispatch (GSource *source, GSourceFunc cb, gpointer date)
  39 {
  40   return FALSE;
  41 }
  42
  43 GSourceFuncs funcs = {
  44   prepare,
  45   check,
  46   dispatch,
  47   NULL
  48 };
  49
  50 static void
  51 test_maincontext_basic (void)
  52 {
  53   GMainContext *ctx;
  54   GSource *source;
  55   guint id;
  56   gpointer data = &funcs;
  57
  58   ctx = g_main_context_new ();
  59
  60   g_assert (!g_main_context_pending (ctx));
  61   g_assert (!g_main_context_iteration (ctx, FALSE));
  62
  63   source = g_source_new (&funcs, sizeof (GSource));
  64   g_assert_cmpint (g_source_get_priority (source), ==, G_PRIORITY_DEFAULT);
  65   g_assert (!g_source_is_destroyed (source));
  66
  67   g_assert (!g_source_get_can_recurse (source));
  68   g_assert (g_source_get_name (source) == NULL);
  69
  70   g_source_set_can_recurse (source, TRUE);
  71   g_source_set_name (source, "d");
  72
  73   g_assert (g_source_get_can_recurse (source));
  74   g_assert_cmpstr (g_source_get_name (source), ==, "d");
  75
  76   g_assert (g_main_context_find_source_by_user_data (ctx, NULL) == NULL);
  77   g_assert (g_main_context_find_source_by_funcs_user_data (ctx, &funcs, NULL) == NULL);
  78
  79   id = g_source_attach (source, ctx);
  80   g_source_unref (source);
  81   g_assert_cmpint (g_source_get_id (source), ==, id);
  82   g_assert (g_main_context_find_source_by_id (ctx, id) == source);
  83
  84   g_source_set_priority (source, G_PRIORITY_HIGH);
  85   g_assert_cmpint (g_source_get_priority (source), ==, G_PRIORITY_HIGH);
  86
  87   g_source_destroy (source);
  88   g_main_context_unref (ctx);
  89
  90   ctx = g_main_context_default ();
  91   source = g_source_new (&funcs, sizeof (GSource));
  92   g_source_set_funcs (source, &funcs);
  93   g_source_set_callback (source, cb, data, NULL);
  94   id = g_source_attach (source, ctx);
  95   g_source_unref (source);
  96   g_source_set_name_by_id (id, "e");
  97   g_assert_cmpstr (g_source_get_name (source), ==, "e");
  98   g_assert (g_source_get_context (source) == ctx);
  99   g_assert (g_source_remove_by_funcs_user_data (&funcs, data));
 100
 101   source = g_source_new (&funcs, sizeof (GSource));
 102   g_source_set_funcs (source, &funcs);
 103   g_source_set_callback (source, cb, data, NULL);
 104   id = g_source_attach (source, ctx);
 105   g_source_unref (source);
 106   g_assert (g_source_remove_by_user_data (data));
 107
 108   g_idle_add (cb, data);
 109   g_assert (g_idle_remove_by_data (data));
 110 }
 111
 112 static void
 113 test_mainloop_basic (void)
 114 {
 115   GMainLoop *loop;
 116   GMainContext *ctx;
 117
 118   loop = g_main_loop_new (NULL, FALSE);
 119
 120   g_assert (!g_main_loop_is_running (loop));
 121
 122   g_main_loop_ref (loop);
 123
 124   ctx = g_main_loop_get_context (loop);
 125   g_assert (ctx == g_main_context_default ());
 126
 127   g_main_loop_unref (loop);
 128
 129   g_assert_cmpint (g_main_depth (), ==, 0);
 130
 131   g_main_loop_unref (loop);
 132 }
 133
 134 static gint a;
 135 static gint b;
 136 static gint c;
 137
 138 static gboolean
 139 count_calls (gpointer data)
 140 {
 141   gint *i = data;
 142
 143   (*i)++;
 144
 145   return TRUE;
 146 }
 147
 148 static void
 149 test_timeouts (void)
 150 {
 151   GMainContext *ctx;
 152   GMainLoop *loop;
 153   GSource *source;
 154
 155   a = b = c = 0;
 156
 157   ctx = g_main_context_new ();
 158   loop = g_main_loop_new (ctx, FALSE);
 159
 160   source = g_timeout_source_new (100);
 161   g_source_set_callback (source, count_calls, &a, NULL);
 162   g_source_attach (source, ctx);
 163   g_source_unref (source);
 164
 165   source = g_timeout_source_new (250);
 166   g_source_set_callback (source, count_calls, &b, NULL);
 167   g_source_attach (source, ctx);
 168   g_source_unref (source);
 169
 170   source = g_timeout_source_new (330);
 171   g_source_set_callback (source, count_calls, &c, NULL);
 172   g_source_attach (source, ctx);
 173   g_source_unref (source);
 174
 175   source = g_timeout_source_new (1050);
 176   g_source_set_callback (source, (GSourceFunc)g_main_loop_quit, loop, NULL);
 177   g_source_attach (source, ctx);
 178   g_source_unref (source);
 179
 180   g_main_loop_run (loop);
 181
 182   g_assert_cmpint (a, ==, 10);
 183   g_assert_cmpint (b, ==, 4);
 184   g_assert_cmpint (c, ==, 3);
 185
 186   g_main_loop_unref (loop);
 187   g_main_context_unref (ctx);
 188 }
 189
 190 static void
 191 test_priorities (void)
 192 {
 193   GMainContext *ctx;
 194   GSource *sourcea;
 195   GSource *sourceb;
 196
 197   a = b = c = 0;
 198
 199   ctx = g_main_context_new ();
 200
 201   sourcea = g_idle_source_new ();
 202   g_source_set_callback (sourcea, count_calls, &a, NULL);
 203   g_source_set_priority (sourcea, 1);
 204   g_source_attach (sourcea, ctx);
 205   g_source_unref (sourcea);
 206
 207   sourceb = g_idle_source_new ();
 208   g_source_set_callback (sourceb, count_calls, &b, NULL);
 209   g_source_set_priority (sourceb, 0);
 210   g_source_attach (sourceb, ctx);
 211   g_source_unref (sourceb);
 212
 213   g_assert (g_main_context_pending (ctx));
 214   g_assert (g_main_context_iteration (ctx, FALSE));
 215   g_assert_cmpint (a, ==, 0);
 216   g_assert_cmpint (b, ==, 1);
 217
 218   g_assert (g_main_context_iteration (ctx, FALSE));
 219   g_assert_cmpint (a, ==, 0);
 220   g_assert_cmpint (b, ==, 2);
 221
 222   g_source_destroy (sourceb);
 223
 224   g_assert (g_main_context_iteration (ctx, FALSE));
 225   g_assert_cmpint (a, ==, 1);
 226   g_assert_cmpint (b, ==, 2);
 227
 228   g_assert (g_main_context_pending (ctx));
 229   g_source_destroy (sourcea);
 230   g_assert (!g_main_context_pending (ctx));
 231
 232   g_main_context_unref (ctx);
 233 }
 234
 235 static gint count;
 236
 237 static gboolean
 238 func (gpointer data)
 239 {
 240   if (data != NULL)
 241     g_assert (data == g_thread_self ());
 242
 243   count++;
 244
 245   return FALSE;
 246 }
 247
 248 static gboolean
 249 call_func (gpointer data)
 250 {
 251   func (g_thread_self ());
 252
 253   return G_SOURCE_REMOVE;
 254 }
 255
 256 static GMutex mutex;
 257 static GCond cond;
 258 static gboolean thread_ready;
 259
 260 static gpointer
 261 thread_func (gpointer data)
 262 {
 263   GMainContext *ctx = data;
 264   GSource *source;
 265
 266   g_main_context_push_thread_default (ctx);
 267
 268   g_mutex_lock (&mutex);
 269   thread_ready = TRUE;
 270   g_cond_signal (&cond);
 271   g_mutex_unlock (&mutex);
 272
 273   source = g_timeout_source_new (500);
 274   g_source_set_callback (source, (GSourceFunc)g_thread_exit, NULL, NULL);
 275   g_source_attach (source, ctx);
 276   g_source_unref (source);
 277
 278   while (TRUE)
 279     g_main_context_iteration (ctx, TRUE);
 280
 281   return NULL;
 282 }
 283
 284 static void
 285 test_invoke (void)
 286 {
 287   GMainContext *ctx;
 288   GThread *thread;
 289
 290   count = 0;
 291
 292   /* this one gets invoked directly */
 293   g_main_context_invoke (NULL, func, g_thread_self ());
 294   g_assert_cmpint (count, ==, 1);
 295
 296   /* invoking out of an idle works too */
 297   g_idle_add (call_func, NULL);
 298   g_main_context_iteration (g_main_context_default (), FALSE);
 299   g_assert_cmpint (count, ==, 2);
 300
 301   /* test thread-default forcing the invocation to go
 302    * to another thread
 303    */
 304   ctx = g_main_context_new ();
 305   thread = g_thread_new ("worker", thread_func, ctx);
 306
 307   g_mutex_lock (&mutex);
 308   while (!thread_ready)
 309     g_cond_wait (&cond, &mutex);
 310   g_mutex_unlock (&mutex);
 311
 312   g_main_context_invoke (ctx, func, thread);
 313
 314   g_thread_join (thread);
 315   g_assert_cmpint (count, ==, 3);
 316 }
 317
 318 static gboolean
 319 quit_loop (gpointer data)
 320 {
 321   GMainLoop *loop = data;
 322
 323   g_main_loop_quit (loop);
 324
 325   return G_SOURCE_REMOVE;
 326 }
 327
 328 static gboolean
 329 run_inner_loop (gpointer user_data)
 330 {
 331   GMainContext *ctx = user_data;
 332   GMainLoop *inner;
 333   GSource *timeout;
 334
 335   a++;
 336
 337   inner = g_main_loop_new (ctx, FALSE);
 338   timeout = g_timeout_source_new (100);
 339   g_source_set_callback (timeout, quit_loop, inner, NULL);
 340   g_source_attach (timeout, ctx);
 341
 342   g_main_loop_run (inner);
 343   g_main_loop_unref (inner);
 344
 345   return G_SOURCE_CONTINUE;
 346 }
 347
 348 static void
 349 test_child_sources (void)
 350 {
 351   GMainContext *ctx;
 352   GMainLoop *loop;
 353   GSource *parent, *child_b, *child_c, *end;
 354
 355   ctx = g_main_context_new ();
 356   loop = g_main_loop_new (ctx, FALSE);
 357
 358   a = b = c = 0;
 359
 360   parent = g_timeout_source_new (2000);
 361   g_source_set_callback (parent, run_inner_loop, ctx, NULL);
 362   g_source_set_priority (parent, G_PRIORITY_LOW);
 363   g_source_attach (parent, ctx);
 364
 365   child_b = g_timeout_source_new (250);
 366   g_source_set_callback (child_b, count_calls, &b, NULL);
 367   g_source_add_child_source (parent, child_b);
 368
 369   child_c = g_timeout_source_new (330);
 370   g_source_set_callback (child_c, count_calls, &c, NULL);
 371   g_source_set_priority (child_c, G_PRIORITY_HIGH);
 372   g_source_add_child_source (parent, child_c);
 373
 374   /* Child sources always have the priority of the parent */
 375   g_assert_cmpint (g_source_get_priority (parent), ==, G_PRIORITY_LOW);
 376   g_assert_cmpint (g_source_get_priority (child_b), ==, G_PRIORITY_LOW);
 377   g_assert_cmpint (g_source_get_priority (child_c), ==, G_PRIORITY_LOW);
 378   g_source_set_priority (parent, G_PRIORITY_DEFAULT);
 379   g_assert_cmpint (g_source_get_priority (parent), ==, G_PRIORITY_DEFAULT);
 380   g_assert_cmpint (g_source_get_priority (child_b), ==, G_PRIORITY_DEFAULT);
 381   g_assert_cmpint (g_source_get_priority (child_c), ==, G_PRIORITY_DEFAULT);
 382
 383   end = g_timeout_source_new (1050);
 384   g_source_set_callback (end, quit_loop, loop, NULL);
 385   g_source_attach (end, ctx);
 386   g_source_unref (end);
 387
 388   g_main_loop_run (loop);
 389
 390   /* The parent source's own timeout will never trigger, so "a" will
 391    * only get incremented when "b" or "c" does. And when timeouts get
 392    * blocked, they still wait the full interval next time rather than
 393    * "catching up". So the timing is:
 394    *
 395    *  250 - b++ -> a++, run_inner_loop
 396    *  330 - (c is blocked)
 397    *  350 - inner_loop ends
 398    *  350 - c++ belatedly -> a++, run_inner_loop
 399    *  450 - inner loop ends
 400    *  500 - b++ -> a++, run_inner_loop
 401    *  600 - inner_loop ends
 402    *  680 - c++ -> a++, run_inner_loop
 403    *  750 - (b is blocked)
 404    *  780 - inner loop ends
 405    *  780 - b++ belatedly -> a++, run_inner_loop
 406    *  880 - inner loop ends
 407    * 1010 - c++ -> a++, run_inner_loop
 408    * 1030 - (b is blocked)
 409    * 1050 - end runs, quits outer loop, which has no effect yet
 410    * 1110 - inner loop ends, a returns, outer loop exits
 411    */
 412
 413   g_assert_cmpint (a, ==, 6);
 414   g_assert_cmpint (b, ==, 3);
 415   g_assert_cmpint (c, ==, 3);
 416
 417   g_source_unref (parent);
 418   g_source_unref (child_b);
 419   g_source_unref (child_c);
 420
 421   g_main_loop_unref (loop);
 422   g_main_context_unref (ctx);
 423 }
 424
 425 static void
 426 test_recursive_child_sources (void)
 427 {
 428   GMainContext *ctx;
 429   GMainLoop *loop;
 430   GSource *parent, *child_b, *child_c, *end;
 431
 432   ctx = g_main_context_new ();
 433   loop = g_main_loop_new (ctx, FALSE);
 434
 435   a = b = c = 0;
 436
 437   parent = g_timeout_source_new (500);
 438   g_source_set_callback (parent, count_calls, &a, NULL);
 439
 440   child_b = g_timeout_source_new (220);
 441   g_source_set_callback (child_b, count_calls, &b, NULL);
 442   g_source_add_child_source (parent, child_b);
 443
 444   child_c = g_timeout_source_new (430);
 445   g_source_set_callback (child_c, count_calls, &c, NULL);
 446   g_source_add_child_source (child_b, child_c);
 447
 448   g_source_attach (parent, ctx);
 449
 450   end = g_timeout_source_new (2010);
 451   g_source_set_callback (end, (GSourceFunc)g_main_loop_quit, loop, NULL);
 452   g_source_attach (end, ctx);
 453   g_source_unref (end);
 454
 455   g_main_loop_run (loop);
 456
 457   /* Sequence of events:
 458    * 220 b (b = 440, a = 720)
 459    * 430 c (c = 860, b = 650, a = 930)
 460    * 650 b (b = 870, a = 1150)
 461    * 860 c (c = 1290, b = 1080, a = 1360)
 462    * 1080 b (b = 1300, a = 1580)
 463    * 1290 c (c = 1720, b = 1510, a = 1790)
 464    * 1510 b (b = 1730, a = 2010)
 465    * 1720 c (c = 2150, b = 1940, a = 2220)
 466    * 1940 b (b = 2160, a = 2440)
 467    */
 468
 469   g_assert_cmpint (a, ==, 9);
 470   g_assert_cmpint (b, ==, 9);
 471   g_assert_cmpint (c, ==, 4);
 472
 473   g_source_unref (parent);
 474   g_source_unref (child_b);
 475   g_source_unref (child_c);
 476
 477   g_main_loop_unref (loop);
 478   g_main_context_unref (ctx);
 479 }
 480
 481 int
 482 main (int argc, char *argv[])
 483 {
 484   g_test_init (&argc, &argv, NULL);
 485
 486   g_test_add_func ("/maincontext/basic", test_maincontext_basic);
 487   g_test_add_func ("/mainloop/basic", test_mainloop_basic);
 488   g_test_add_func ("/mainloop/timeouts", test_timeouts);
 489   g_test_add_func ("/mainloop/priorities", test_priorities);
 490   g_test_add_func ("/mainloop/invoke", test_invoke);
 491   g_test_add_func ("/mainloop/child_sources", test_child_sources);
 492   g_test_add_func ("/mainloop/recursive_child_sources", test_recursive_child_sources);
 493
 494   return g_test_run ();
 495 }