Logo AND Algorithmique Numérique Distribuée

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