Blame tests/threadpool-test.c

Packit ae235b
#undef G_DISABLE_ASSERT
Packit ae235b
#undef G_LOG_DOMAIN
Packit ae235b
Packit ae235b
#include "config.h"
Packit ae235b
Packit ae235b
#include <glib.h>
Packit ae235b
Packit ae235b
/* #define DEBUG 1 */
Packit ae235b
Packit ae235b
#ifdef DEBUG
Packit ae235b
# define DEBUG_MSG(args) g_printerr args ; g_printerr ("\n");
Packit ae235b
#else
Packit ae235b
# define DEBUG_MSG(x)
Packit ae235b
#endif
Packit ae235b
Packit ae235b
#define WAIT                5    /* seconds */
Packit ae235b
#define MAX_THREADS         10
Packit ae235b
Packit ae235b
/* if > 0 the test will run continuously (since the test ends when
Packit ae235b
 * thread count is 0), if -1 it means no limit to unused threads
Packit ae235b
 * if 0 then no unused threads are possible */
Packit ae235b
#define MAX_UNUSED_THREADS -1
Packit ae235b
Packit ae235b
G_LOCK_DEFINE_STATIC (thread_counter_pools);
Packit ae235b
Packit ae235b
static gulong abs_thread_counter = 0;
Packit ae235b
static gulong running_thread_counter = 0;
Packit ae235b
static gulong leftover_task_counter = 0;
Packit ae235b
Packit ae235b
G_LOCK_DEFINE_STATIC (last_thread);
Packit ae235b
Packit ae235b
static guint last_thread_id = 0;
Packit ae235b
Packit ae235b
G_LOCK_DEFINE_STATIC (thread_counter_sort);
Packit ae235b
Packit ae235b
static gulong sort_thread_counter = 0;
Packit ae235b
Packit ae235b
static GThreadPool *idle_pool = NULL;
Packit ae235b
Packit ae235b
static GMainLoop *main_loop = NULL;
Packit ae235b
Packit ae235b
static void
Packit ae235b
test_thread_functions (void)
Packit ae235b
{
Packit ae235b
  gint max_unused_threads;
Packit ae235b
  guint max_idle_time;
Packit ae235b
Packit ae235b
  /* This function attempts to call functions which don't need a
Packit ae235b
   * threadpool to operate to make sure no uninitialised pointers
Packit ae235b
   * accessed and no errors occur.
Packit ae235b
   */
Packit ae235b
Packit ae235b
  max_unused_threads = 3;
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[funcs] Setting max unused threads to %d",
Packit ae235b
	      max_unused_threads));
Packit ae235b
  g_thread_pool_set_max_unused_threads (max_unused_threads);
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[funcs] Getting max unused threads = %d",
Packit ae235b
	     g_thread_pool_get_max_unused_threads ()));
Packit ae235b
  g_assert (g_thread_pool_get_max_unused_threads() == max_unused_threads);
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[funcs] Getting num unused threads = %d",
Packit ae235b
	     g_thread_pool_get_num_unused_threads ()));
Packit ae235b
  g_assert (g_thread_pool_get_num_unused_threads () == 0);
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[funcs] Stopping unused threads"));
Packit ae235b
  g_thread_pool_stop_unused_threads ();
Packit ae235b
Packit ae235b
  max_idle_time = 10 * G_USEC_PER_SEC;
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[funcs] Setting max idle time to %d",
Packit ae235b
	      max_idle_time));
Packit ae235b
  g_thread_pool_set_max_idle_time (max_idle_time);
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[funcs] Getting max idle time = %d",
Packit ae235b
	     g_thread_pool_get_max_idle_time ()));
Packit ae235b
  g_assert (g_thread_pool_get_max_idle_time () == max_idle_time);
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[funcs] Setting max idle time to 0"));
Packit ae235b
  g_thread_pool_set_max_idle_time (0);
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[funcs] Getting max idle time = %d",
Packit ae235b
	     g_thread_pool_get_max_idle_time ()));
Packit ae235b
  g_assert (g_thread_pool_get_max_idle_time () == 0);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
