Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Oups... forgot to remove this line.
[simgrid.git] / src / xbt / parmap.c
1 /* Copyright (c) 2004-2005, 2007, 2009-2013. 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 "internal_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 #include <limits.h>
16 #endif
17
18 #include "xbt/parmap.h"
19 #include "xbt/log.h"
20 #include "xbt/function_types.h"
21 #include "xbt/dynar.h"
22 #include "xbt/xbt_os_thread.h"
23 #include "xbt/sysdep.h"
24 #include "simix/smx_private.h"
25
26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_parmap, xbt, "parmap: parallel map");
27
28 typedef enum {
29   XBT_PARMAP_WORK,
30   XBT_PARMAP_DESTROY
31 } e_xbt_parmap_flag_t;
32
33 static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode);
34 static void *xbt_parmap_worker_main(void *parmap);
35 static void xbt_parmap_work(xbt_parmap_t parmap);
36
37 static void xbt_parmap_posix_master_wait(xbt_parmap_t parmap);
38 static void xbt_parmap_posix_worker_signal(xbt_parmap_t parmap);
39 static void xbt_parmap_posix_master_signal(xbt_parmap_t parmap);
40 static void xbt_parmap_posix_worker_wait(xbt_parmap_t parmap, unsigned round);
41
42 #ifdef HAVE_FUTEX_H
43 static void xbt_parmap_futex_master_wait(xbt_parmap_t parmap);
44 static void xbt_parmap_futex_worker_signal(xbt_parmap_t parmap);
45 static void xbt_parmap_futex_master_signal(xbt_parmap_t parmap);
46 static void xbt_parmap_futex_worker_wait(xbt_parmap_t parmap, unsigned round);
47 static void futex_wait(unsigned *uaddr, unsigned val);
48 static void futex_wake(unsigned *uaddr, unsigned val);
49 #endif
50
51 static void xbt_parmap_busy_master_wait(xbt_parmap_t parmap);
52 static void xbt_parmap_busy_worker_signal(xbt_parmap_t parmap);
53 static void xbt_parmap_busy_master_signal(xbt_parmap_t parmap);
54 static void xbt_parmap_busy_worker_wait(xbt_parmap_t parmap, unsigned round);
55
56 #ifdef HAVE_MC
57 static void xbt_parmap_mc_work(xbt_parmap_t parmap, int worker_id);
58 static void *xbt_parmap_mc_worker_main(void *arg);
59 #endif
60
61 /**
62  * \brief Parallel map structure
63  */
64 typedef struct s_xbt_parmap {
65   e_xbt_parmap_flag_t status;      /**< is the parmap active or being destroyed? */
66   unsigned work;                   /**< index of the current round */
67   unsigned thread_counter;         /**< number of workers that have done the work */
68
69   unsigned int num_workers;        /**< total number of worker threads including the controller */
70   xbt_os_thread_t *workers;        /**< worker thread handlers */
71   void_f_pvoid_t fun;              /**< function to run in parallel on each element of data */
72   xbt_dynar_t data;                /**< parameters to pass to fun in parallel */
73   unsigned int index;              /**< index of the next element of data to pick */
74
75 #ifdef HAVE_MC
76   int finish;
77   void* ref_snapshot;
78   int_f_pvoid_pvoid_t snapshot_compare;
79   unsigned int length;
80   void* mc_data;
81 #endif
82
83   /* posix only */
84   xbt_os_cond_t ready_cond;
85   xbt_os_mutex_t ready_mutex;
86   xbt_os_cond_t done_cond;
87   xbt_os_mutex_t done_mutex;
88
89   /* fields that depend on the synchronization mode */
90   e_xbt_parmap_mode_t mode;        /**< synchronization mode */
91   void (*master_wait_f)(xbt_parmap_t);    /**< wait for the workers to have done the work */
92   void (*worker_signal_f)(xbt_parmap_t);  /**< signal the master that a worker has done the work */
93   void (*master_signal_f)(xbt_parmap_t);  /**< wakes the workers threads to process tasks */
94   void (*worker_wait_f)(xbt_parmap_t, unsigned); /**< waits for more work */
95 } s_xbt_parmap_t;
96
97 /**
98  * \brief Thread data transmission structure
99  */
100 typedef struct s_xbt_parmap_thread_data{
101   xbt_parmap_t parmap;
102   int worker_id;
103 } s_xbt_parmap_thread_data_t;
104
105 typedef s_xbt_parmap_thread_data_t *xbt_parmap_thread_data_t;
106
107 /**
108  * \brief Creates a parallel map object
109  * \param num_workers number of worker threads to create
110  * \param mode how to synchronize the worker threads
111  * \return the parmap created
112  */
113 xbt_parmap_t xbt_parmap_new(unsigned int num_workers, e_xbt_parmap_mode_t mode)
114 {
115   unsigned int i;
116
117   XBT_DEBUG("Create new parmap (%u workers)", num_workers);
118
119   /* Initialize the thread pool data structure */
120   xbt_parmap_t parmap = xbt_new0(s_xbt_parmap_t, 1);
121   parmap->workers = xbt_new(xbt_os_thread_t, num_workers);
122
123   parmap->num_workers = num_workers;
124   parmap->status = XBT_PARMAP_WORK;
125   xbt_parmap_set_mode(parmap, mode);
126
127   /* Create the pool of worker threads */
128   xbt_parmap_thread_data_t data;
129   parmap->workers[0] = NULL;
130   for (i = 1; i < num_workers; i++) {
131     data = xbt_new0(s_xbt_parmap_thread_data_t, 1);
132     data->parmap = parmap;
133     data->worker_id = i;
134     parmap->workers[i] = xbt_os_thread_create(NULL, xbt_parmap_worker_main,
135                                               data, NULL);
136   }
137   return parmap;
138 }
139
140 #ifdef HAVE_MC
141 /**
142  * \brief Creates a parallel map object
143  * \param num_workers number of worker threads to create
144  * \param mode how to synchronize the worker threads
145  * \return the parmap created
146  */
147 xbt_parmap_t xbt_parmap_mc_new(unsigned int num_workers, e_xbt_parmap_mode_t mode)
148 {
149   unsigned int i;
150
151   XBT_DEBUG("Create new parmap (%u workers)", num_workers);
152
153   /* Initialize the thread pool data structure */
154   xbt_parmap_t parmap = xbt_new0(s_xbt_parmap_t, 1);
155   parmap->workers = xbt_new(xbt_os_thread_t, num_workers);
156
157   parmap->num_workers = num_workers;
158   parmap->status = XBT_PARMAP_WORK;
159   xbt_parmap_set_mode(parmap, mode);
160
161   /* Create the pool of worker threads */
162   xbt_parmap_thread_data_t data;
163   parmap->workers[0] = NULL;
164   for (i = 1; i < num_workers; i++) {
165     data = xbt_new0(s_xbt_parmap_thread_data_t, 1);
166     data->parmap = parmap;
167     data->worker_id = i;
168     parmap->workers[i] = xbt_os_thread_create(NULL, xbt_parmap_mc_worker_main,
169                                               data, NULL);
170   }
171   return parmap;
172 }
173 #endif
174
175 /**
176  * \brief Destroys a parmap
177  * \param parmap the parmap to destroy
178  */
179 void xbt_parmap_destroy(xbt_parmap_t parmap)
180 {
181   if (!parmap) {
182     return;
183   }
184
185   parmap->status = XBT_PARMAP_DESTROY;
186   parmap->master_signal_f(parmap);
187
188   unsigned int i;
189   for (i = 1; i < parmap->num_workers; i++)
190     xbt_os_thread_join(parmap->workers[i], NULL);
191
192   xbt_os_cond_destroy(parmap->ready_cond);
193   xbt_os_mutex_destroy(parmap->ready_mutex);
194   xbt_os_cond_destroy(parmap->done_cond);
195   xbt_os_mutex_destroy(parmap->done_mutex);
196
197   xbt_free(parmap->workers);
198   xbt_free(parmap);
199 }
200
201 /**
202  * \brief Sets the synchronization mode of a parmap.
203  * \param parmap a parallel map object
204  * \param mode the synchronization mode
205  */
206 static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode)
207 {
208   if (mode == XBT_PARMAP_DEFAULT) {
209 #ifdef HAVE_FUTEX_H
210     mode = XBT_PARMAP_FUTEX;
211 #else
212     mode = XBT_PARMAP_POSIX;
213 #endif
214   }
215   parmap->mode = mode;
216
217   switch (mode) {
218
219     case XBT_PARMAP_POSIX:
220       parmap->master_wait_f = xbt_parmap_posix_master_wait;
221       parmap->worker_signal_f = xbt_parmap_posix_worker_signal;
222       parmap->master_signal_f = xbt_parmap_posix_master_signal;
223       parmap->worker_wait_f = xbt_parmap_posix_worker_wait;
224
225       parmap->ready_cond = xbt_os_cond_init();
226       parmap->ready_mutex = xbt_os_mutex_init();
227       parmap->done_cond = xbt_os_cond_init();
228       parmap->done_mutex = xbt_os_mutex_init();
229       break;
230
231
232     case XBT_PARMAP_FUTEX:
233 #ifdef HAVE_FUTEX_H
234       parmap->master_wait_f = xbt_parmap_futex_master_wait;
235       parmap->worker_signal_f = xbt_parmap_futex_worker_signal;
236       parmap->master_signal_f = xbt_parmap_futex_master_signal;
237       parmap->worker_wait_f = xbt_parmap_futex_worker_wait;
238
239       xbt_os_cond_destroy(parmap->ready_cond);
240       xbt_os_mutex_destroy(parmap->ready_mutex);
241       xbt_os_cond_destroy(parmap->done_cond);
242       xbt_os_mutex_destroy(parmap->done_mutex);
243       break;
244 #else
245       xbt_die("Futex is not available on this OS.");
246 #endif
247
248     case XBT_PARMAP_BUSY_WAIT:
249       parmap->master_wait_f = xbt_parmap_busy_master_wait;
250       parmap->worker_signal_f = xbt_parmap_busy_worker_signal;
251       parmap->master_signal_f = xbt_parmap_busy_master_signal;
252       parmap->worker_wait_f = xbt_parmap_busy_worker_wait;
253
254       xbt_os_cond_destroy(parmap->ready_cond);
255       xbt_os_mutex_destroy(parmap->ready_mutex);
256       xbt_os_cond_destroy(parmap->done_cond);
257       xbt_os_mutex_destroy(parmap->done_mutex);
258       break;
259
260     case XBT_PARMAP_DEFAULT:
261       THROW_IMPOSSIBLE;
262       break;
263   }
264 }
265
266 /**
267  * \brief Applies a list of tasks in parallel.
268  * \param parmap a parallel map object
269  * \param fun the function to call in parallel
270  * \param data each element of this dynar will be passed as an argument to fun
271  */
272 void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
273 {
274   /* Assign resources to worker threads */
275   parmap->fun = fun;
276   parmap->data = data;
277   parmap->index = 0;
278   parmap->master_signal_f(parmap);
279   xbt_parmap_work(parmap);
280   parmap->master_wait_f(parmap);
281   XBT_DEBUG("Job done");
282 }
283
284 /**
285  * \brief Returns a next task to process.
286  *
287  * Worker threads call this function to get more work.
288  *
289  * \return the next task to process, or NULL if there is no more work
290  */
291 void* xbt_parmap_next(xbt_parmap_t parmap)
292 {
293   unsigned int index = __sync_fetch_and_add(&parmap->index, 1);
294   if (index < xbt_dynar_length(parmap->data)) {
295     return xbt_dynar_get_as(parmap->data, index, void*);
296   }
297   return NULL;
298 }
299
300 static void xbt_parmap_work(xbt_parmap_t parmap)
301 {
302   unsigned index;
303   while ((index = __sync_fetch_and_add(&parmap->index, 1))
304          < xbt_dynar_length(parmap->data))
305     parmap->fun(xbt_dynar_get_as(parmap->data, index, void*));
306 }
307
308 /**
309  * \brief Main function of a worker thread.
310  * \param arg the parmap
311  */
312 static void *xbt_parmap_worker_main(void *arg)
313 {
314   xbt_parmap_thread_data_t data = (xbt_parmap_thread_data_t) arg;
315   xbt_parmap_t parmap = data->parmap;
316   unsigned round = 0;
317   smx_context_t context = SIMIX_context_new(NULL, 0, NULL, NULL, NULL);
318   SIMIX_context_set_current(context);
319
320   XBT_DEBUG("New worker thread created");
321
322   /* Worker's main loop */
323   while (1) {
324     parmap->worker_wait_f(parmap, ++round);
325     if (parmap->status == XBT_PARMAP_WORK) {
326
327       XBT_DEBUG("Worker %d got a job", data->worker_id);
328
329       xbt_parmap_work(parmap);
330       parmap->worker_signal_f(parmap);
331
332       XBT_DEBUG("Worker %d has finished", data->worker_id);
333
334     /* We are destroying the parmap */
335     } else {
336       SIMIX_context_free(context);
337       xbt_free(data);
338       return NULL;
339     }
340   }
341 }
342
343 #ifdef HAVE_MC
344
345 /**
346  * \brief Applies a list of tasks in parallel.
347  * \param parmap a parallel map object
348  * \param fun the function to call in parallel
349  * \param data each element of this dynar will be passed as an argument to fun
350  */
351 int xbt_parmap_mc_apply(xbt_parmap_t parmap, int_f_pvoid_pvoid_t fun, 
352                          void* data, unsigned int length,  void* ref_snapshot)
353 {
354   /* Assign resources to worker threads */
355   parmap->snapshot_compare = fun;
356   parmap->mc_data = data;
357   parmap->index = 0;
358   parmap->finish = -1;
359   parmap->length = length;
360   parmap->ref_snapshot = ref_snapshot;
361   parmap->master_signal_f(parmap);
362   xbt_parmap_mc_work(parmap, 0);
363   parmap->master_wait_f(parmap);
364   XBT_DEBUG("Job done");
365   return parmap->finish;
366 }
367
368 static void xbt_parmap_mc_work(xbt_parmap_t parmap, int worker_id)
369 {
370   unsigned int data_size = (parmap->length / parmap->num_workers) +
371     ((parmap->length % parmap->num_workers) ? 1 :0);
372   void* start = (char*)parmap->mc_data + (data_size*worker_id*sizeof(void*));
373   void* end = MIN((char *)start + data_size* sizeof(void*), (char*)parmap->mc_data + parmap->length*sizeof(void*));
374   
375   //XBT_CRITICAL("Worker %d : %p -> %p (%d)", worker_id, start, end, data_size);
376
377   while ( start < end && parmap->finish == -1) {
378     //XBT_CRITICAL("Starting with %p", start);
379     int res = parmap->snapshot_compare(*(void**)start, parmap->ref_snapshot);
380     start = (char *)start + sizeof(start);
381     if (!res){
382     
383       parmap->finish = ((char*)start - (char*)parmap->mc_data) / sizeof(void*);
384       //XBT_CRITICAL("Find good one %p (%p)", start, parmap->mc_data);
385       break;
386     }
387   }
388 }
389
390 /**
391  * \brief Main function of a worker thread.
392  * \param arg the parmap
393  */
394 static void *xbt_parmap_mc_worker_main(void *arg)
395 {
396   xbt_parmap_thread_data_t data = (xbt_parmap_thread_data_t) arg;
397   xbt_parmap_t parmap = data->parmap;
398   unsigned round = 0;
399   /* smx_context_t context = SIMIX_context_new(NULL, 0, NULL, NULL, NULL); */
400   /* SIMIX_context_set_current(context); */
401
402   XBT_DEBUG("New worker thread created");
403
404   /* Worker's main loop */
405   while (1) {
406     parmap->worker_wait_f(parmap, ++round);
407     if (parmap->status == XBT_PARMAP_WORK) {
408
409       XBT_DEBUG("Worker %d got a job", data->worker_id);
410
411       xbt_parmap_mc_work(parmap, data->worker_id);
412       parmap->worker_signal_f(parmap);
413
414       XBT_DEBUG("Worker %d has finished", data->worker_id);
415
416     /* We are destroying the parmap */
417     } else {
418       xbt_free(data);
419       return NULL;
420     }
421   }
422 }
423 #endif
424
425 #ifdef HAVE_FUTEX_H
426 static void futex_wait(unsigned *uaddr, unsigned val)
427 {
428   XBT_VERB("Waiting on futex %p", uaddr);
429   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
430 }
431
432 static void futex_wake(unsigned *uaddr, unsigned val)
433 {
434   XBT_VERB("Waking futex %p", uaddr);
435   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
436 }
437 #endif
438
439 /**
440  * \brief Starts the parmap: waits for all workers to be ready and returns.
441  *
442  * This function is called by the controller thread.
443  *
444  * \param parmap a parmap
445  */
446 static void xbt_parmap_posix_master_wait(xbt_parmap_t parmap)
447 {
448   xbt_os_mutex_acquire(parmap->done_mutex);
449   if (parmap->thread_counter < parmap->num_workers) {
450     /* wait for all workers to be ready */
451     xbt_os_cond_wait(parmap->done_cond, parmap->done_mutex);
452   }
453   xbt_os_mutex_release(parmap->done_mutex);
454 }
455
456 /**
457  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
458  *
459  * This function is called by all worker threads when they end (not including
460  * the controller).
461  *
462  * \param parmap a parmap
463  */
464 static void xbt_parmap_posix_worker_signal(xbt_parmap_t parmap)
465 {
466   xbt_os_mutex_acquire(parmap->done_mutex);
467   if (++parmap->thread_counter == parmap->num_workers) {
468     /* all workers have finished, wake the controller */
469     xbt_os_cond_signal(parmap->done_cond);
470   }
471   xbt_os_mutex_release(parmap->done_mutex);
472 }
473
474 /**
475  * \brief Wakes all workers and waits for them to finish the tasks.
476  *
477  * This function is called by the controller thread.
478  *
479  * \param parmap a parmap
480  */
481 static void xbt_parmap_posix_master_signal(xbt_parmap_t parmap)
482 {
483   xbt_os_mutex_acquire(parmap->ready_mutex);
484   parmap->thread_counter = 1;
485   parmap->work++;
486   /* wake all workers */
487   xbt_os_cond_broadcast(parmap->ready_cond);
488   xbt_os_mutex_release(parmap->ready_mutex);
489 }
490
491 /**
492  * \brief Waits for some work to process.
493  *
494  * This function is called by each worker thread (not including the controller)
495  * when it has no more work to do.
496  *
497  * \param parmap a parmap
498  * \param round  the expected round number
499  */
500 static void xbt_parmap_posix_worker_wait(xbt_parmap_t parmap, unsigned round)
501 {
502   xbt_os_mutex_acquire(parmap->ready_mutex);
503   /* wait for more work */
504   if (parmap->work != round) {
505     xbt_os_cond_wait(parmap->ready_cond, parmap->ready_mutex);
506   }
507   xbt_os_mutex_release(parmap->ready_mutex);
508 }
509
510 #ifdef HAVE_FUTEX_H
511 /**
512  * \brief Starts the parmap: waits for all workers to be ready and returns.
513  *
514  * This function is called by the controller thread.
515  *
516  * \param parmap a parmap
517  */
518 static void xbt_parmap_futex_master_wait(xbt_parmap_t parmap)
519 {
520   unsigned count = parmap->thread_counter;
521   while (count < parmap->num_workers) {
522     /* wait for all workers to be ready */
523     futex_wait(&parmap->thread_counter, count);
524     count = parmap->thread_counter;
525   }
526 }
527
528 /**
529  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
530  *
531  * This function is called by all worker threads when they end (not including
532  * the controller).
533  *
534  * \param parmap a parmap
535  */
536 static void xbt_parmap_futex_worker_signal(xbt_parmap_t parmap)
537 {
538   unsigned count = __sync_add_and_fetch(&parmap->thread_counter, 1);
539   if (count == parmap->num_workers) {
540     /* all workers have finished, wake the controller */
541     futex_wake(&parmap->thread_counter, INT_MAX);
542   }
543 }
544
545 /**
546  * \brief Wakes all workers and waits for them to finish the tasks.
547  *
548  * This function is called by the controller thread.
549  *
550  * \param parmap a parmap
551  */
552 static void xbt_parmap_futex_master_signal(xbt_parmap_t parmap)
553 {
554   parmap->thread_counter = 1;
555   __sync_add_and_fetch(&parmap->work, 1);
556   /* wake all workers */
557   futex_wake(&parmap->work, INT_MAX);
558 }
559
560 /**
561  * \brief Waits for some work to process.
562  *
563  * This function is called by each worker thread (not including the controller)
564  * when it has no more work to do.
565  *
566  * \param parmap a parmap
567  * \param round  the expected round number
568  */
569 static void xbt_parmap_futex_worker_wait(xbt_parmap_t parmap, unsigned round)
570 {
571   unsigned work = parmap->work;
572   /* wait for more work */
573   while (work != round) {
574     futex_wait(&parmap->work, work);
575     work = parmap->work;
576   }
577 }
578 #endif
579
580 /**
581  * \brief Starts the parmap: waits for all workers to be ready and returns.
582  *
583  * This function is called by the controller thread.
584  *
585  * \param parmap a parmap
586  */
587 static void xbt_parmap_busy_master_wait(xbt_parmap_t parmap)
588 {
589   while (parmap->thread_counter < parmap->num_workers) {
590     xbt_os_thread_yield();
591   }
592 }
593
594 /**
595  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
596  *
597  * This function is called by all worker threads when they end.
598  *
599  * \param parmap a parmap
600  */
601 static void xbt_parmap_busy_worker_signal(xbt_parmap_t parmap)
602 {
603   __sync_add_and_fetch(&parmap->thread_counter, 1);
604 }
605
606 /**
607  * \brief Wakes all workers and waits for them to finish the tasks.
608  *
609  * This function is called by the controller thread.
610  *
611  * \param parmap a parmap
612  */
613 static void xbt_parmap_busy_master_signal(xbt_parmap_t parmap)
614 {
615   parmap->thread_counter = 1;
616   __sync_add_and_fetch(&parmap->work, 1);
617 }
618
619 /**
620  * \brief Waits for some work to process.
621  *
622  * This function is called by each worker thread (not including the controller)
623  * when it has no more work to do.
624  *
625  * \param parmap a parmap
626  * \param round  the expected round number
627  */
628 static void xbt_parmap_busy_worker_wait(xbt_parmap_t parmap, unsigned round)
629 {
630   /* wait for more work */
631   while (parmap->work != round) {
632     xbt_os_thread_yield();
633   }
634 }