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   /* this is a race condition; under some circumstances we might not get 10
 183    * 100ms runs in 1050 ms, so consider 9 as "close enough" */
 184   g_assert_cmpint (a, >=, 9);
 185   g_assert_cmpint (a, <=, 10);
 186   g_assert_cmpint (b, ==, 4);
 187   g_assert_cmpint (c, ==, 3);
 188
 189   g_main_loop_unref (loop);
 190   g_main_context_unref (ctx);
 191 }
 192
 193 static void
 194 test_priorities (void)
 195 {
 196   GMainContext *ctx;
 197   GSource *sourcea;
 198   GSource *sourceb;
 199
 200   a = b = c = 0;
 201
 202   ctx = g_main_context_new ();
 203
 204   sourcea = g_idle_source_new ();
 205   g_source_set_callback (sourcea, count_calls, &a, NULL);
 206   g_source_set_priority (sourcea, 1);
 207   g_source_attach (sourcea, ctx);
 208   g_source_unref (sourcea);
 209
 210   sourceb = g_idle_source_new ();
 211   g_source_set_callback (sourceb, count_calls, &b, NULL);
 212   g_source_set_priority (sourceb, 0);
 213   g_source_attach (sourceb, ctx);
 214   g_source_unref (sourceb);
 215
 216   g_assert (g_main_context_pending (ctx));
 217   g_assert (g_main_context_iteration (ctx, FALSE));
 218   g_assert_cmpint (a, ==, 0);
 219   g_assert_cmpint (b, ==, 1);
 220
 221   g_assert (g_main_context_iteration (ctx, FALSE));
 222   g_assert_cmpint (a, ==, 0);
 223   g_assert_cmpint (b, ==, 2);
 224
 225   g_source_destroy (sourceb);
 226
 227   g_assert (g_main_context_iteration (ctx, FALSE));
 228   g_assert_cmpint (a, ==, 1);
 229   g_assert_cmpint (b, ==, 2);
 230
 231   g_assert (g_main_context_pending (ctx));
 232   g_source_destroy (sourcea);
 233   g_assert (!g_main_context_pending (ctx));
 234
 235   g_main_context_unref (ctx);
 236 }
 237
 238 static gint count;
 239
 240 static gboolean
 241 func (gpointer data)
 242 {
 243   if (data != NULL)
 244     g_assert (data == g_thread_self ());
 245
 246   count++;
 247
 248   return FALSE;
 249 }
 250
 251 static gboolean
 252 call_func (gpointer data)
 253 {
 254   func (g_thread_self ());
 255
 256   return G_SOURCE_REMOVE;
 257 }
 258
 259 static GMutex mutex;
 260 static GCond cond;
 261 static gboolean thread_ready;
 262
 263 static gpointer
 264 thread_func (gpointer data)
 265 {
 266   GMainContext *ctx = data;
 267   GSource *source;
 268
 269   g_main_context_push_thread_default (ctx);
 270
 271   g_mutex_lock (&mutex);
 272   thread_ready = TRUE;
 273   g_cond_signal (&cond);
 274   g_mutex_unlock (&mutex);
 275
 276   source = g_timeout_source_new (500);
 277   g_source_set_callback (source, (GSourceFunc)g_thread_exit, NULL, NULL);
 278   g_source_attach (source, ctx);
 279   g_source_unref (source);
 280
 281   while (TRUE)
 282     g_main_context_iteration (ctx, TRUE);
 283
 284   return NULL;
 285 }
 286
 287 static void
 288 test_invoke (void)
 289 {
 290   GMainContext *ctx;
 291   GThread *thread;
 292
 293   count = 0;
 294
 295   /* this one gets invoked directly */
 296   g_main_context_invoke (NULL, func, g_thread_self ());
 297   g_assert_cmpint (count, ==, 1);
 298
 299   /* invoking out of an idle works too */
 300   g_idle_add (call_func, NULL);
 301   g_main_context_iteration (g_main_context_default (), FALSE);
 302   g_assert_cmpint (count, ==, 2);
 303
 304   /* test thread-default forcing the invocation to go
 305    * to another thread
 306    */
 307   ctx = g_main_context_new ();
 308   thread = g_thread_new ("worker", thread_func, ctx);
 309
 310   g_mutex_lock (&mutex);
 311   while (!thread_ready)
 312     g_cond_wait (&cond, &mutex);
 313   g_mutex_unlock (&mutex);
 314
 315   g_main_context_invoke (ctx, func, thread);
 316
 317   g_thread_join (thread);
 318   g_assert_cmpint (count, ==, 3);
 319 }
 320
 321 static gboolean
 322 quit_loop (gpointer data)
 323 {
 324   GMainLoop *loop = data;
 325
 326   g_main_loop_quit (loop);
 327
 328   return G_SOURCE_REMOVE;
 329 }
 330
 331 static gboolean
 332 run_inner_loop (gpointer user_data)
 333 {
 334   GMainContext *ctx = user_data;
 335   GMainLoop *inner;
 336   GSource *timeout;
 337
 338   a++;
 339
 340   inner = g_main_loop_new (ctx, FALSE);
 341   timeout = g_timeout_source_new (100);
 342   g_source_set_callback (timeout, quit_loop, inner, NULL);
 343   g_source_attach (timeout, ctx);
 344
 345   g_main_loop_run (inner);
 346   g_main_loop_unref (inner);
 347
 348   return G_SOURCE_CONTINUE;
 349 }
 350
 351 static void
 352 test_child_sources (void)
 353 {
 354   GMainContext *ctx;
 355   GMainLoop *loop;
 356   GSource *parent, *child_b, *child_c, *end;
 357
 358   ctx = g_main_context_new ();
 359   loop = g_main_loop_new (ctx, FALSE);
 360
 361   a = b = c = 0;
 362
 363   parent = g_timeout_source_new (2000);
 364   g_source_set_callback (parent, run_inner_loop, ctx, NULL);
 365   g_source_set_priority (parent, G_PRIORITY_LOW);
 366   g_source_attach (parent, ctx);
 367
 368   child_b = g_timeout_source_new (250);
 369   g_source_set_callback (child_b, count_calls, &b, NULL);
 370   g_source_add_child_source (parent, child_b);
 371
 372   child_c = g_timeout_source_new (330);
 373   g_source_set_callback (child_c, count_calls, &c, NULL);
 374   g_source_set_priority (child_c, G_PRIORITY_HIGH);
 375   g_source_add_child_source (parent, child_c);
 376
 377   /* Child sources always have the priority of the parent */
 378   g_assert_cmpint (g_source_get_priority (parent), ==, G_PRIORITY_LOW);
 379   g_assert_cmpint (g_source_get_priority (child_b), ==, G_PRIORITY_LOW);
 380   g_assert_cmpint (g_source_get_priority (child_c), ==, G_PRIORITY_LOW);
 381   g_source_set_priority (parent, G_PRIORITY_DEFAULT);
 382   g_assert_cmpint (g_source_get_priority (parent), ==, G_PRIORITY_DEFAULT);
 383   g_assert_cmpint (g_source_get_priority (child_b), ==, G_PRIORITY_DEFAULT);
 384   g_assert_cmpint (g_source_get_priority (child_c), ==, G_PRIORITY_DEFAULT);
 385
 386   end = g_timeout_source_new (1050);
 387   g_source_set_callback (end, quit_loop, loop, NULL);
 388   g_source_attach (end, ctx);
 389   g_source_unref (end);
 390
 391   g_main_loop_run (loop);
 392
 393   /* The parent source's own timeout will never trigger, so "a" will
 394    * only get incremented when "b" or "c" does. And when timeouts get
 395    * blocked, they still wait the full interval next time rather than
 396    * "catching up". So the timing is:
 397    *
 398    *  250 - b++ -> a++, run_inner_loop
 399    *  330 - (c is blocked)
 400    *  350 - inner_loop ends
 401    *  350 - c++ belatedly -> a++, run_inner_loop
 402    *  450 - inner loop ends
 403    *  500 - b++ -> a++, run_inner_loop
 404    *  600 - inner_loop ends
 405    *  680 - c++ -> a++, run_inner_loop
 406    *  750 - (b is blocked)
 407    *  780 - inner loop ends
 408    *  780 - b++ belatedly -> a++, run_inner_loop
 409    *  880 - inner loop ends
 410    * 1010 - c++ -> a++, run_inner_loop
 411    * 1030 - (b is blocked)
 412    * 1050 - end runs, quits outer loop, which has no effect yet
 413    * 1110 - inner loop ends, a returns, outer loop exits
 414    */
 415
 416   g_assert_cmpint (a, ==, 6);
 417   g_assert_cmpint (b, ==, 3);
 418   g_assert_cmpint (c, ==, 3);
 419
 420   g_source_unref (parent);
 421   g_source_unref (child_b);
 422   g_source_unref (child_c);
 423
 424   g_main_loop_unref (loop);
 425   g_main_context_unref (ctx);
 426 }
 427
 428 static void
 429 test_recursive_child_sources (void)
 430 {
 431   GMainContext *ctx;
 432   GMainLoop *loop;
 433   GSource *parent, *child_b, *child_c, *end;
 434
 435   ctx = g_main_context_new ();
 436   loop = g_main_loop_new (ctx, FALSE);
 437
 438   a = b = c = 0;
 439
 440   parent = g_timeout_source_new (500);
 441   g_source_set_callback (parent, count_calls, &a, NULL);
 442
 443   child_b = g_timeout_source_new (220);
 444   g_source_set_callback (child_b, count_calls, &b, NULL);
 445   g_source_add_child_source (parent, child_b);
 446
 447   child_c = g_timeout_source_new (430);
 448   g_source_set_callback (child_c, count_calls, &c, NULL);
 449   g_source_add_child_source (child_b, child_c);
 450
 451   g_source_attach (parent, ctx);
 452
 453   end = g_timeout_source_new (2010);
 454   g_source_set_callback (end, (GSourceFunc)g_main_loop_quit, loop, NULL);
 455   g_source_attach (end, ctx);
 456   g_source_unref (end);
 457
 458   g_main_loop_run (loop);
 459
 460   /* Sequence of events:
 461    * 220 b (b = 440, a = 720)
 462    * 430 c (c = 860, b = 650, a = 930)
 463    * 650 b (b = 870, a = 1150)
 464    * 860 c (c = 1290, b = 1080, a = 1360)
 465    * 1080 b (b = 1300, a = 1580)
 466    * 1290 c (c = 1720, b = 1510, a = 1790)
 467    * 1510 b (b = 1730, a = 2010)
 468    * 1720 c (c = 2150, b = 1940, a = 2220)
 469    * 1940 b (b = 2160, a = 2440)
 470    */
 471
 472   g_assert_cmpint (a, ==, 9);
 473   g_assert_cmpint (b, ==, 9);
 474   g_assert_cmpint (c, ==, 4);
 475
 476   g_source_unref (parent);
 477   g_source_unref (child_b);
 478   g_source_unref (child_c);
 479
 480   g_main_loop_unref (loop);
 481   g_main_context_unref (ctx);
 482 }
 483
 484 typedef struct {
 485   GSource *parent, *old_child, *new_child;
 486   GMainLoop *loop;
 487 } SwappingTestData;
 488
 489 static gboolean
 490 swap_sources (gpointer user_data)
 491 {
 492   SwappingTestData *data = user_data;
 493
 494   if (data->old_child)
 495     {
 496       g_source_remove_child_source (data->parent, data->old_child);
 497       g_clear_pointer (&data->old_child, g_source_unref);
 498     }
 499
 500   if (!data->new_child)
 501     {
 502       data->new_child = g_timeout_source_new (0);
 503       g_source_set_callback (data->new_child, quit_loop, data->loop, NULL);
 504       g_source_add_child_source (data->parent, data->new_child);
 505     }
 506
 507   return G_SOURCE_CONTINUE;
 508 }
 509
 510 static gboolean
 511 assert_not_reached_callback (gpointer user_data)
 512 {
 513   g_assert_not_reached ();
 514
 515   return G_SOURCE_REMOVE;
 516 }
 517
 518 static void
 519 test_swapping_child_sources (void)
 520 {
 521   GMainContext *ctx;
 522   GMainLoop *loop;
 523   SwappingTestData data;
 524
 525   ctx = g_main_context_new ();
 526   loop = g_main_loop_new (ctx, FALSE);
 527
 528   data.parent = g_timeout_source_new (50);
 529   data.loop = loop;
 530   g_source_set_callback (data.parent, swap_sources, &data, NULL);
 531   g_source_attach (data.parent, ctx);
 532
 533   data.old_child = g_timeout_source_new (100);
 534   g_source_add_child_source (data.parent, data.old_child);
 535   g_source_set_callback (data.old_child, assert_not_reached_callback, NULL, NULL);
 536
 537   data.new_child = NULL;
 538   g_main_loop_run (loop);
 539
 540   g_source_destroy (data.parent);
 541   g_source_unref (data.parent);
 542   g_source_unref (data.new_child);
 543
 544   g_main_loop_unref (loop);
 545   g_main_context_unref (ctx);
 546 }
 547
 548 int
 549 main (int argc, char *argv[])
 550 {
 551   g_test_init (&argc, &argv, NULL);
 552
 553   g_test_add_func ("/maincontext/basic", test_maincontext_basic);
 554   g_test_add_func ("/mainloop/basic", test_mainloop_basic);
 555   g_test_add_func ("/mainloop/timeouts", test_timeouts);
 556   g_test_add_func ("/mainloop/priorities", test_priorities);
 557   g_test_add_func ("/mainloop/invoke", test_invoke);
 558   g_test_add_func ("/mainloop/child_sources", test_child_sources);
 559   g_test_add_func ("/mainloop/recursive_child_sources", test_recursive_child_sources);
 560   g_test_add_func ("/mainloop/swapping_child_sources", test_swapping_child_sources);
 561
 562   return g_test_run ();
 563 }