1 /* Copyright (c) 2004-2005, 2007, 2009-2014. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "internal_config.h"
11 #include <sys/syscall.h>
15 #include <linux/futex.h>
19 #include "xbt/parmap.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"
27 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_parmap, xbt, "parmap: parallel map");
32 } e_xbt_parmap_flag_t;
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);
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);
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);
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);
58 static void xbt_parmap_mc_work(xbt_parmap_t parmap, int worker_id);
59 static void *xbt_parmap_mc_worker_main(void *arg);
63 * \brief Parallel map structure
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 */
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 */
79 int_f_pvoid_pvoid_t snapshot_compare;
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;
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 */
99 * \brief Thread data transmission structure
101 typedef struct s_xbt_parmap_thread_data{
104 } s_xbt_parmap_thread_data_t;
106 typedef s_xbt_parmap_thread_data_t *xbt_parmap_thread_data_t;
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
114 xbt_parmap_t xbt_parmap_new(unsigned int num_workers, e_xbt_parmap_mode_t mode)
118 XBT_DEBUG("Create new parmap (%u workers)", num_workers);
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);
124 parmap->num_workers = num_workers;
125 parmap->status = XBT_PARMAP_WORK;
126 xbt_parmap_set_mode(parmap, mode);
128 /* Create the pool of worker threads */
129 xbt_parmap_thread_data_t data;
130 parmap->workers[0] = NULL;
132 unsigned int core_bind = 0;
134 for (i = 1; i < num_workers; i++) {
135 data = xbt_new0(s_xbt_parmap_thread_data_t, 1);
136 data->parmap = parmap;
138 parmap->workers[i] = xbt_os_thread_create(NULL, xbt_parmap_worker_main,
141 xbt_os_thread_bind(parmap->workers[i], core_bind);
142 if(core_bind!=xbt_os_get_numcores()){
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
159 xbt_parmap_t xbt_parmap_mc_new(unsigned int num_workers, e_xbt_parmap_mode_t mode)
163 XBT_DEBUG("Create new parmap (%u workers)", num_workers);
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);
169 parmap->num_workers = num_workers;
170 parmap->status = XBT_PARMAP_WORK;
171 xbt_parmap_set_mode(parmap, mode);
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;
180 parmap->workers[i] = xbt_os_thread_create(NULL, xbt_parmap_mc_worker_main,
188 * \brief Destroys a parmap
189 * \param parmap the parmap to destroy
191 void xbt_parmap_destroy(xbt_parmap_t parmap)
197 parmap->status = XBT_PARMAP_DESTROY;
198 parmap->master_signal_f(parmap);
201 for (i = 1; i < parmap->num_workers; i++)
202 xbt_os_thread_join(parmap->workers[i], NULL);
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);
209 xbt_free(parmap->workers);
214 * \brief Sets the synchronization mode of a parmap.
215 * \param parmap a parallel map object
216 * \param mode the synchronization mode
218 static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode)
220 if (mode == XBT_PARMAP_DEFAULT) {
222 mode = XBT_PARMAP_FUTEX;
224 mode = XBT_PARMAP_POSIX;
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;
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();
244 case XBT_PARMAP_FUTEX:
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;
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);
257 xbt_die("Futex is not available on this OS.");
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;
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);
272 case XBT_PARMAP_DEFAULT:
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
284 void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
286 /* Assign resources to worker threads (we are maestro here)*/
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
297 * \brief Returns a next task to process.
299 * Worker threads call this function to get more work.
301 * \return the next task to process, or NULL if there is no more work
303 void* xbt_parmap_next(xbt_parmap_t parmap)
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*);
312 static void xbt_parmap_work(xbt_parmap_t parmap)
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*));
321 * \brief Main function of a worker thread.
322 * \param arg the parmap
324 static void *xbt_parmap_worker_main(void *arg)
326 xbt_parmap_thread_data_t data = (xbt_parmap_thread_data_t) arg;
327 xbt_parmap_t parmap = data->parmap;
329 smx_context_t context = SIMIX_context_new(NULL, 0, NULL, NULL, NULL);
330 SIMIX_context_set_current(context);
332 XBT_DEBUG("New worker thread created");
334 /* Worker's main loop */
336 parmap->worker_wait_f(parmap, ++round);
337 if (parmap->status == XBT_PARMAP_WORK) {
339 XBT_DEBUG("Worker %d got a job", data->worker_id);
341 xbt_parmap_work(parmap);
342 parmap->worker_signal_f(parmap);
344 XBT_DEBUG("Worker %d has finished", data->worker_id);
346 /* We are destroying the parmap */
348 SIMIX_context_free(context);
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
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)
366 /* Assign resources to worker threads */
367 parmap->snapshot_compare = fun;
368 parmap->mc_data = data;
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;
380 static void xbt_parmap_mc_work(xbt_parmap_t parmap, int worker_id)
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*));
387 //XBT_CRITICAL("Worker %d : %p -> %p (%d)", worker_id, start, end, data_size);
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);
395 parmap->finish = ((char*)start - (char*)parmap->mc_data) / sizeof(void*);
396 //XBT_CRITICAL("Find good one %p (%p)", start, parmap->mc_data);
403 * \brief Main function of a worker thread.
404 * \param arg the parmap
406 static void *xbt_parmap_mc_worker_main(void *arg)
408 xbt_parmap_thread_data_t data = (xbt_parmap_thread_data_t) arg;
409 xbt_parmap_t parmap = data->parmap;
411 /* smx_context_t context = SIMIX_context_new(NULL, 0, NULL, NULL, NULL); */
412 /* SIMIX_context_set_current(context); */
414 XBT_DEBUG("New worker thread created");
416 /* Worker's main loop */
418 parmap->worker_wait_f(parmap, ++round);
419 if (parmap->status == XBT_PARMAP_WORK) {
421 XBT_DEBUG("Worker %d got a job", data->worker_id);
423 xbt_parmap_mc_work(parmap, data->worker_id);
424 parmap->worker_signal_f(parmap);
426 XBT_DEBUG("Worker %d has finished", data->worker_id);
428 /* We are destroying the parmap */
438 static void futex_wait(unsigned *uaddr, unsigned val)
440 XBT_VERB("Waiting on futex %p", uaddr);
441 syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
444 static void futex_wake(unsigned *uaddr, unsigned val)
446 XBT_VERB("Waking futex %p", uaddr);
447 syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
452 * \brief Starts the parmap: waits for all workers to be ready and returns.
454 * This function is called by the controller thread.
456 * \param parmap a parmap
458 static void xbt_parmap_posix_master_wait(xbt_parmap_t parmap)
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);
465 xbt_os_mutex_release(parmap->done_mutex);
469 * \brief Ends the parmap: wakes the controller thread when all workers terminate.
471 * This function is called by all worker threads when they end (not including
474 * \param parmap a parmap
476 static void xbt_parmap_posix_worker_signal(xbt_parmap_t parmap)
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);
483 xbt_os_mutex_release(parmap->done_mutex);
487 * \brief Wakes all workers and waits for them to finish the tasks.
489 * This function is called by the controller thread.
491 * \param parmap a parmap
493 static void xbt_parmap_posix_master_signal(xbt_parmap_t parmap)
495 xbt_os_mutex_acquire(parmap->ready_mutex);
496 parmap->thread_counter = 1;
498 /* wake all workers */
499 xbt_os_cond_broadcast(parmap->ready_cond);
500 xbt_os_mutex_release(parmap->ready_mutex);
504 * \brief Waits for some work to process.
506 * This function is called by each worker thread (not including the controller)
507 * when it has no more work to do.
509 * \param parmap a parmap
510 * \param round the expected round number
512 static void xbt_parmap_posix_worker_wait(xbt_parmap_t parmap, unsigned round)
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);
519 xbt_os_mutex_release(parmap->ready_mutex);
524 * \brief Starts the parmap: waits for all workers to be ready and returns.
526 * This function is called by the controller thread.
528 * \param parmap a parmap
530 static void xbt_parmap_futex_master_wait(xbt_parmap_t parmap)
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;
541 * \brief Ends the parmap: wakes the controller thread when all workers terminate.
543 * This function is called by all worker threads when they end (not including
546 * \param parmap a parmap
548 static void xbt_parmap_futex_worker_signal(xbt_parmap_t parmap)
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);
558 * \brief Wakes all workers and waits for them to finish the tasks.
560 * This function is called by the controller thread.
562 * \param parmap a parmap
564 static void xbt_parmap_futex_master_signal(xbt_parmap_t parmap)
566 parmap->thread_counter = 1;
567 __sync_add_and_fetch(&parmap->work, 1);
568 /* wake all workers */
569 futex_wake(&parmap->work, INT_MAX);
573 * \brief Waits for some work to process.
575 * This function is called by each worker thread (not including the controller)
576 * when it has no more work to do.
578 * \param parmap a parmap
579 * \param round the expected round number
581 static void xbt_parmap_futex_worker_wait(xbt_parmap_t parmap, unsigned round)
583 unsigned work = parmap->work;
584 /* wait for more work */
585 while (work != round) {
586 futex_wait(&parmap->work, work);
593 * \brief Starts the parmap: waits for all workers to be ready and returns.
595 * This function is called by the controller thread.
597 * \param parmap a parmap
599 static void xbt_parmap_busy_master_wait(xbt_parmap_t parmap)
601 while (parmap->thread_counter < parmap->num_workers) {
602 xbt_os_thread_yield();
607 * \brief Ends the parmap: wakes the controller thread when all workers terminate.
609 * This function is called by all worker threads when they end.
611 * \param parmap a parmap
613 static void xbt_parmap_busy_worker_signal(xbt_parmap_t parmap)
615 __sync_add_and_fetch(&parmap->thread_counter, 1);
619 * \brief Wakes all workers and waits for them to finish the tasks.
621 * This function is called by the controller thread.
623 * \param parmap a parmap
625 static void xbt_parmap_busy_master_signal(xbt_parmap_t parmap)
627 parmap->thread_counter = 1;
628 __sync_add_and_fetch(&parmap->work, 1);
632 * \brief Waits for some work to process.
634 * This function is called by each worker thread (not including the controller)
635 * when it has no more work to do.
637 * \param parmap a parmap
638 * \param round the expected round number
640 static void xbt_parmap_busy_worker_wait(xbt_parmap_t parmap, unsigned round)
642 /* wait for more work */
643 while (parmap->work != round) {
644 xbt_os_thread_yield();