Logo AND Algorithmique Numérique Distribuée

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