src/xbt/parmap.c

   1 /* Copyright (c) 2004, 2005, 2007, 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6 #include "gras_config.h"
   7 #include <unistd.h>
   8 #ifndef _XBT_WIN32
   9 #include <sys/syscall.h>
  10 #endif
  11
  12 #ifdef HAVE_FUTEX_H
  13         #include <linux/futex.h>
  14 #else
  15         #include "xbt/xbt_os_thread.h"
  16 #endif
  17 #include <errno.h>
  18 #include "parmap_private.h"
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_parmap, xbt, "parmap: parallel map");
  21 XBT_LOG_NEW_SUBCATEGORY(xbt_parmap_unit, xbt_parmap, "parmap unit testing");
  22
  23 static void *_xbt_parmap_worker_main(void *parmap);
  24 #ifdef HAVE_FUTEX_H
  25         static void futex_wait(int *uaddr, int val);
  26         static void futex_wake(int *uaddr, int val);
  27 #endif
  28 xbt_parmap_t xbt_parmap_new(unsigned int num_workers)
  29 {
  30   unsigned int i;
  31   xbt_os_thread_t worker = NULL;
  32
  33   XBT_DEBUG("Create new parmap (%u workers)", num_workers);
  34
  35   /* Initialize the thread pool data structure */
  36   xbt_parmap_t parmap = xbt_new0(s_xbt_parmap_t, 1);
  37 #ifdef HAVE_FUTEX_H
  38   parmap->sync_event = xbt_new0(s_xbt_event_t, 1);
  39 #endif
  40   parmap->num_workers = num_workers;
  41   parmap->status = PARMAP_WORK;
  42 #ifdef HAVE_FUTEX_H
  43   parmap->sync_event->threads_to_wait = num_workers;
  44 #endif
  45   /* Create the pool of worker threads */
  46   for(i=0; i < num_workers; i++){
  47     worker = xbt_os_thread_create(NULL, _xbt_parmap_worker_main, parmap, NULL);
  48     xbt_os_thread_detach(worker);
  49   }
  50 #ifdef HAVE_FUTEX_H
  51   xbt_event_init(parmap->sync_event);
  52 #endif
  53   return parmap;
  54 }
  55
  56 void xbt_parmap_destroy(xbt_parmap_t parmap)
  57 {
  58   XBT_DEBUG("Destroy parmap %p", parmap);
  59   parmap->status = PARMAP_DESTROY;
  60 #ifdef HAVE_FUTEX_H
  61   xbt_event_signal(parmap->sync_event);
  62   xbt_free(parmap->sync_event);
  63 #endif
  64   xbt_free(parmap);
  65 }
  66
  67  void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
  68 {
  69   /* Assign resources to worker threads*/
  70   parmap->fun = fun;
  71   parmap->data = data;
  72   parmap->index = 0;
  73 #ifdef HAVE_FUTEX_H
  74   xbt_event_signal(parmap->sync_event);
  75 #endif
  76   XBT_DEBUG("Job done");
  77 }
  78
  79 static void *_xbt_parmap_worker_main(void *arg)
  80 {
  81   unsigned int worker_id;
  82   xbt_parmap_t parmap = (xbt_parmap_t)arg;
  83
  84   /* Fetch a worker id */
  85   worker_id = __sync_fetch_and_add(&parmap->workers_max_id, 1);
  86   xbt_os_thread_set_extra_data((void *)(unsigned long)worker_id);
  87
  88   XBT_DEBUG("New worker thread created (%u)", worker_id);
  89
  90   /* Worker's main loop */
  91   while (1) {
  92 #ifdef HAVE_FUTEX_H
  93     xbt_event_wait(parmap->sync_event);
  94 #endif
  95     if (parmap->status == PARMAP_WORK) {
  96
  97       XBT_DEBUG("Worker %u got a job", worker_id);
  98
  99       unsigned int i = __sync_fetch_and_add(&parmap->index, 1);
 100       if (i < xbt_dynar_length(parmap->data)) {
 101         parmap->fun(xbt_dynar_get_as(parmap->data, i, void*));
 102       }
 103
 104       XBT_DEBUG("Worker %u has finished", worker_id);
 105
 106     /* We are destroying the parmap */
 107     } else {
 108 #ifdef HAVE_FUTEX_H
 109       xbt_event_end(parmap->sync_event);
 110 #endif
 111       XBT_DEBUG("Shutting down worker %u", worker_id);
 112       return NULL;
 113     }
 114   }
 115 }
 116
 117 #ifdef HAVE_FUTEX_H
 118 static void futex_wait(int *uaddr, int val)
 119 {
 120   XBT_VERB("Waiting on futex %p", uaddr);
 121   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
 122 }
 123
 124 static void futex_wake(int *uaddr, int val)
 125 {
 126   XBT_VERB("Waking futex %p", uaddr);
 127   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
 128 }
 129
 130 void xbt_event_init(xbt_event_t event)
 131 {
 132   int myflag = event->done;
 133   if(event->thread_counter < event->threads_to_wait)
 134     futex_wait(&event->done, myflag);
 135 }
 136
 137 void xbt_event_signal(xbt_event_t event)
 138 {
 139   int myflag = event->done;
 140   event->thread_counter = 0;
 141   event->work++;
 142   futex_wake(&event->work, event->threads_to_wait);
 143   futex_wait(&event->done, myflag);
 144 }
 145
 146 void xbt_event_wait(xbt_event_t event)
 147 {
 148   int myflag;
 149   unsigned int mycount;
 150
 151   myflag = event->work;
 152   mycount = __sync_add_and_fetch(&event->thread_counter, 1);
 153   if(mycount == event->threads_to_wait){
 154     event->done++;
 155     futex_wake(&event->done, 1);
 156   }
 157
 158   futex_wait(&event->work, myflag);
 159 }
 160
 161 void xbt_event_end(xbt_event_t event)
 162 {
 163   unsigned int mycount;
 164
 165   mycount = __sync_add_and_fetch(&event->thread_counter, 1);
 166   if(mycount == event->threads_to_wait){
 167     event->done++;
 168     futex_wake(&event->done, 1);
 169   }
 170 }
 171 #endif
 172
 173 #ifdef SIMGRID_TEST
 174 #include "xbt.h"
 175 #include "xbt/ex.h"
 176
 177 XBT_TEST_SUITE("parmap", "Parallel Map");
 178 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_parmap_unit);
 179
 180
 181
 182 xbt_parmap_t parmap;
 183
 184 void fun(void *arg);
 185
 186 void fun(void *arg)
 187 {
 188   //XBT_INFO("I'm job %lu", (unsigned long)arg);
 189 }
 190
 191 XBT_TEST_UNIT("basic", test_parmap_basic, "Basic usage")
 192 {
 193   xbt_test_add("Create the parmap");
 194
 195   unsigned long i,j;
 196   xbt_dynar_t data = xbt_dynar_new(sizeof(void *), NULL);
 197
 198   /* Create the parallel map */
 199   parmap = xbt_parmap_new(10);
 200
 201   for(j=0; j < 100; j++){
 202     xbt_dynar_push_as(data, void *, (void *)j);
 203   }
 204
 205   for(i=0; i < 5; i++)
 206     xbt_parmap_apply(parmap, fun, data);
 207
 208   /* Destroy the parmap */
 209   xbt_parmap_destroy(parmap);
 210   xbt_dynar_free(&data);
 211 }
 212
 213 #endif /* SIMGRID_TEST */