Logo AND Algorithmique Numérique Distribuée

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