test_thread_stop_unused (void)
Packit ae235b
{
Packit ae235b
   GThreadPool *pool;
Packit ae235b
   guint i;
Packit ae235b
   guint limit = 100;
Packit ae235b
Packit ae235b
   /* Spawn a few threads. */
Packit ae235b
   g_thread_pool_set_max_unused_threads (-1);
Packit ae235b
   pool = g_thread_pool_new ((GFunc) g_usleep, NULL, -1, FALSE, NULL);
Packit ae235b
Packit ae235b
   for (i = 0; i < limit; i++)
Packit ae235b
     g_thread_pool_push (pool, GUINT_TO_POINTER (1000), NULL);
Packit ae235b
Packit ae235b
   DEBUG_MSG (("[unused] ===> pushed %d threads onto the idle pool",
Packit ae235b
	       limit));
Packit ae235b
Packit ae235b
   /* Wait for the threads to migrate. */
Packit ae235b
   g_usleep (G_USEC_PER_SEC);
Packit ae235b
Packit ae235b
   DEBUG_MSG (("[unused] stopping unused threads"));
Packit ae235b
   g_thread_pool_stop_unused_threads ();
Packit ae235b
Packit ae235b
   for (i = 0; i < 5; i++)
Packit ae235b
     {
Packit ae235b
       if (g_thread_pool_get_num_unused_threads () == 0)
Packit ae235b
         break;
Packit ae235b
Packit ae235b
       DEBUG_MSG (("[unused] waiting ONE second for threads to die"));
Packit ae235b
Packit ae235b
       /* Some time for threads to die. */
Packit ae235b
       g_usleep (G_USEC_PER_SEC);
Packit ae235b
     }
Packit ae235b
Packit ae235b
   DEBUG_MSG (("[unused] stopped idle threads, %d remain",
Packit ae235b
	       g_thread_pool_get_num_unused_threads ()));
Packit ae235b
Packit ae235b
   g_assert (g_thread_pool_get_num_unused_threads () == 0);
Packit ae235b
Packit ae235b
   g_thread_pool_set_max_unused_threads (MAX_THREADS);
Packit ae235b
Packit ae235b
   DEBUG_MSG (("[unused] cleaning up thread pool"));
Packit ae235b
   g_thread_pool_free (pool, FALSE, TRUE);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
test_thread_pools_entry_func (gpointer data, gpointer user_data)
Packit ae235b
{
Packit ae235b
#ifdef DEBUG
Packit ae235b
  guint id = 0;
Packit ae235b
Packit ae235b
  id = GPOINTER_TO_UINT (data);
Packit ae235b
#endif
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[pool] ---> [%3.3d] entered thread.", id));
Packit ae235b
Packit ae235b
  G_LOCK (thread_counter_pools);
Packit ae235b
  abs_thread_counter++;
Packit ae235b
  running_thread_counter++;
Packit ae235b
  G_UNLOCK (thread_counter_pools);
Packit ae235b
Packit ae235b
  g_usleep (g_random_int_range (0, 4000));
Packit ae235b
Packit ae235b
  G_LOCK (thread_counter_pools);
Packit ae235b
  running_thread_counter--;
Packit ae235b
  leftover_task_counter--;
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[pool] ---> [%3.3d] exiting thread (abs count:%ld, "
Packit ae235b
	      "running count:%ld, left over:%ld)",
Packit ae235b
	      id, abs_thread_counter,
Packit ae235b
	      running_thread_counter, leftover_task_counter));
Packit ae235b
  G_UNLOCK (thread_counter_pools);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
test_thread_pools (void)
Packit ae235b
{
Packit ae235b
  GThreadPool *pool1, *pool2, *pool3;
Packit ae235b
  guint runs;
Packit ae235b
  guint i;
Packit ae235b
Packit ae235b
  pool1 = g_thread_pool_new ((GFunc)test_thread_pools_entry_func, NULL, 3, FALSE, NULL);
Packit ae235b
  pool2 = g_thread_pool_new ((GFunc)test_thread_pools_entry_func, NULL, 5, TRUE, NULL);
Packit ae235b
  pool3 = g_thread_pool_new ((GFunc)test_thread_pools_entry_func, NULL, 7, TRUE, NULL);
Packit ae235b
Packit ae235b
  runs = 300;
Packit ae235b
  for (i = 0; i < runs; i++)
Packit ae235b
    {
Packit ae235b
      g_thread_pool_push (pool1, GUINT_TO_POINTER (i + 1), NULL);
Packit ae235b
      g_thread_pool_push (pool2, GUINT_TO_POINTER (i + 1), NULL);
Packit ae235b
      g_thread_pool_push (pool3, GUINT_TO_POINTER (i + 1), NULL);
Packit ae235b
Packit ae235b
      G_LOCK (thread_counter_pools);
Packit ae235b
      leftover_task_counter += 3;
Packit ae235b
      G_UNLOCK (thread_counter_pools);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  g_thread_pool_free (pool1, TRUE, TRUE);
Packit ae235b
  g_thread_pool_free (pool2, FALSE, TRUE);
Packit ae235b
  g_thread_pool_free (pool3, FALSE, TRUE);
Packit ae235b
Packit ae235b
  g_assert (runs * 3 == abs_thread_counter + leftover_task_counter);
Packit ae235b
  g_assert (running_thread_counter == 0);
Packit ae235b
}
Packit ae235b
Packit ae235b
static gint
Packit ae235b
test_thread_sort_compare_func (gconstpointer a, gconstpointer b, gpointer user_data)
Packit ae235b
{
Packit ae235b
  guint32 id1, id2;
Packit ae235b
Packit ae235b
  id1 = GPOINTER_TO_UINT (a);
Packit ae235b
  id2 = GPOINTER_TO_UINT (b);
Packit ae235b
Packit ae235b
  return (id1 > id2 ? +1 : id1 == id2 ? 0 : -1);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
test_thread_sort_entry_func (gpointer data, gpointer user_data)
Packit ae235b
{
Packit ae235b
  guint thread_id;
Packit ae235b
  gboolean is_sorted;
Packit ae235b
Packit ae235b
  G_LOCK (last_thread);
Packit ae235b
Packit ae235b
  thread_id = GPOINTER_TO_UINT (data);
Packit ae235b
  is_sorted = GPOINTER_TO_INT (user_data);
Packit ae235b
Packit ae235b
  DEBUG_MSG (("%s ---> entered thread:%2.2d, last thread:%2.2d",
Packit ae235b
	      is_sorted ? "[  sorted]" : "[unsorted]",
Packit ae235b
	      thread_id, last_thread_id));
Packit ae235b
Packit ae235b
  if (is_sorted) {
Packit ae235b
    static gboolean last_failed = FALSE;
Packit ae235b
Packit ae235b
    if (last_thread_id > thread_id) {
Packit ae235b
      if (last_failed) {
Packit ae235b
	g_assert (last_thread_id <= thread_id);
Packit ae235b
      }
Packit ae235b
Packit ae235b
      /* Here we remember one fail and if it concurrently fails, it
Packit ae235b
       * can not be sorted. the last thread id might be < this thread
Packit ae235b
       * id if something is added to the queue since threads were
Packit ae235b
       * created
Packit ae235b
       */
Packit ae235b
      last_failed = TRUE;
Packit ae235b
    } else {
Packit ae235b
      last_failed = FALSE;
Packit ae235b
    }
Packit ae235b
Packit ae235b
    last_thread_id = thread_id;
Packit ae235b
  }
Packit ae235b
Packit ae235b
  G_UNLOCK (last_thread);
Packit ae235b
Packit ae235b
  g_usleep (WAIT * 1000);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
test_thread_sort (gboolean sort)
Packit ae235b
{
Packit ae235b
  GThreadPool *pool;
Packit ae235b
  guint limit;
Packit ae235b
  guint max_threads;
Packit ae235b
  gint i;
Packit ae235b
Packit ae235b
  limit = MAX_THREADS * 10;
Packit ae235b
Packit ae235b
  if (sort) {
Packit ae235b
    max_threads = 1;
Packit ae235b
  } else {
Packit ae235b
    max_threads = MAX_THREADS;
Packit ae235b
  }
Packit ae235b
Packit ae235b
  /* It is important that we only have a maximum of 1 thread for this
Packit ae235b
   * test since the results can not be guaranteed to be sorted if > 1.
Packit ae235b
   *
Packit ae235b
   * Threads are scheduled by the operating system and are executed at
Packit ae235b
   * random. It cannot be assumed that threads are executed in the
Packit ae235b
   * order they are created. This was discussed in bug #334943.
Packit ae235b
   */
Packit ae235b
Packit ae235b
  pool = g_thread_pool_new (test_thread_sort_entry_func,
Packit ae235b
			    GINT_TO_POINTER (sort),
Packit ae235b
			    max_threads,
Packit ae235b
			    FALSE,
Packit ae235b
			    NULL);
Packit ae235b
Packit ae235b
  g_thread_pool_set_max_unused_threads (MAX_UNUSED_THREADS);
Packit ae235b
Packit ae235b
  if (sort) {
Packit ae235b
    g_thread_pool_set_sort_function (pool,
Packit ae235b
				     test_thread_sort_compare_func,
Packit ae235b
				     GUINT_TO_POINTER (69));
Packit ae235b
  }
Packit ae235b
Packit ae235b
  for (i = 0; i < limit; i++) {
Packit ae235b
    guint id;
Packit ae235b
Packit ae235b
    id = g_random_int_range (1, limit) + 1;
Packit ae235b
    g_thread_pool_push (pool, GUINT_TO_POINTER (id), NULL);
Packit ae235b
    DEBUG_MSG (("%s ===> pushed new thread with id:%d, number "
Packit ae235b
		"of threads:%d, unprocessed:%d",
Packit ae235b
		sort ? "[  sorted]" : "[unsorted]",
Packit ae235b
		id,
Packit ae235b
		g_thread_pool_get_num_threads (pool),
Packit ae235b
		g_thread_pool_unprocessed (pool)));
Packit ae235b
  }
Packit ae235b
Packit ae235b
  g_assert (g_thread_pool_get_max_threads (pool) == max_threads);
Packit ae235b
  g_assert (g_thread_pool_get_num_threads (pool) == g_thread_pool_get_max_threads (pool));
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
test_thread_idle_time_entry_func (gpointer data, gpointer user_data)
Packit ae235b
{
Packit ae235b
#ifdef DEBUG
Packit ae235b
  guint thread_id;
Packit ae235b
Packit ae235b
  thread_id = GPOINTER_TO_UINT (data);
Packit ae235b
#endif
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[idle] ---> entered thread:%2.2d", thread_id));
Packit ae235b
Packit ae235b
  g_usleep (WAIT * 1000);
Packit ae235b
Packit ae235b
  DEBUG_MSG (("[idle] <--- exiting thread:%2.2d", thread_id));
Packit ae235b
}
Packit ae235b
Packit ae235b
static gboolean
Packit ae235b
test_thread_idle_timeout (gpointer data)
Packit ae235b
{
Packit ae235b
  gint i;
Packit ae235b
Packit ae235b
  for (i = 0; i < 2; i++) {
Packit ae235b
    g_thread_pool_push (idle_pool, GUINT_TO_POINTER (100 + i), NULL);
Packit ae235b
    DEBUG_MSG (("[idle] ===> pushed new thread with id:%d, number "
Packit ae235b
		"of threads:%d, unprocessed:%d",
Packit ae235b
		100 + i,
Packit ae235b
		g_thread_pool_get_num_threads (idle_pool),
Packit ae235b
		g_thread_pool_unprocessed (idle_pool)));
Packit ae235b
  }
Packit ae235b
Packit ae235b
Packit ae235b
  return FALSE;
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
test_thread_idle_time (void)
Packit ae235b
{
Packit ae235b
  guint limit = 50;
Packit ae235b
  guint interval = 10000;
Packit ae235b
  gint i;
Packit ae235b
Packit ae235b
  idle_pool = g_thread_pool_new (test_thread_idle_time_entry_func,
Packit ae235b
				 NULL,
Packit ae235b
				 0,
Packit ae235b
				 FALSE,
Packit ae235b
				 NULL);
Packit ae235b
Packit ae235b
  g_thread_pool_set_max_threads (idle_pool, MAX_THREADS, NULL);
Packit ae235b
  g_thread_pool_set_max_unused_threads (MAX_UNUSED_THREADS);
Packit ae235b
  g_thread_pool_set_max_idle_time (interval);
Packit ae235b
Packit ae235b
  g_assert (g_thread_pool_get_max_threads (idle_pool) == MAX_THREADS);
Packit ae235b
  g_assert (g_thread_pool_get_max_unused_threads () == MAX_UNUSED_THREADS);
Packit ae235b
  g_assert (g_thread_pool_get_max_idle_time () == interval);
Packit ae235b
Packit ae235b
  for (i = 0; i < limit; i++) {
Packit ae235b
    g_thread_pool_push (idle_pool, GUINT_TO_POINTER (i + 1), NULL);
Packit ae235b
    DEBUG_MSG (("[idle] ===> pushed new thread with id:%d, "
Packit ae235b
		"number of threads:%d, unprocessed:%d",
Packit ae235b
		i,
Packit ae235b
		g_thread_pool_get_num_threads (idle_pool),
Packit ae235b
		g_thread_pool_unprocessed (idle_pool)));
Packit ae235b
  }
Packit ae235b
Packit ae235b
  g_assert_cmpint (g_thread_pool_unprocessed (idle_pool), <=, limit);
Packit ae235b
Packit ae235b
  g_timeout_add ((interval - 1000),
Packit ae235b
		 test_thread_idle_timeout,
Packit ae235b
		 GUINT_TO_POINTER (interval));
Packit ae235b
}
Packit ae235b
Packit ae235b
static gboolean
Packit ae235b
test_check_start_and_stop (gpointer user_data)
Packit ae235b
{
Packit ae235b
  static guint test_number = 0;
Packit ae235b
  static gboolean run_next = FALSE;
Packit ae235b
  gboolean continue_timeout = TRUE;
Packit ae235b
  gboolean quit = TRUE;
Packit ae235b
Packit ae235b
  if (test_number == 0) {
Packit ae235b
    run_next = TRUE;
Packit ae235b
    DEBUG_MSG (("***** RUNNING TEST %2.2d *****", test_number));
Packit ae235b
  }
Packit ae235b
Packit ae235b
  if (run_next) {
Packit ae235b
    test_number++;
Packit ae235b
Packit ae235b
    switch (test_number) {
Packit ae235b
    case 1:
Packit ae235b
      test_thread_functions ();
Packit ae235b
      break;
Packit ae235b
    case 2:
Packit ae235b
      test_thread_stop_unused ();
Packit ae235b
      break;
Packit ae235b
    case 3:
Packit ae235b
      test_thread_pools ();
Packit ae235b
      break;
Packit ae235b
    case 4:
Packit ae235b
      test_thread_sort (FALSE);
Packit ae235b
      break;
Packit ae235b
    case 5:
Packit ae235b
      test_thread_sort (TRUE);
Packit ae235b
      break;
Packit ae235b
    case 6:
Packit ae235b
      test_thread_stop_unused ();
Packit ae235b
      break;
Packit ae235b
    case 7:
Packit ae235b
      test_thread_idle_time ();
Packit ae235b
      break;
Packit ae235b
    default:
Packit ae235b
      DEBUG_MSG (("***** END OF TESTS *****"));
Packit ae235b
      g_main_loop_quit (main_loop);
Packit ae235b
      continue_timeout = FALSE;
Packit ae235b
      break;
Packit ae235b
    }
Packit ae235b
Packit ae235b
    run_next = FALSE;
Packit ae235b
    return TRUE;
Packit ae235b
  }
Packit ae235b
Packit ae235b
  if (test_number == 3) {
Packit ae235b
    G_LOCK (thread_counter_pools);
Packit ae235b
    quit &= running_thread_counter <= 0;
Packit ae235b
    DEBUG_MSG (("***** POOL RUNNING THREAD COUNT:%ld",
Packit ae235b
		running_thread_counter));
Packit ae235b
    G_UNLOCK (thread_counter_pools);
Packit ae235b
  }
Packit ae235b
Packit ae235b
  if (test_number == 4 || test_number == 5) {
Packit ae235b
    G_LOCK (thread_counter_sort);
Packit ae235b
    quit &= sort_thread_counter <= 0;
Packit ae235b
    DEBUG_MSG (("***** POOL SORT THREAD COUNT:%ld",
Packit ae235b
		sort_thread_counter));
Packit ae235b
    G_UNLOCK (thread_counter_sort);
Packit ae235b
  }
Packit ae235b
Packit ae235b
  if (test_number == 7) {
Packit ae235b
    guint idle;
Packit ae235b
Packit ae235b
    idle = g_thread_pool_get_num_unused_threads ();
Packit ae235b
    quit &= idle < 1;
Packit ae235b
    DEBUG_MSG (("***** POOL IDLE THREAD COUNT:%d, UNPROCESSED JOBS:%d",
Packit ae235b
		idle, g_thread_pool_unprocessed (idle_pool)));
Packit ae235b
  }
Packit ae235b
Packit ae235b
  if (quit) {
Packit ae235b
    run_next = TRUE;
Packit ae235b
  }
Packit ae235b
Packit ae235b
  return continue_timeout;
Packit ae235b
}
Packit ae235b
Packit ae235b
int
Packit ae235b
main (int argc, char *argv[])
Packit ae235b
{
Packit ae235b
  DEBUG_MSG (("Starting... (in one second)"));
Packit ae235b
  g_timeout_add (1000, test_check_start_and_stop, NULL);
Packit ae235b
Packit ae235b
  main_loop = g_main_loop_new (NULL, FALSE);
Packit ae235b
  g_main_loop_run (main_loop);
Packit ae235b
  g_main_loop_unref (main_loop);
Packit ae235b
Packit ae235b
  g_thread_pool_free (idle_pool, FALSE, TRUE);
Packit ae235b
  return 0;
Packit ae235b
}