Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove old MSG_set_channel_number from examples.
[simgrid.git] / 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
9 #ifndef _XBT_WIN32
10 #include <sys/syscall.h>
11 #endif
12
13 #ifdef HAVE_FUTEX_H
14 #include <linux/futex.h>
15 #endif
16
17 #include "xbt/parmap.h"
18 #include "xbt/log.h"
19 #include "xbt/function_types.h"
20 #include "xbt/dynar.h"
21 #include "xbt/xbt_os_thread.h"
22 #include "xbt/sysdep.h"
23
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_parmap, xbt, "parmap: parallel map");
25 XBT_LOG_NEW_SUBCATEGORY(xbt_parmap_unit, xbt_parmap, "parmap unit testing");
26
27 typedef enum {
28   XBT_PARMAP_WORK = 0,
29   XBT_PARMAP_DESTROY
30 } e_xbt_parmap_flag_t;
31
32 static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode);
33 static void *xbt_parmap_worker_main(void *parmap);
34
35 static void xbt_parmap_posix_start(xbt_parmap_t parmap);
36 static void xbt_parmap_posix_end(xbt_parmap_t parmap);
37 static void xbt_parmap_posix_signal(xbt_parmap_t parmap);
38 static void xbt_parmap_posix_wait(xbt_parmap_t parmap);
39
40 #ifdef HAVE_FUTEX_H
41 static void xbt_parmap_futex_start(xbt_parmap_t parmap);
42 static void xbt_parmap_futex_end(xbt_parmap_t parmap);
43 static void xbt_parmap_futex_signal(xbt_parmap_t parmap);
44 static void xbt_parmap_futex_wait(xbt_parmap_t parmap);
45 static void futex_wait(int *uaddr, int val);
46 static void futex_wake(int *uaddr, int val);
47 #endif
48
49 static void xbt_parmap_busy_start(xbt_parmap_t parmap);
50 static void xbt_parmap_busy_end(xbt_parmap_t parmap);
51 static void xbt_parmap_busy_signal(xbt_parmap_t parmap);
52 static void xbt_parmap_busy_wait(xbt_parmap_t parmap);
53
54
55 /**
56  * \brief Parallel map structure
57  */
58 typedef struct s_xbt_parmap {
59   e_xbt_parmap_flag_t status;      /**< is the parmap active or being destroyed? */
60   int work;                        /**< index of the current round (1 is the first) */
61   int done;                        /**< number of rounds already done (futexes only) */
62   unsigned int thread_counter;     /**< number of threads currently working */
63   unsigned int num_workers;        /**< total number of worker threads including the controller */
64   void_f_pvoid_t fun;              /**< function to run in parallel on each element of data */
65   xbt_dynar_t data;                /**< parameters to pass to fun in parallel */
66   unsigned int index;              /**< index of the next element of data to pick */
67
68   /* fields that depend on the synchronization mode */
69   e_xbt_parmap_mode_t mode;        /**< synchronization mode */
70   void (*start_f)(xbt_parmap_t);   /**< initializes the worker threads */
71   void (*end_f)(xbt_parmap_t);     /**< finalizes the worker threads */
72   void (*signal_f)(xbt_parmap_t);  /**< wakes the workers threads to process tasks */
73   void (*wait_f)(xbt_parmap_t);    /**< waits for more work */
74 } s_xbt_parmap_t;
75
76 /**
77  * \brief Creates a parallel map object
78  * \param num_workers number of worker threads to create
79  * \param mode how to synchronize the worker threads
80  * \return the parmap created
81  */
82 xbt_parmap_t xbt_parmap_new(unsigned int num_workers, e_xbt_parmap_mode_t mode)
83 {
84   unsigned int i;
85   xbt_os_thread_t worker = NULL;
86
87   XBT_DEBUG("Create new parmap (%u workers)", num_workers);
88
89   /* Initialize the thread pool data structure */
90   xbt_parmap_t parmap = xbt_new0(s_xbt_parmap_t, 1);
91
92   parmap->num_workers = num_workers;
93   parmap->status = XBT_PARMAP_WORK;
94   xbt_parmap_set_mode(parmap, mode);
95
96   /* Create the pool of worker threads */
97   for (i = 0; i < num_workers - 1; i++) {
98     worker = xbt_os_thread_create(NULL, xbt_parmap_worker_main, parmap, NULL);
99     xbt_os_thread_detach(worker);
100   }
101   parmap->start_f(parmap);
102   return parmap;
103 }
104
105 /**
106  * \brief Destroys a parmap
107  * \param parmap the parmap to destroy
108  */
109 void xbt_parmap_destroy(xbt_parmap_t parmap)
110 {
111   parmap->status = XBT_PARMAP_DESTROY;
112   parmap->signal_f(parmap);
113   xbt_free(parmap);
114 }
115
116 /**
117  * \brief Sets the synchronization mode of a parmap.
118  * \param parmap a parallel map object
119  * \param mode the synchronization mode
120  */
121 static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode)
122 {
123   parmap->mode = mode;
124
125   switch (mode) {
126
127     case XBT_PARMAP_POSIX:
128       parmap->start_f = xbt_parmap_posix_start;
129       parmap->end_f = xbt_parmap_posix_end;
130       parmap->signal_f = xbt_parmap_posix_signal;
131       parmap->wait_f = xbt_parmap_posix_wait;
132       break;
133
134
135     case XBT_PARMAP_FUTEX:
136 #ifdef HAVE_FUTEX_H
137       parmap->start_f = xbt_parmap_futex_start;
138       parmap->end_f = xbt_parmap_futex_end;
139       parmap->signal_f = xbt_parmap_futex_signal;
140       parmap->wait_f = xbt_parmap_futex_wait;
141       break;
142 #else
143       xbt_die("Futex is not available on this OS (maybe you are on a Mac).");
144 #endif
145
146     case XBT_PARMAP_BUSY_WAIT:
147       parmap->start_f = xbt_parmap_busy_start;
148       parmap->end_f = xbt_parmap_busy_end;
149       parmap->signal_f = xbt_parmap_busy_signal;
150       parmap->wait_f = xbt_parmap_busy_wait;
151       break;
152   }
153 }
154
155 /**
156  * \brief Applies a list of tasks in parallel.
157  * \param parmap a parallel map object
158  * \param fun the function to call in parallel
159  * \param data each element of this dynar will be passed as an argument to fun
160  */
161 void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
162 {
163   /* Assign resources to worker threads */
164   parmap->fun = fun;
165   parmap->data = data;
166   parmap->index = 0;
167   parmap->signal_f(parmap);
168   XBT_DEBUG("Job done");
169 }
170
171 /**
172  * \brief Returns a next task to process.
173  *
174  * Worker threads call this function to get more work.
175  *
176  * \return the next task to process, or NULL if there is no more work
177  */
178 void* xbt_parmap_next(xbt_parmap_t parmap)
179 {
180   unsigned int index = __sync_fetch_and_add(&parmap->index, 1);
181   if (index < xbt_dynar_length(parmap->data)) {
182     return xbt_dynar_get_as(parmap->data, index, void*);
183   }
184   return NULL;
185 }
186
187 /**
188  * \brief Main function of a worker thread.
189  * \param arg the parmap
190  */
191 static void *xbt_parmap_worker_main(void *arg)
192 {
193   xbt_parmap_t parmap = (xbt_parmap_t) arg;
194
195   XBT_DEBUG("New worker thread created");
196
197   /* Worker's main loop */
198   while (1) {
199     parmap->wait_f(parmap);
200     if (parmap->status == XBT_PARMAP_WORK) {
201
202       XBT_DEBUG("Worker got a job");
203
204       void* work = xbt_parmap_next(parmap);
205       while (work != NULL) {
206         parmap->fun(work);
207         work = xbt_parmap_next(parmap);
208       }
209
210       XBT_DEBUG("Worker has finished");
211
212     /* We are destroying the parmap */
213     } else {
214       parmap->end_f(parmap);
215       XBT_DEBUG("Shutting down worker");
216       return NULL;
217     }
218   }
219 }
220
221 #ifdef HAVE_FUTEX_H
222 static void futex_wait(int *uaddr, int val)
223 {
224   XBT_VERB("Waiting on futex %p", uaddr);
225   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
226 }
227
228 static void futex_wake(int *uaddr, int val)
229 {
230   XBT_VERB("Waking futex %p", uaddr);
231   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
232 }
233 #endif
234
235 static void xbt_parmap_posix_start(xbt_parmap_t parmap)
236 {
237   THROW_UNIMPLEMENTED;
238 }
239
240 static void xbt_parmap_posix_end(xbt_parmap_t parmap)
241 {
242   THROW_UNIMPLEMENTED;
243 }
244
245 static void xbt_parmap_posix_signal(xbt_parmap_t parmap)
246 {
247   THROW_UNIMPLEMENTED;
248 }
249
250 static void xbt_parmap_posix_wait(xbt_parmap_t parmap)
251 {
252   THROW_UNIMPLEMENTED;
253 }
254
255 #ifdef HAVE_FUTEX_H
256 /**
257  * \brief Starts the parmap: waits for all workers to be ready and returns.
258  *
259  * This function is called by the controller thread.
260  *
261  * \param parmap a parmap
262  */
263 static void xbt_parmap_futex_start(xbt_parmap_t parmap)
264 {
265   int myflag = parmap->done;
266   __sync_fetch_and_add(&parmap->thread_counter, 1);
267   if (parmap->thread_counter < parmap->num_workers) {
268     /* wait for all workers to be ready */
269     futex_wait(&parmap->done, myflag);
270   }
271 }
272
273 /**
274  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
275  *
276  * This function is called by all worker threads when they end (not including
277  * the controller).
278  *
279  * \param parmap a parmap
280  */
281 static void xbt_parmap_futex_end(xbt_parmap_t parmap)
282 {
283   unsigned int mycount;
284
285   mycount = __sync_add_and_fetch(&parmap->thread_counter, 1);
286   if (mycount == parmap->num_workers) {
287     /* all workers have finished, wake the controller */
288     parmap->done++;
289     futex_wake(&parmap->done, 1);
290   }
291 }
292
293 /**
294  * \brief Wakes all workers and waits for them to finish the tasks.
295  *
296  * This function is called by the controller thread.
297  *
298  * \param parmap a parmap
299  */
300 static void xbt_parmap_futex_signal(xbt_parmap_t parmap)
301 {
302   int myflag = parmap->done;
303   parmap->thread_counter = 0;
304   parmap->work++;
305
306   /* wake all workers */
307   futex_wake(&parmap->work, parmap->num_workers);
308
309   if (parmap->status == XBT_PARMAP_WORK) {
310     /* also work myself */
311     void* work = xbt_parmap_next(parmap);
312     while (work != NULL) {
313       parmap->fun(work);
314       work = xbt_parmap_next(parmap);
315     }
316   }
317
318   unsigned int mycount = __sync_add_and_fetch(&parmap->thread_counter, 1);
319   if (mycount < parmap->num_workers) {
320     /* some workers have not finished yet */
321     futex_wait(&parmap->done, myflag);
322   }
323 }
324
325 /**
326  * \brief Waits for some work to process.
327  *
328  * This function is called by each worker thread (not including the controller)
329  * when it has no more work to do.
330  *
331  * \param parmap a parmap
332  */
333 static void xbt_parmap_futex_wait(xbt_parmap_t parmap)
334 {
335   int myflag;
336   unsigned int mycount;
337
338   myflag = parmap->work;
339   mycount = __sync_add_and_fetch(&parmap->thread_counter, 1);
340   if (mycount == parmap->num_workers) {
341     /* all workers have finished, wake the controller */
342     parmap->done++;
343     futex_wake(&parmap->done, 1);
344   }
345
346   /* wait for more work */
347   futex_wait(&parmap->work, myflag);
348 }
349 #endif
350
351 /**
352  * \brief Starts the parmap: waits for all workers to be ready and returns.
353  *
354  * This function is called by the controller thread.
355  *
356  * \param parmap a parmap
357  */
358 static void xbt_parmap_busy_start(xbt_parmap_t parmap)
359 {
360   __sync_fetch_and_add(&parmap->thread_counter, 1);
361   while (parmap->thread_counter < parmap->num_workers) {
362     xbt_os_thread_yield();
363   }
364 }
365
366 /**
367  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
368  *
369  * This function is called by all worker threads when they end.
370  *
371  * \param parmap a parmap
372  */
373 static void xbt_parmap_busy_end(xbt_parmap_t parmap)
374 {
375   __sync_add_and_fetch(&parmap->thread_counter, 1);
376 }
377
378 /**
379  * \brief Wakes all workers and waits for them to finish the tasks.
380  *
381  * This function is called by the controller thread.
382  *
383  * \param parmap a parmap
384  */
385 static void xbt_parmap_busy_signal(xbt_parmap_t parmap)
386 {
387   parmap->thread_counter = 0;
388   parmap->work++;
389
390   if (parmap->status == XBT_PARMAP_WORK) {
391     /* also work myself */
392     void* work = xbt_parmap_next(parmap);
393     while (work != NULL) {
394       parmap->fun(work);
395       work = xbt_parmap_next(parmap);
396     }
397   }
398
399   /* I have finished, wait for the others */
400   __sync_add_and_fetch(&parmap->thread_counter, 1);
401   while (parmap->thread_counter < parmap->num_workers) {
402     xbt_os_thread_yield();
403   }
404 }
405
406 /**
407  * \brief Waits for some work to process.
408  *
409  * This function is called by each worker thread (not including the controller)
410  * when it has no more work to do.
411  *
412  * \param parmap a parmap
413  */
414 static void xbt_parmap_busy_wait(xbt_parmap_t parmap)
415 {
416   int work = parmap->work;
417   __sync_add_and_fetch(&parmap->thread_counter, 1);
418
419   /* wait for more work */
420   while (parmap->work == work) {
421     xbt_os_thread_yield();
422   }
423 }
424
425 #ifdef SIMGRID_TEST
426 #include "xbt.h"
427 #include "xbt/ex.h"
428
429 XBT_TEST_SUITE("parmap", "Parallel Map");
430 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_parmap_unit);
431
432 xbt_parmap_t parmap;
433
434 void fun(void *arg);
435
436 void fun(void *arg)
437 {
438   //XBT_INFO("I'm job %lu", (unsigned long)arg);
439 }
440
441 XBT_TEST_UNIT("basic", test_parmap_basic, "Basic usage")
442 {
443   xbt_test_add("Create the parmap");
444
445   unsigned long i, j;
446   xbt_dynar_t data = xbt_dynar_new(sizeof(void *), NULL);
447
448   /* Create the parallel map */
449 #ifdef HAVE_FUTEX_H
450   parmap = xbt_parmap_new(10, XBT_PARMAP_FUTEX);
451 #else
452   parmap = xbt_parmap_new(10, XBT_PARMAP_BUSY_WAIT);
453 #endif
454   for (j = 0; j < 100; j++) {
455     xbt_dynar_push_as(data, void *, (void *)j);
456   }
457
458   for (i = 0; i < 5; i++) {
459     xbt_parmap_apply(parmap, fun, data);
460   }
461
462   /* Destroy the parmap */
463   xbt_parmap_destroy(parmap);
464   xbt_dynar_free(&data);
465 }
466
467 #endif /* SIMGRID_TEST */