Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Join worker threads on parmap destroy.
[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     xbt_os_thread_detach(worker);
171   }
172   return parmap;
173 }
174 #endif
175
176 /**
177  * \brief Destroys a parmap
178  * \param parmap the parmap to destroy
179  */
180 void xbt_parmap_destroy(xbt_parmap_t parmap)
181 {
182   if (!parmap) {
183     return;
184   }
185
186   parmap->status = XBT_PARMAP_DESTROY;
187   parmap->master_signal_f(parmap);
188
189   unsigned int i;
190   for (i = 1; i < parmap->num_workers; i++)
191     xbt_os_thread_join(parmap->workers[i], NULL);
192
193   xbt_os_cond_destroy(parmap->ready_cond);
194   xbt_os_mutex_destroy(parmap->ready_mutex);
195   xbt_os_cond_destroy(parmap->done_cond);
196   xbt_os_mutex_destroy(parmap->done_mutex);
197
198   xbt_free(parmap->workers);
199   xbt_free(parmap);
200 }
201
202 /**
203  * \brief Sets the synchronization mode of a parmap.
204  * \param parmap a parallel map object
205  * \param mode the synchronization mode
206  */
207 static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode)
208 {
209   if (mode == XBT_PARMAP_DEFAULT) {
210 #ifdef HAVE_FUTEX_H
211     mode = XBT_PARMAP_FUTEX;
212 #else
213     mode = XBT_PARMAP_POSIX;
214 #endif
215   }
216   parmap->mode = mode;
217
218   switch (mode) {
219
220     case XBT_PARMAP_POSIX:
221       parmap->master_wait_f = xbt_parmap_posix_master_wait;
222       parmap->worker_signal_f = xbt_parmap_posix_worker_signal;
223       parmap->master_signal_f = xbt_parmap_posix_master_signal;
224       parmap->worker_wait_f = xbt_parmap_posix_worker_wait;
225
226       parmap->ready_cond = xbt_os_cond_init();
227       parmap->ready_mutex = xbt_os_mutex_init();
228       parmap->done_cond = xbt_os_cond_init();
229       parmap->done_mutex = xbt_os_mutex_init();
230       break;
231
232
233     case XBT_PARMAP_FUTEX:
234 #ifdef HAVE_FUTEX_H
235       parmap->master_wait_f = xbt_parmap_futex_master_wait;
236       parmap->worker_signal_f = xbt_parmap_futex_worker_signal;
237       parmap->master_signal_f = xbt_parmap_futex_master_signal;
238       parmap->worker_wait_f = xbt_parmap_futex_worker_wait;
239
240       xbt_os_cond_destroy(parmap->ready_cond);
241       xbt_os_mutex_destroy(parmap->ready_mutex);
242       xbt_os_cond_destroy(parmap->done_cond);
243       xbt_os_mutex_destroy(parmap->done_mutex);
244       break;
245 #else
246       xbt_die("Futex is not available on this OS.");
247 #endif
248
249     case XBT_PARMAP_BUSY_WAIT:
250       parmap->master_wait_f = xbt_parmap_busy_master_wait;
251       parmap->worker_signal_f = xbt_parmap_busy_worker_signal;
252       parmap->master_signal_f = xbt_parmap_busy_master_signal;
253       parmap->worker_wait_f = xbt_parmap_busy_worker_wait;
254
255       xbt_os_cond_destroy(parmap->ready_cond);
256       xbt_os_mutex_destroy(parmap->ready_mutex);
257       xbt_os_cond_destroy(parmap->done_cond);
258       xbt_os_mutex_destroy(parmap->done_mutex);
259       break;
260
261     case XBT_PARMAP_DEFAULT:
262       THROW_IMPOSSIBLE;
263       break;
264   }
265 }
266
267 /**
268  * \brief Applies a list of tasks in parallel.
269  * \param parmap a parallel map object
270  * \param fun the function to call in parallel
271  * \param data each element of this dynar will be passed as an argument to fun
272  */
273 void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
274 {
275   /* Assign resources to worker threads */
276   parmap->fun = fun;
277   parmap->data = data;
278   parmap->index = 0;
279   parmap->master_signal_f(parmap);
280   xbt_parmap_work(parmap);
281   parmap->master_wait_f(parmap);
282   XBT_DEBUG("Job done");
283 }
284
285 /**
286  * \brief Returns a next task to process.
287  *
288  * Worker threads call this function to get more work.
289  *
290  * \return the next task to process, or NULL if there is no more work
291  */
292 void* xbt_parmap_next(xbt_parmap_t parmap)
293 {
294   unsigned int index = __sync_fetch_and_add(&parmap->index, 1);
295   if (index < xbt_dynar_length(parmap->data)) {
296     return xbt_dynar_get_as(parmap->data, index, void*);
297   }
298   return NULL;
299 }
300
301 static void xbt_parmap_work(xbt_parmap_t parmap)
302 {
303   unsigned index;
304   while ((index = __sync_fetch_and_add(&parmap->index, 1))
305          < xbt_dynar_length(parmap->data))
306     parmap->fun(xbt_dynar_get_as(parmap->data, index, void*));
307 }
308
309 /**
310  * \brief Main function of a worker thread.
311  * \param arg the parmap
312  */
313 static void *xbt_parmap_worker_main(void *arg)
314 {
315   xbt_parmap_thread_data_t data = (xbt_parmap_thread_data_t) arg;
316   xbt_parmap_t parmap = data->parmap;
317   unsigned round = 0;
318   smx_context_t context = SIMIX_context_new(NULL, 0, NULL, NULL, NULL);
319   SIMIX_context_set_current(context);
320
321   XBT_DEBUG("New worker thread created");
322
323   /* Worker's main loop */
324   while (1) {
325     parmap->worker_wait_f(parmap, ++round);
326     if (parmap->status == XBT_PARMAP_WORK) {
327
328       XBT_DEBUG("Worker %d got a job", data->worker_id);
329
330       xbt_parmap_work(parmap);
331       parmap->worker_signal_f(parmap);
332
333       XBT_DEBUG("Worker %d has finished", data->worker_id);
334
335     /* We are destroying the parmap */
336     } else {
337       SIMIX_context_free(context);
338       xbt_free(data);
339       return NULL;
340     }
341   }
342 }
343
344 #ifdef HAVE_MC
345
346 /**
347  * \brief Applies a list of tasks in parallel.
348  * \param parmap a parallel map object
349  * \param fun the function to call in parallel
350  * \param data each element of this dynar will be passed as an argument to fun
351  */
352 int xbt_parmap_mc_apply(xbt_parmap_t parmap, int_f_pvoid_pvoid_t fun, 
353                          void* data, unsigned int length,  void* ref_snapshot)
354 {
355   /* Assign resources to worker threads */
356   parmap->snapshot_compare = fun;
357   parmap->mc_data = data;
358   parmap->index = 0;
359   parmap->finish = -1;
360   parmap->length = length;
361   parmap->ref_snapshot = ref_snapshot;
362   parmap->master_signal_f(parmap);
363   xbt_parmap_mc_work(parmap, 0);
364   parmap->master_wait_f(parmap);
365   XBT_DEBUG("Job done");
366   return parmap->finish;
367 }
368
369 static void xbt_parmap_mc_work(xbt_parmap_t parmap, int worker_id)
370 {
371   unsigned int data_size = (parmap->length / parmap->num_workers) +
372     ((parmap->length % parmap->num_workers) ? 1 :0);
373   void* start = (char*)parmap->mc_data + (data_size*worker_id*sizeof(void*));
374   void* end = MIN((char *)start + data_size* sizeof(void*), (char*)parmap->mc_data + parmap->length*sizeof(void*));
375   
376   //XBT_CRITICAL("Worker %d : %p -> %p (%d)", worker_id, start, end, data_size);
377
378   while ( start < end && parmap->finish == -1) {
379     //XBT_CRITICAL("Starting with %p", start);
380     int res = parmap->snapshot_compare(*(void**)start, parmap->ref_snapshot);
381     start = (char *)start + sizeof(start);
382     if (!res){
383     
384       parmap->finish = ((char*)start - (char*)parmap->mc_data) / sizeof(void*);
385       //XBT_CRITICAL("Find good one %p (%p)", start, parmap->mc_data);
386       break;
387     }
388   }
389 }
390
391 /**
392  * \brief Main function of a worker thread.
393  * \param arg the parmap
394  */
395 static void *xbt_parmap_mc_worker_main(void *arg)
396 {
397   xbt_parmap_thread_data_t data = (xbt_parmap_thread_data_t) arg;
398   xbt_parmap_t parmap = data->parmap;
399   unsigned round = 0;
400   /* smx_context_t context = SIMIX_context_new(NULL, 0, NULL, NULL, NULL); */
401   /* SIMIX_context_set_current(context); */
402
403   XBT_DEBUG("New worker thread created");
404
405   /* Worker's main loop */
406   while (1) {
407     parmap->worker_wait_f(parmap, ++round);
408     if (parmap->status == XBT_PARMAP_WORK) {
409
410       XBT_DEBUG("Worker %d got a job", data->worker_id);
411
412       xbt_parmap_mc_work(parmap, data->worker_id);
413       parmap->worker_signal_f(parmap);
414
415       XBT_DEBUG("Worker %d has finished", data->worker_id);
416
417     /* We are destroying the parmap */
418     } else {
419       xbt_free(data);
420       return NULL;
421     }
422   }
423 }
424 #endif
425
426 #ifdef HAVE_FUTEX_H
427 static void futex_wait(unsigned *uaddr, unsigned val)
428 {
429   XBT_VERB("Waiting on futex %p", uaddr);
430   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
431 }
432
433 static void futex_wake(unsigned *uaddr, unsigned val)
434 {
435   XBT_VERB("Waking futex %p", uaddr);
436   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
437 }
438 #endif
439
440 /**
441  * \brief Starts the parmap: waits for all workers to be ready and returns.
442  *
443  * This function is called by the controller thread.
444  *
445  * \param parmap a parmap
446  */
447 static void xbt_parmap_posix_master_wait(xbt_parmap_t parmap)
448 {
449   xbt_os_mutex_acquire(parmap->done_mutex);
450   if (parmap->thread_counter < parmap->num_workers) {
451     /* wait for all workers to be ready */
452     xbt_os_cond_wait(parmap->done_cond, parmap->done_mutex);
453   }
454   xbt_os_mutex_release(parmap->done_mutex);
455 }
456
457 /**
458  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
459  *
460  * This function is called by all worker threads when they end (not including
461  * the controller).
462  *
463  * \param parmap a parmap
464  */
465 static void xbt_parmap_posix_worker_signal(xbt_parmap_t parmap)
466 {
467   xbt_os_mutex_acquire(parmap->done_mutex);
468   if (++parmap->thread_counter == parmap->num_workers) {
469     /* all workers have finished, wake the controller */
470     xbt_os_cond_signal(parmap->done_cond);
471   }
472   xbt_os_mutex_release(parmap->done_mutex);
473 }
474
475 /**
476  * \brief Wakes all workers and waits for them to finish the tasks.
477  *
478  * This function is called by the controller thread.
479  *
480  * \param parmap a parmap
481  */
482 static void xbt_parmap_posix_master_signal(xbt_parmap_t parmap)
483 {
484   xbt_os_mutex_acquire(parmap->ready_mutex);
485   parmap->thread_counter = 1;
486   parmap->work++;
487   /* wake all workers */
488   xbt_os_cond_broadcast(parmap->ready_cond);
489   xbt_os_mutex_release(parmap->ready_mutex);
490 }
491
492 /**
493  * \brief Waits for some work to process.
494  *
495  * This function is called by each worker thread (not including the controller)
496  * when it has no more work to do.
497  *
498  * \param parmap a parmap
499  * \param round  the expected round number
500  */
501 static void xbt_parmap_posix_worker_wait(xbt_parmap_t parmap, unsigned round)
502 {
503   xbt_os_mutex_acquire(parmap->ready_mutex);
504   /* wait for more work */
505   if (parmap->work != round) {
506     xbt_os_cond_wait(parmap->ready_cond, parmap->ready_mutex);
507   }
508   xbt_os_mutex_release(parmap->ready_mutex);
509 }
510
511 #ifdef HAVE_FUTEX_H
512 /**
513  * \brief Starts the parmap: waits for all workers to be ready and returns.
514  *
515  * This function is called by the controller thread.
516  *
517  * \param parmap a parmap
518  */
519 static void xbt_parmap_futex_master_wait(xbt_parmap_t parmap)
520 {
521   unsigned count = parmap->thread_counter;
522   while (count < parmap->num_workers) {
523     /* wait for all workers to be ready */
524     futex_wait(&parmap->thread_counter, count);
525     count = parmap->thread_counter;
526   }
527 }
528
529 /**
530  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
531  *
532  * This function is called by all worker threads when they end (not including
533  * the controller).
534  *
535  * \param parmap a parmap
536  */
537 static void xbt_parmap_futex_worker_signal(xbt_parmap_t parmap)
538 {
539   unsigned count = __sync_add_and_fetch(&parmap->thread_counter, 1);
540   if (count == parmap->num_workers) {
541     /* all workers have finished, wake the controller */
542     futex_wake(&parmap->thread_counter, INT_MAX);
543   }
544 }
545
546 /**
547  * \brief Wakes all workers and waits for them to finish the tasks.
548  *
549  * This function is called by the controller thread.
550  *
551  * \param parmap a parmap
552  */
553 static void xbt_parmap_futex_master_signal(xbt_parmap_t parmap)
554 {
555   parmap->thread_counter = 1;
556   __sync_add_and_fetch(&parmap->work, 1);
557   /* wake all workers */
558   futex_wake(&parmap->work, INT_MAX);
559 }
560
561 /**
562  * \brief Waits for some work to process.
563  *
564  * This function is called by each worker thread (not including the controller)
565  * when it has no more work to do.
566  *
567  * \param parmap a parmap
568  * \param round  the expected round number
569  */
570 static void xbt_parmap_futex_worker_wait(xbt_parmap_t parmap, unsigned round)
571 {
572   unsigned work = parmap->work;
573   /* wait for more work */
574   while (work != round) {
575     futex_wait(&parmap->work, work);
576     work = parmap->work;
577   }
578 }
579 #endif
580
581 /**
582  * \brief Starts the parmap: waits for all workers to be ready and returns.
583  *
584  * This function is called by the controller thread.
585  *
586  * \param parmap a parmap
587  */
588 static void xbt_parmap_busy_master_wait(xbt_parmap_t parmap)
589 {
590   while (parmap->thread_counter < parmap->num_workers) {
591     xbt_os_thread_yield();
592   }
593 }
594
595 /**
596  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
597  *
598  * This function is called by all worker threads when they end.
599  *
600  * \param parmap a parmap
601  */
602 static void xbt_parmap_busy_worker_signal(xbt_parmap_t parmap)
603 {
604   __sync_add_and_fetch(&parmap->thread_counter, 1);
605 }
606
607 /**
608  * \brief Wakes all workers and waits for them to finish the tasks.
609  *
610  * This function is called by the controller thread.
611  *
612  * \param parmap a parmap
613  */
614 static void xbt_parmap_busy_master_signal(xbt_parmap_t parmap)
615 {
616   parmap->thread_counter = 1;
617   __sync_add_and_fetch(&parmap->work, 1);
618 }
619
620 /**
621  * \brief Waits for some work to process.
622  *
623  * This function is called by each worker thread (not including the controller)
624  * when it has no more work to do.
625  *
626  * \param parmap a parmap
627  * \param round  the expected round number
628  */
629 static void xbt_parmap_busy_worker_wait(xbt_parmap_t parmap, unsigned round)
630 {
631   /* wait for more work */
632   while (parmap->work != round) {
633     xbt_os_thread_yield();
634   }
635 }