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 #ifdef HAVE_FUTEX_H
  73   xbt_event_signal(parmap->sync_event);
  74 #endif
  75   XBT_DEBUG("Job done");
  76 }
  77
  78 static void *_xbt_parmap_worker_main(void *arg)
  79 {
  80   unsigned int data_start, data_end, data_size, worker_id;
  81   xbt_parmap_t parmap = (xbt_parmap_t)arg;
  82
  83   /* Fetch a worker id */
  84   worker_id = __sync_fetch_and_add(&parmap->workers_max_id, 1);
  85   xbt_os_thread_set_extra_data((void *)(unsigned long)worker_id);
  86
  87   XBT_DEBUG("New worker thread created (%u)", worker_id);
  88
  89   /* Worker's main loop */
  90   while(1){
  91 #ifdef HAVE_FUTEX_H
  92     xbt_event_wait(parmap->sync_event);
  93 #endif
  94     if(parmap->status == PARMAP_WORK){
  95       XBT_DEBUG("Worker %u got a job", worker_id);
  96
  97       /* Compute how much data does every worker gets */
  98       data_size = (xbt_dynar_length(parmap->data) / parmap->num_workers)
  99                   + ((xbt_dynar_length(parmap->data) % parmap->num_workers) ? 1 : 0);
 100
 101       /* Each worker data segment starts in a position associated with its id*/
 102       data_start = data_size * worker_id;
 103
 104       /* The end of the worker data segment must be bounded by the end of the data vector */
 105       data_end = MIN(data_start + data_size, xbt_dynar_length(parmap->data));
 106
 107       XBT_DEBUG("Worker %u: data_start=%u data_end=%u (data_size=%u)",
 108           worker_id, data_start, data_end, data_size);
 109
 110       /* While the worker don't pass the end of it data segment apply the function */
 111       while(data_start < data_end){
 112         parmap->fun(*(void **)xbt_dynar_get_ptr(parmap->data, data_start));
 113         data_start++;
 114       }
 115
 116     /* We are destroying the parmap */
 117     }else{
 118 #ifdef HAVE_FUTEX_H
 119       xbt_event_end(parmap->sync_event);
 120 #endif
 121       XBT_DEBUG("Shutting down worker %u", worker_id);
 122       return NULL;
 123     }
 124   }
 125 }
 126
 127 #ifdef HAVE_FUTEX_H
 128 static void futex_wait(int *uaddr, int val)
 129 {
 130   XBT_VERB("Waiting on futex %p", uaddr);
 131   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
 132 }
 133
 134 static void futex_wake(int *uaddr, int val)
 135 {
 136   XBT_VERB("Waking futex %p", uaddr);
 137   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
 138 }
 139
 140 void xbt_event_init(xbt_event_t event)
 141 {
 142   int myflag = event->done;
 143   if(event->thread_counter < event->threads_to_wait)
 144     futex_wait(&event->done, myflag);
 145 }
 146
 147 void xbt_event_signal(xbt_event_t event)
 148 {
 149   int myflag = event->done;
 150   event->thread_counter = 0;
 151   event->work++;
 152   futex_wake(&event->work, event->threads_to_wait);
 153   futex_wait(&event->done, myflag);
 154 }
 155
 156 void xbt_event_wait(xbt_event_t event)
 157 {
 158   int myflag;
 159   unsigned int mycount;
 160
 161   myflag = event->work;
 162   mycount = __sync_add_and_fetch(&event->thread_counter, 1);
 163   if(mycount == event->threads_to_wait){
 164     event->done++;
 165     futex_wake(&event->done, 1);
 166   }
 167
 168   futex_wait(&event->work, myflag);
 169 }
 170
 171 void xbt_event_end(xbt_event_t event)
 172 {
 173   int myflag;
 174   unsigned int mycount;
 175
 176   myflag = event->work;
 177   mycount = __sync_add_and_fetch(&event->thread_counter, 1);
 178   if(mycount == event->threads_to_wait){
 179     event->done++;
 180     futex_wake(&event->done, 1);
 181   }
 182 }
 183 #endif
 184
 185 #ifdef SIMGRID_TEST
 186 #include "xbt.h"
 187 #include "xbt/ex.h"
 188
 189 XBT_TEST_SUITE("parmap", "Parallel Map");
 190 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_parmap_unit);
 191
 192
 193
 194 xbt_parmap_t parmap;
 195
 196 void fun(void *arg);
 197
 198 void fun(void *arg)
 199 {
 200   //XBT_INFO("I'm job %lu", (unsigned long)arg);
 201 }
 202
 203 XBT_TEST_UNIT("basic", test_parmap_basic, "Basic usage")
 204 {
 205   xbt_test_add("Create the parmap");
 206
 207   unsigned long i,j;
 208   xbt_dynar_t data = xbt_dynar_new(sizeof(void *), NULL);
 209
 210   /* Create the parallel map */
 211   parmap = xbt_parmap_new(10);
 212
 213   for(j=0; j < 100; j++){
 214     xbt_dynar_push_as(data, void *, (void *)j);
 215   }
 216
 217   for(i=0; i < 5; i++)
 218     xbt_parmap_apply(parmap, fun, data);
 219
 220   /* Destroy the parmap */
 221   xbt_parmap_destroy(parmap);
 222   xbt_dynar_free(&data);
 223 }
 224
 225 #endif /* SIMGRID_TEST */