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   parmap->sync_event = xbt_new0(s_xbt_event_t, 1);
  38   parmap->num_workers = num_workers;
  39   parmap->status = PARMAP_WORK;
  40   parmap->sync_event->threads_to_wait = num_workers;
  41
  42   /* Create the pool of worker threads */
  43   for(i=0; i < num_workers; i++){
  44     worker = xbt_os_thread_create(NULL, _xbt_parmap_worker_main, parmap, NULL);
  45     xbt_os_thread_detach(worker);
  46   }
  47
  48   xbt_event_init(parmap->sync_event);
  49   return parmap;
  50 }
  51
  52 void xbt_parmap_destroy(xbt_parmap_t parmap)
  53 {
  54   XBT_DEBUG("Destroy parmap %p", parmap);
  55   parmap->status = PARMAP_DESTROY;
  56   xbt_event_signal(parmap->sync_event);
  57   xbt_free(parmap->sync_event);
  58   xbt_free(parmap);
  59 }
  60
  61  void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
  62 {
  63   /* Assign resources to worker threads*/
  64   parmap->fun = fun;
  65   parmap->data = data;
  66
  67   xbt_event_signal(parmap->sync_event);
  68
  69   XBT_DEBUG("Job done");
  70 }
  71
  72 static void *_xbt_parmap_worker_main(void *arg)
  73 {
  74   unsigned int data_start, data_end, data_size, worker_id;
  75   xbt_parmap_t parmap = (xbt_parmap_t)arg;
  76
  77   /* Fetch a worker id */
  78   worker_id = __sync_fetch_and_add(&parmap->workers_max_id, 1);
  79   xbt_os_thread_set_extra_data((void *)(unsigned long)worker_id);
  80
  81   XBT_DEBUG("New worker thread created (%u)", worker_id);
  82
  83   /* Worker's main loop */
  84   while(1){
  85     xbt_event_wait(parmap->sync_event);
  86     if(parmap->status == PARMAP_WORK){
  87       XBT_DEBUG("Worker %u got a job", worker_id);
  88
  89       /* Compute how much data does every worker gets */
  90       data_size = (xbt_dynar_length(parmap->data) / parmap->num_workers)
  91                   + ((xbt_dynar_length(parmap->data) % parmap->num_workers) ? 1 : 0);
  92
  93       /* Each worker data segment starts in a position associated with its id*/
  94       data_start = data_size * worker_id;
  95
  96       /* The end of the worker data segment must be bounded by the end of the data vector */
  97       data_end = MIN(data_start + data_size, xbt_dynar_length(parmap->data));
  98
  99       XBT_DEBUG("Worker %u: data_start=%u data_end=%u (data_size=%u)",
 100           worker_id, data_start, data_end, data_size);
 101
 102       /* While the worker don't pass the end of it data segment apply the function */
 103       while(data_start < data_end){
 104         parmap->fun(*(void **)xbt_dynar_get_ptr(parmap->data, data_start));
 105         data_start++;
 106       }
 107
 108     /* We are destroying the parmap */
 109     }else{
 110       xbt_event_end(parmap->sync_event);
 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   int myflag;
 164   unsigned int mycount;
 165
 166   myflag = event->work;
 167   mycount = __sync_add_and_fetch(&event->thread_counter, 1);
 168   if(mycount == event->threads_to_wait){
 169     event->done++;
 170     futex_wake(&event->done, 1);
 171   }
 172 }
 173 #endif
 174
 175 #ifdef SIMGRID_TEST
 176 #include "xbt.h"
 177 #include "xbt/ex.h"
 178
 179 XBT_TEST_SUITE("parmap", "Parallel Map");
 180 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_parmap_unit);
 181
 182
 183
 184 xbt_parmap_t parmap;
 185
 186 void fun(void *arg);
 187
 188 void fun(void *arg)
 189 {
 190   //XBT_INFO("I'm job %lu", (unsigned long)arg);
 191 }
 192
 193 XBT_TEST_UNIT("basic", test_parmap_basic, "Basic usage")
 194 {
 195   xbt_test_add("Create the parmap");
 196
 197   unsigned long i,j;
 198   xbt_dynar_t data = xbt_dynar_new(sizeof(void *), NULL);
 199
 200   /* Create the parallel map */
 201   parmap = xbt_parmap_new(10);
 202
 203   for(j=0; j < 100; j++){
 204     xbt_dynar_push_as(data, void *, (void *)j);
 205   }
 206
 207   for(i=0; i < 5; i++)
 208     xbt_parmap_apply(parmap, fun, data);
 209
 210   /* Destroy the parmap */
 211   xbt_parmap_destroy(parmap);
 212   xbt_dynar_free(&data);
 213 }
 214
 215 #endif /* SIMGRID_TEST */