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 static GType my_face0_get_type (void);
  49 G_DEFINE_INTERFACE (MyFace0, my_face0, G_TYPE_OBJECT);
  50 static void my_face0_default_init (MyFace0Interface *iface) { call_counter_init (iface); }
  51 typedef GTypeInterface MyFace1Interface;
  52 static GType my_face1_get_type (void);
  53 G_DEFINE_INTERFACE (MyFace1, my_face1, G_TYPE_OBJECT);
  54 static void my_face1_default_init (MyFace1Interface *iface) { call_counter_init (iface); }
  55 typedef GTypeInterface MyFace2Interface;
  56 static GType my_face2_get_type (void);
  57 G_DEFINE_INTERFACE (MyFace2, my_face2, G_TYPE_OBJECT);
  58 static void my_face2_default_init (MyFace2Interface *iface) { call_counter_init (iface); }
  59
  60 /* define 3 test objects, adding interfaces 0 & 1, and adding interface 2 after class initialization */
  61 typedef GObject         MyTester0;
  62 typedef GObjectClass    MyTester0Class;
  63 static GType my_tester0_get_type (void);
  64 G_DEFINE_TYPE_WITH_CODE (MyTester0, my_tester0, G_TYPE_OBJECT,
  65                          G_IMPLEMENT_INTERFACE (my_face0_get_type(), interface_per_class_init);
  66                          G_IMPLEMENT_INTERFACE (my_face1_get_type(), interface_per_class_init);
  67                          );
  68 static void my_tester0_init (MyTester0*t) {}
  69 static void my_tester0_class_init (MyTester0Class*c) { call_counter_init (c); }
  70 typedef GObject         MyTester1;
  71 typedef GObjectClass    MyTester1Class;
  72 static GType my_tester1_get_type (void);
  73 G_DEFINE_TYPE_WITH_CODE (MyTester1, my_tester1, G_TYPE_OBJECT,
  74                          G_IMPLEMENT_INTERFACE (my_face0_get_type(), interface_per_class_init);
  75                          G_IMPLEMENT_INTERFACE (my_face1_get_type(), interface_per_class_init);
  76                          );
  77 static void my_tester1_init (MyTester1*t) {}
  78 static void my_tester1_class_init (MyTester1Class*c) { call_counter_init (c); }
  79 typedef GObject         MyTester2;
  80 typedef GObjectClass    MyTester2Class;
  81 static GType my_tester2_get_type (void);
  82 G_DEFINE_TYPE_WITH_CODE (MyTester2, my_tester2, G_TYPE_OBJECT,
  83                          G_IMPLEMENT_INTERFACE (my_face0_get_type(), interface_per_class_init);
  84                          G_IMPLEMENT_INTERFACE (my_face1_get_type(), interface_per_class_init);
  85                          );
  86 static void my_tester2_init (MyTester2*t) {}
  87 static void my_tester2_class_init (MyTester2Class*c) { call_counter_init (c); }
  88
  89 static GCond sync_cond;
  90 static GMutex sync_mutex;
  91
  92 static gpointer
  93 tester_init_thread (gpointer data)
  94 {
  95   const GInterfaceInfo face2_interface_info = { (GInterfaceInitFunc) interface_per_class_init, NULL, NULL };
  96   gpointer klass;
  97   /* first, syncronize with other threads,
  98    * then run interface and class initializers,
  99    * using unsafe_call_counter concurrently
 100    */
 101   g_mutex_lock (&sync_mutex);
 102   g_mutex_unlock (&sync_mutex);
 103   /* test default interface initialization for face0 */
 104   g_type_default_interface_unref (g_type_default_interface_ref (my_face0_get_type()));
 105   /* test class initialization, face0 per-class initializer, face1 default and per-class initializer */
 106   klass = g_type_class_ref ((GType) data);
 107   /* test face2 default and per-class initializer, after class_init */
 108   g_type_add_interface_static (G_TYPE_FROM_CLASS (klass), my_face2_get_type(), &face2_interface_info);
 109   /* cleanups */
 110   g_type_class_unref (klass);
 111   return NULL;
 112 }
 113
 114 static void
 115 test_threaded_class_init (void)
 116 {
 117   /* pause newly created threads */
 118   g_mutex_lock (&sync_mutex);
 119   /* create threads */
 120   g_thread_create (tester_init_thread, (gpointer) my_tester0_get_type(), TRUE, NULL);
 121   g_thread_create (tester_init_thread, (gpointer) my_tester1_get_type(), TRUE, NULL);
 122   g_thread_create (tester_init_thread, (gpointer) my_tester2_get_type(), TRUE, NULL);
 123   /* execute threads */
 124   g_mutex_unlock (&sync_mutex);
 125   while (g_atomic_int_get (&mtsafe_call_counter) < (3 + 3 + 3 * 3) * NUM_COUNTER_INCREMENTS)
 126     {
 127       if (g_test_verbose())
 128         g_print ("Initializers counted: %u\n", g_atomic_int_get (&mtsafe_call_counter));
 129       g_usleep (50 * 1000); /* wait for threads to complete */
 130     }
 131   if (g_test_verbose())
 132     g_print ("Total initializers: %u\n", g_atomic_int_get (&mtsafe_call_counter));
 133   /* ensure non-corrupted counter updates */
 134   g_assert_cmpint (g_atomic_int_get (&mtsafe_call_counter), ==, unsafe_call_counter);
 135 }
 136
 137 typedef struct {
 138   GObject parent;
 139   char   *name;
 140 } PropTester;
 141 typedef GObjectClass    PropTesterClass;
 142 static GType prop_tester_get_type (void);
 143 G_DEFINE_TYPE (PropTester, prop_tester, G_TYPE_OBJECT);
 144 #define PROP_NAME 1
 145 static void
 146 prop_tester_init (PropTester* t)
 147 {
 148   if (t->name == NULL)
 149     ; /* neds unit test framework initialization: g_test_bug ("race initializing properties"); */
 150 }
 151 static void
 152 prop_tester_set_property (GObject        *object,
 153                           guint           property_id,
 154                           const GValue   *value,
 155                           GParamSpec     *pspec)
 156 {}
 157 static void
 158 prop_tester_class_init (PropTesterClass *c)
 159 {
 160   int i;
 161   GParamSpec *param;
 162   GObjectClass *gobject_class = G_OBJECT_CLASS (c);
 163
 164   gobject_class->set_property = prop_tester_set_property; /* silence GObject checks */
 165
 166   g_mutex_lock (&sync_mutex);
 167   g_cond_signal (&sync_cond);
 168   g_mutex_unlock (&sync_mutex);
 169
 170   for (i = 0; i < 100; i++) /* wait a bit. */
 171     g_thread_yield();
 172
 173   call_counter_init (c);
 174   param = g_param_spec_string ("name", "name_i18n",
 175                                "yet-more-wasteful-i18n",
 176                                NULL,
 177                                G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE |
 178                                G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB |
 179                                G_PARAM_STATIC_NICK);
 180   g_object_class_install_property (gobject_class, PROP_NAME, param);
 181 }
 182
 183 static gpointer
 184 object_create (gpointer data)
 185 {
 186   GObject *obj = g_object_new (prop_tester_get_type(), "name", "fish", NULL);
 187   g_object_unref (obj);
 188   return NULL;
 189 }
 190
 191 static void
 192 test_threaded_object_init (void)
 193 {
 194   GThread *creator;
 195   g_mutex_lock (&sync_mutex);
 196
 197   creator = g_thread_create (object_create, NULL, TRUE, NULL);
 198   /* really provoke the race */
 199   g_cond_wait (&sync_cond, &sync_mutex);
 200
 201   object_create (NULL);
 202   g_mutex_unlock (&sync_mutex);
 203
 204   g_thread_join (creator);
 205 }
 206
 207 typedef struct {
 208     MyTester0 *strong;
 209     guint unref_delay;
 210 } UnrefInThreadData;
 211
 212 static gpointer
 213 unref_in_thread (gpointer p)
 214 {
 215   UnrefInThreadData *data = p;
 216
 217   g_usleep (data->unref_delay);
 218   g_object_unref (data->strong);
 219
 220   return NULL;
 221 }
 222
 223 /* undefine to see this test fail without GWeakRef */
 224 #define HAVE_G_WEAK_REF
 225
 226 #define SLEEP_MIN_USEC 1
 227 #define SLEEP_MAX_USEC 10
 228
 229 static void
 230 test_threaded_weak_ref (void)
 231 {
 232   guint i;
 233   guint get_wins = 0, unref_wins = 0;
 234   guint n;
 235
 236   if (g_test_thorough ())
 237     n = NUM_COUNTER_INCREMENTS;
 238   else
 239     n = NUM_COUNTER_INCREMENTS / 20;
 240
 241   for (i = 0; i < n; i++)
 242     {
 243       UnrefInThreadData data;
 244 #ifdef HAVE_G_WEAK_REF
 245       /* GWeakRef<MyTester0> in C++ terms */
 246       GWeakRef weak;
 247 #else
 248       gpointer weak;
 249 #endif
 250       MyTester0 *strengthened;
 251       guint get_delay;
 252       GThread *thread;
 253       GError *error = NULL;
 254
 255       if (g_test_verbose () && (i % (n/20)) == 0)
 256         g_print ("%u%%\n", ((i * 100) / n));
 257
 258       /* Have an object and a weak ref to it */
 259       data.strong = g_object_new (my_tester0_get_type (), NULL);
 260
 261 #ifdef HAVE_G_WEAK_REF
 262       g_weak_ref_init (&weak, data.strong);
 263 #else
 264       weak = data.strong;
 265       g_object_add_weak_pointer ((GObject *) weak, &weak);
 266 #endif
 267
 268       /* Delay for a random time on each side of the race, to perturb the
 269        * timing. Ideally, we want each side to win half the races; on
 270        * smcv's laptop, these timings are about right.
 271        */
 272       data.unref_delay = g_random_int_range (SLEEP_MIN_USEC / 2, SLEEP_MAX_USEC / 2);
 273       get_delay = g_random_int_range (SLEEP_MIN_USEC, SLEEP_MAX_USEC);
 274
 275       /* One half of the race is to unref the shared object */
 276       thread = g_thread_create (unref_in_thread, &data, TRUE, &error);
 277       g_assert_no_error (error);
 278
 279       /* The other half of the race is to get the object from the "global
 280        * singleton"
 281        */
 282       g_usleep (get_delay);
 283
 284 #ifdef HAVE_G_WEAK_REF
 285       strengthened = g_weak_ref_get (&weak);
 286 #else
 287       /* Spot the unsafe pointer access! In GDBusConnection this is rather
 288        * better-hidden, but ends up with essentially the same thing, albeit
 289        * cleared in dispose() rather than by a traditional weak pointer
 290        */
 291       strengthened = weak;
 292
 293       if (strengthened != NULL)
 294         g_object_ref (strengthened);
 295 #endif
 296
 297       if (strengthened != NULL)
 298         g_assert (G_IS_OBJECT (strengthened));
 299
 300       /* Wait for the thread to run */
 301       g_thread_join (thread);
 302
 303       if (strengthened != NULL)
 304         {
 305           get_wins++;
 306           g_assert (G_IS_OBJECT (strengthened));
 307           g_object_unref (strengthened);
 308         }
 309       else
 310         {
 311           unref_wins++;
 312         }
 313
 314 #ifdef HAVE_G_WEAK_REF
 315       g_weak_ref_clear (&weak);
 316 #else
 317       if (weak != NULL)
 318         g_object_remove_weak_pointer (weak, &weak);
 319 #endif
 320     }
 321
 322   if (g_test_verbose ())
 323     g_print ("Race won by get %u times, unref %u times\n",
 324              get_wins, unref_wins);
 325 }
 326
 327 int
 328 main (int   argc,
 329       char *argv[])
 330 {
 331   g_test_init (&argc, &argv, NULL);
 332   g_type_init ();
 333
 334   g_test_add_func ("/GObject/threaded-class-init", test_threaded_class_init);
 335   g_test_add_func ("/GObject/threaded-object-init", test_threaded_object_init);
 336   g_test_add_func ("/GObject/threaded-weak-ref", test_threaded_weak_ref);
 337
 338   return g_test_run();
 339 }