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