gobject/tests/threadtests.c

   1 /* GLib testing framework examples and tests
   2  * Copyright (C) 2008 Imendio AB
   3  * Authors: Tim Janik
   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 #define GLIB_DISABLE_DEPRECATION_WARNINGS
  23 #include <glib.h>
  24 #include <glib-object.h>
  25
  26 static volatile int mtsafe_call_counter = 0; /* multi thread safe call counter */
  27 static int          unsafe_call_counter = 0; /* single-threaded call counter */
  28
  29 #define NUM_COUNTER_INCREMENTS 100000
  30
  31 static void
  32 call_counter_init (gpointer tclass)
  33 {
  34   int i;
  35   for (i = 0; i < NUM_COUNTER_INCREMENTS; i++)
  36     {
  37       int saved_unsafe_call_counter = unsafe_call_counter;
  38       g_atomic_int_add (&mtsafe_call_counter, 1); /* real call count update */
  39       g_thread_yield(); /* let concurrent threads corrupt the unsafe_call_counter state */
  40       unsafe_call_counter = 1 + saved_unsafe_call_counter; /* non-atomic counter update */
  41     }
  42 }
  43
  44 static void interface_per_class_init () { call_counter_init (NULL); }
  45
  46 /* define 3 test interfaces */
  47 typedef GTypeInterface MyFace0Interface;
  48 G_DEFINE_INTERFACE (MyFace0, my_face0, G_TYPE_OBJECT);
  49 static void my_face0_default_init (MyFace0Interface *iface) { call_counter_init (iface); }
  50 typedef GTypeInterface MyFace1Interface;
  51 G_DEFINE_INTERFACE (MyFace1, my_face1, G_TYPE_OBJECT);
  52 static void my_face1_default_init (MyFace1Interface *iface) { call_counter_init (iface); }
  53 typedef GTypeInterface MyFace2Interface;
  54 G_DEFINE_INTERFACE (MyFace2, my_face2, G_TYPE_OBJECT);
  55 static void my_face2_default_init (MyFace2Interface *iface) { call_counter_init (iface); }
  56
  57 /* define 3 test objects, adding interfaces 0 & 1, and adding interface 2 after class initialization */
  58 typedef GObject         MyTester0;
  59 typedef GObjectClass    MyTester0Class;
  60 G_DEFINE_TYPE_WITH_CODE (MyTester0, my_tester0, G_TYPE_OBJECT,
  61                          G_IMPLEMENT_INTERFACE (my_face0_get_type(), interface_per_class_init);
  62                          G_IMPLEMENT_INTERFACE (my_face1_get_type(), interface_per_class_init);
  63                          );
  64 static void my_tester0_init (MyTester0*t) {}
  65 static void my_tester0_class_init (MyTester0Class*c) { call_counter_init (c); }
  66 typedef GObject         MyTester1;
  67 typedef GObjectClass    MyTester1Class;
  68 G_DEFINE_TYPE_WITH_CODE (MyTester1, my_tester1, G_TYPE_OBJECT,
  69                          G_IMPLEMENT_INTERFACE (my_face0_get_type(), interface_per_class_init);
  70                          G_IMPLEMENT_INTERFACE (my_face1_get_type(), interface_per_class_init);
  71                          );
  72 static void my_tester1_init (MyTester1*t) {}
  73 static void my_tester1_class_init (MyTester1Class*c) { call_counter_init (c); }
  74 typedef GObject         MyTester2;
  75 typedef GObjectClass    MyTester2Class;
  76 G_DEFINE_TYPE_WITH_CODE (MyTester2, my_tester2, G_TYPE_OBJECT,
  77                          G_IMPLEMENT_INTERFACE (my_face0_get_type(), interface_per_class_init);
  78                          G_IMPLEMENT_INTERFACE (my_face1_get_type(), interface_per_class_init);
  79                          );
  80 static void my_tester2_init (MyTester2*t) {}
  81 static void my_tester2_class_init (MyTester2Class*c) { call_counter_init (c); }
  82
  83 static GCond sync_cond;
  84 static GMutex sync_mutex;
  85
  86 static gpointer
  87 tester_init_thread (gpointer data)
  88 {
  89   const GInterfaceInfo face2_interface_info = { (GInterfaceInitFunc) interface_per_class_init, NULL, NULL };
  90   gpointer klass;
  91   /* first, syncronize with other threads,
  92    * then run interface and class initializers,
  93    * using unsafe_call_counter concurrently
  94    */
  95   g_mutex_lock (&sync_mutex);
  96   g_mutex_unlock (&sync_mutex);
  97   /* test default interface initialization for face0 */
  98   g_type_default_interface_unref (g_type_default_interface_ref (my_face0_get_type()));
  99   /* test class initialization, face0 per-class initializer, face1 default and per-class initializer */
 100   klass = g_type_class_ref ((GType) data);
 101   /* test face2 default and per-class initializer, after class_init */
 102   g_type_add_interface_static (G_TYPE_FROM_CLASS (klass), my_face2_get_type(), &face2_interface_info);
 103   /* cleanups */
 104   g_type_class_unref (klass);
 105   return NULL;
 106 }
 107
 108 static void
 109 test_threaded_class_init (void)
 110 {
 111   /* pause newly created threads */
 112   g_mutex_lock (&sync_mutex);
 113   /* create threads */
 114   g_thread_create (tester_init_thread, (gpointer) my_tester0_get_type(), TRUE, NULL);
 115   g_thread_create (tester_init_thread, (gpointer) my_tester1_get_type(), TRUE, NULL);
 116   g_thread_create (tester_init_thread, (gpointer) my_tester2_get_type(), TRUE, NULL);
 117   /* execute threads */
 118   g_mutex_unlock (&sync_mutex);
 119   while (g_atomic_int_get (&mtsafe_call_counter) < (3 + 3 + 3 * 3) * NUM_COUNTER_INCREMENTS)
 120     {
 121       if (g_test_verbose())
 122         g_print ("Initializers counted: %u\n", g_atomic_int_get (&mtsafe_call_counter));
 123       g_usleep (50 * 1000); /* wait for threads to complete */
 124     }
 125   if (g_test_verbose())
 126     g_print ("Total initializers: %u\n", g_atomic_int_get (&mtsafe_call_counter));
 127   /* ensure non-corrupted counter updates */
 128   g_assert_cmpint (g_atomic_int_get (&mtsafe_call_counter), ==, unsafe_call_counter);
 129 }
 130
 131 typedef struct {
 132   GObject parent;
 133   char   *name;
 134 } PropTester;
 135 typedef GObjectClass    PropTesterClass;
 136 G_DEFINE_TYPE (PropTester, prop_tester, G_TYPE_OBJECT);
 137 #define PROP_NAME 1
 138 static void
 139 prop_tester_init (PropTester* t)
 140 {
 141   if (t->name == NULL)
 142     ; /* neds unit test framework initialization: g_test_bug ("race initializing properties"); */
 143 }
 144 static void
 145 prop_tester_set_property (GObject        *object,
 146                           guint           property_id,
 147                           const GValue   *value,
 148                           GParamSpec     *pspec)
 149 {}
 150 static void
 151 prop_tester_class_init (PropTesterClass *c)
 152 {
 153   int i;
 154   GParamSpec *param;
 155   GObjectClass *gobject_class = G_OBJECT_CLASS (c);
 156
 157   gobject_class->set_property = prop_tester_set_property; /* silence GObject checks */
 158
 159   g_mutex_lock (&sync_mutex);
 160   g_cond_signal (&sync_cond);
 161   g_mutex_unlock (&sync_mutex);
 162
 163   for (i = 0; i < 100; i++) /* wait a bit. */
 164     g_thread_yield();
 165
 166   call_counter_init (c);
 167   param = g_param_spec_string ("name", "name_i18n",
 168                                "yet-more-wasteful-i18n",
 169                                NULL,
 170                                G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE |
 171                                G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB |
 172                                G_PARAM_STATIC_NICK);
 173   g_object_class_install_property (gobject_class, PROP_NAME, param);
 174 }
 175
 176 static gpointer
 177 object_create (gpointer data)
 178 {
 179   GObject *obj = g_object_new (prop_tester_get_type(), "name", "fish", NULL);
 180   g_object_unref (obj);
 181   return NULL;
 182 }
 183
 184 static void
 185 test_threaded_object_init (void)
 186 {
 187   GThread *creator;
 188   g_mutex_lock (&sync_mutex);
 189
 190   creator = g_thread_create (object_create, NULL, TRUE, NULL);
 191   /* really provoke the race */
 192   g_cond_wait (&sync_cond, &sync_mutex);
 193
 194   object_create (NULL);
 195   g_mutex_unlock (&sync_mutex);
 196
 197   g_thread_join (creator);
 198 }
 199
 200 int
 201 main (int   argc,
 202       char *argv[])
 203 {
 204   g_test_init (&argc, &argv, NULL);
 205   g_type_init ();
 206
 207   g_test_add_func ("/GObject/threaded-class-init", test_threaded_class_init);
 208   g_test_add_func ("/GObject/threaded-object-init", test_threaded_object_init);
 209
 210   return g_test_run();
 211 }