X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d8308c2cacc831e01b98fa8e0d593f1480c25892..ccc485f3688249e70503ad250cb065b5b6d7748f:/src/xbt/parmap.c diff --git a/src/xbt/parmap.c b/src/xbt/parmap.c index b6de91b177..9f2f35bd49 100644 --- a/src/xbt/parmap.c +++ b/src/xbt/parmap.c @@ -3,156 +3,433 @@ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ +#include "gras_config.h" #include + +#ifndef _XBT_WIN32 #include +#endif + +#ifdef HAVE_FUTEX_H #include -#include -#include "parmap_private.h" +#endif + +#include "xbt/parmap.h" +#include "xbt/log.h" +#include "xbt/function_types.h" +#include "xbt/dynar.h" +#include "xbt/xbt_os_thread.h" +#include "xbt/sysdep.h" XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_parmap, xbt, "parmap: parallel map"); XBT_LOG_NEW_SUBCATEGORY(xbt_parmap_unit, xbt_parmap, "parmap unit testing"); -static void *_xbt_parmap_worker_main(void *parmap); +typedef enum { + XBT_PARMAP_WORK = 0, + XBT_PARMAP_DESTROY +} e_xbt_parmap_flag_t; + +static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode); +static void *xbt_parmap_worker_main(void *parmap); + +static void xbt_parmap_posix_start(xbt_parmap_t parmap); +static void xbt_parmap_posix_end(xbt_parmap_t parmap); +static void xbt_parmap_posix_signal(xbt_parmap_t parmap); +static void xbt_parmap_posix_wait(xbt_parmap_t parmap); +#ifdef HAVE_FUTEX_H +static void xbt_parmap_futex_start(xbt_parmap_t parmap); +static void xbt_parmap_futex_end(xbt_parmap_t parmap); +static void xbt_parmap_futex_signal(xbt_parmap_t parmap); +static void xbt_parmap_futex_wait(xbt_parmap_t parmap); static void futex_wait(int *uaddr, int val); static void futex_wake(int *uaddr, int val); - -xbt_parmap_t xbt_parmap_new(unsigned int num_workers) +#endif + +static void xbt_parmap_busy_start(xbt_parmap_t parmap); +static void xbt_parmap_busy_end(xbt_parmap_t parmap); +static void xbt_parmap_busy_signal(xbt_parmap_t parmap); +static void xbt_parmap_busy_wait(xbt_parmap_t parmap); + + +/** + * \brief Parallel map structure + */ +typedef struct s_xbt_parmap { + e_xbt_parmap_flag_t status; /**< is the parmap active or being destroyed? */ + int work; /**< index of the current round (1 is the first) */ + int done; /**< number of rounds already done (futexes only) */ + unsigned int thread_counter; /**< number of threads currently working */ + unsigned int num_workers; /**< total number of worker threads including the controller */ + void_f_pvoid_t fun; /**< function to run in parallel on each element of data */ + xbt_dynar_t data; /**< parameters to pass to fun in parallel */ + unsigned int index; /**< index of the next element of data to pick */ + + /* fields that depend on the synchronization mode */ + e_xbt_parmap_mode_t mode; /**< synchronization mode */ + void (*start_f)(xbt_parmap_t); /**< initializes the worker threads */ + void (*end_f)(xbt_parmap_t); /**< finalizes the worker threads */ + void (*signal_f)(xbt_parmap_t); /**< wakes the workers threads to process tasks */ + void (*wait_f)(xbt_parmap_t); /**< waits for more work */ +} s_xbt_parmap_t; + +/** + * \brief Creates a parallel map object + * \param num_workers number of worker threads to create + * \param mode how to synchronize the worker threads + * \return the parmap created + */ +xbt_parmap_t xbt_parmap_new(unsigned int num_workers, e_xbt_parmap_mode_t mode) { unsigned int i; xbt_os_thread_t worker = NULL; - DEBUG1("Create new parmap (%u workers)", num_workers); + XBT_DEBUG("Create new parmap (%u workers)", num_workers); /* Initialize the thread pool data structure */ xbt_parmap_t parmap = xbt_new0(s_xbt_parmap_t, 1); - parmap->num_workers = num_workers; - parmap->status = PARMAP_WORK; - parmap->workers_ready = xbt_new0(s_xbt_barrier_t, 1); - xbt_barrier_init(parmap->workers_ready, num_workers + 1); - parmap->workers_done = xbt_new0(s_xbt_barrier_t, 1); - xbt_barrier_init(parmap->workers_done, num_workers + 1); + parmap->num_workers = num_workers; + parmap->status = XBT_PARMAP_WORK; + xbt_parmap_set_mode(parmap, mode); /* Create the pool of worker threads */ - for(i=0; i < num_workers; i++){ - worker = xbt_os_thread_create(NULL, _xbt_parmap_worker_main, parmap, NULL); + for (i = 0; i < num_workers - 1; i++) { + worker = xbt_os_thread_create(NULL, xbt_parmap_worker_main, parmap, NULL); xbt_os_thread_detach(worker); } - + parmap->start_f(parmap); return parmap; } +/** + * \brief Destroys a parmap + * \param parmap the parmap to destroy + */ void xbt_parmap_destroy(xbt_parmap_t parmap) -{ - DEBUG1("Destroy parmap %p", parmap); - - parmap->status = PARMAP_DESTROY; - - xbt_barrier_wait(parmap->workers_ready); - DEBUG0("Kill job sent"); - xbt_barrier_wait(parmap->workers_done); - - xbt_free(parmap->workers_ready); - xbt_free(parmap->workers_done); +{ + parmap->status = XBT_PARMAP_DESTROY; + parmap->signal_f(parmap); xbt_free(parmap); } - void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data) +/** + * \brief Sets the synchronization mode of a parmap. + * \param parmap a parallel map object + * \param mode the synchronization mode + */ +static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode) { - /* Assign resources to worker threads*/ + if (mode == XBT_PARMAP_DEFAULT) { +#ifdef HAVE_FUTEX_H + mode = XBT_PARMAP_FUTEX; +#else + mode = XBT_PARMAP_POSIX; +#endif + } + parmap->mode = mode; + + switch (mode) { + + case XBT_PARMAP_POSIX: + parmap->start_f = xbt_parmap_posix_start; + parmap->end_f = xbt_parmap_posix_end; + parmap->signal_f = xbt_parmap_posix_signal; + parmap->wait_f = xbt_parmap_posix_wait; + break; + + + case XBT_PARMAP_FUTEX: +#ifdef HAVE_FUTEX_H + parmap->start_f = xbt_parmap_futex_start; + parmap->end_f = xbt_parmap_futex_end; + parmap->signal_f = xbt_parmap_futex_signal; + parmap->wait_f = xbt_parmap_futex_wait; + break; +#else + xbt_die("Futex is not available on this OS (maybe you are on a Mac)."); +#endif + + case XBT_PARMAP_BUSY_WAIT: + parmap->start_f = xbt_parmap_busy_start; + parmap->end_f = xbt_parmap_busy_end; + parmap->signal_f = xbt_parmap_busy_signal; + parmap->wait_f = xbt_parmap_busy_wait; + break; + + case XBT_PARMAP_DEFAULT: + THROW_IMPOSSIBLE; + break; + } +} + +/** + * \brief Applies a list of tasks in parallel. + * \param parmap a parallel map object + * \param fun the function to call in parallel + * \param data each element of this dynar will be passed as an argument to fun + */ +void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data) +{ + /* Assign resources to worker threads */ parmap->fun = fun; parmap->data = data; + parmap->index = 0; + parmap->signal_f(parmap); + XBT_DEBUG("Job done"); +} - /* Notify workers that there is a job */ - xbt_barrier_wait(parmap->workers_ready); - DEBUG0("Job dispatched, lets wait..."); - xbt_barrier_wait(parmap->workers_done); - - DEBUG0("Job done"); - parmap->fun = NULL; - parmap->data = NULL; +/** + * \brief Returns a next task to process. + * + * Worker threads call this function to get more work. + * + * \return the next task to process, or NULL if there is no more work + */ +void* xbt_parmap_next(xbt_parmap_t parmap) +{ + unsigned int index = __sync_fetch_and_add(&parmap->index, 1); + if (index < xbt_dynar_length(parmap->data)) { + return xbt_dynar_get_as(parmap->data, index, void*); + } + return NULL; } -static void *_xbt_parmap_worker_main(void *arg) +/** + * \brief Main function of a worker thread. + * \param arg the parmap + */ +static void *xbt_parmap_worker_main(void *arg) { - unsigned int data_start, data_end, data_size, worker_id; - xbt_parmap_t parmap = (xbt_parmap_t)arg; + xbt_parmap_t parmap = (xbt_parmap_t) arg; - /* Fetch a worker id */ - worker_id = __sync_fetch_and_add(&parmap->workers_max_id, 1); + XBT_DEBUG("New worker thread created"); - DEBUG1("New worker thread created (%u)", worker_id); - /* Worker's main loop */ - while(1){ - xbt_barrier_wait(parmap->workers_ready); - - if(parmap->status == PARMAP_WORK){ - DEBUG1("Worker %u got a job", worker_id); - - /* Compute how much data does every worker gets */ - data_size = (xbt_dynar_length(parmap->data) / parmap->num_workers) - + ((xbt_dynar_length(parmap->data) % parmap->num_workers) ? 1 : 0); + while (1) { + parmap->wait_f(parmap); + if (parmap->status == XBT_PARMAP_WORK) { - /* Each worker data segment starts in a position associated with its id*/ - data_start = data_size * worker_id; + XBT_DEBUG("Worker got a job"); - /* The end of the worker data segment must be bounded by the end of the data vector */ - data_end = MIN(data_start + data_size, xbt_dynar_length(parmap->data)); - - DEBUG4("Worker %u: data_start=%u data_end=%u (data_size=%u)", - worker_id, data_start, data_end, data_size); - - /* While the worker don't pass the end of it data segment apply the function */ - while(data_start < data_end){ - parmap->fun(*(void **)xbt_dynar_get_ptr(parmap->data, data_start)); - data_start++; + void* work = xbt_parmap_next(parmap); + while (work != NULL) { + parmap->fun(work); + work = xbt_parmap_next(parmap); } - xbt_barrier_wait(parmap->workers_done); + XBT_DEBUG("Worker has finished"); /* We are destroying the parmap */ - }else{ - xbt_barrier_wait(parmap->workers_done); - DEBUG1("Shutting down worker %u", worker_id); + } else { + parmap->end_f(parmap); + XBT_DEBUG("Shutting down worker"); return NULL; } } } +#ifdef HAVE_FUTEX_H static void futex_wait(int *uaddr, int val) { - DEBUG1("Waiting on futex %d", *uaddr); - syscall(SYS_futex, uaddr, FUTEX_WAIT, val, NULL, NULL, 0); + XBT_VERB("Waiting on futex %p", uaddr); + syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0); } static void futex_wake(int *uaddr, int val) { - DEBUG1("Waking futex %d", *uaddr); - syscall(SYS_futex, uaddr, FUTEX_WAKE, val, NULL, NULL, 0); + XBT_VERB("Waking futex %p", uaddr); + syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0); +} +#endif + +static void xbt_parmap_posix_start(xbt_parmap_t parmap) +{ + THROW_UNIMPLEMENTED; +} + +static void xbt_parmap_posix_end(xbt_parmap_t parmap) +{ + THROW_UNIMPLEMENTED; +} + +static void xbt_parmap_posix_signal(xbt_parmap_t parmap) +{ + THROW_UNIMPLEMENTED; +} + +static void xbt_parmap_posix_wait(xbt_parmap_t parmap) +{ + THROW_UNIMPLEMENTED; +} + +#ifdef HAVE_FUTEX_H +/** + * \brief Starts the parmap: waits for all workers to be ready and returns. + * + * This function is called by the controller thread. + * + * \param parmap a parmap + */ +static void xbt_parmap_futex_start(xbt_parmap_t parmap) +{ + int myflag = parmap->done; + __sync_fetch_and_add(&parmap->thread_counter, 1); + if (parmap->thread_counter < parmap->num_workers) { + /* wait for all workers to be ready */ + futex_wait(&parmap->done, myflag); + } +} + +/** + * \brief Ends the parmap: wakes the controller thread when all workers terminate. + * + * This function is called by all worker threads when they end (not including + * the controller). + * + * \param parmap a parmap + */ +static void xbt_parmap_futex_end(xbt_parmap_t parmap) +{ + unsigned int mycount; + + mycount = __sync_add_and_fetch(&parmap->thread_counter, 1); + if (mycount == parmap->num_workers) { + /* all workers have finished, wake the controller */ + parmap->done++; + futex_wake(&parmap->done, 1); + } +} + +/** + * \brief Wakes all workers and waits for them to finish the tasks. + * + * This function is called by the controller thread. + * + * \param parmap a parmap + */ +static void xbt_parmap_futex_signal(xbt_parmap_t parmap) +{ + int myflag = parmap->done; + parmap->thread_counter = 0; + parmap->work++; + + /* wake all workers */ + futex_wake(&parmap->work, parmap->num_workers); + + if (parmap->status == XBT_PARMAP_WORK) { + /* also work myself */ + void* work = xbt_parmap_next(parmap); + while (work != NULL) { + parmap->fun(work); + work = xbt_parmap_next(parmap); + } + } + + unsigned int mycount = __sync_add_and_fetch(&parmap->thread_counter, 1); + if (mycount < parmap->num_workers) { + /* some workers have not finished yet */ + futex_wait(&parmap->done, myflag); + } +} + +/** + * \brief Waits for some work to process. + * + * This function is called by each worker thread (not including the controller) + * when it has no more work to do. + * + * \param parmap a parmap + */ +static void xbt_parmap_futex_wait(xbt_parmap_t parmap) +{ + int myflag; + unsigned int mycount; + + myflag = parmap->work; + mycount = __sync_add_and_fetch(&parmap->thread_counter, 1); + if (mycount == parmap->num_workers) { + /* all workers have finished, wake the controller */ + parmap->done++; + futex_wake(&parmap->done, 1); + } + + /* wait for more work */ + futex_wait(&parmap->work, myflag); +} +#endif + +/** + * \brief Starts the parmap: waits for all workers to be ready and returns. + * + * This function is called by the controller thread. + * + * \param parmap a parmap + */ +static void xbt_parmap_busy_start(xbt_parmap_t parmap) +{ + __sync_fetch_and_add(&parmap->thread_counter, 1); + while (parmap->thread_counter < parmap->num_workers) { + xbt_os_thread_yield(); + } +} + +/** + * \brief Ends the parmap: wakes the controller thread when all workers terminate. + * + * This function is called by all worker threads when they end. + * + * \param parmap a parmap + */ +static void xbt_parmap_busy_end(xbt_parmap_t parmap) +{ + __sync_add_and_fetch(&parmap->thread_counter, 1); } -/* Futex based implementation of the barrier */ -void xbt_barrier_init(xbt_barrier_t barrier, unsigned int threads_to_wait) +/** + * \brief Wakes all workers and waits for them to finish the tasks. + * + * This function is called by the controller thread. + * + * \param parmap a parmap + */ +static void xbt_parmap_busy_signal(xbt_parmap_t parmap) { - barrier->threads_to_wait = threads_to_wait; - barrier->thread_count = 0; + parmap->thread_counter = 0; + parmap->work++; + + if (parmap->status == XBT_PARMAP_WORK) { + /* also work myself */ + void* work = xbt_parmap_next(parmap); + while (work != NULL) { + parmap->fun(work); + work = xbt_parmap_next(parmap); + } + } + + /* I have finished, wait for the others */ + __sync_add_and_fetch(&parmap->thread_counter, 1); + while (parmap->thread_counter < parmap->num_workers) { + xbt_os_thread_yield(); + } } -void xbt_barrier_wait(xbt_barrier_t barrier) +/** + * \brief Waits for some work to process. + * + * This function is called by each worker thread (not including the controller) + * when it has no more work to do. + * + * \param parmap a parmap + */ +static void xbt_parmap_busy_wait(xbt_parmap_t parmap) { - int myflag = 0; - unsigned int mycount = 0; + int work = parmap->work; + __sync_add_and_fetch(&parmap->thread_counter, 1); - myflag = barrier->futex; - mycount = __sync_add_and_fetch(&barrier->thread_count, 1); - if(mycount < barrier->threads_to_wait){ - futex_wait(&barrier->futex, myflag); - }else{ - barrier->futex = __sync_add_and_fetch(&barrier->futex, 1); - barrier->thread_count = 0; - futex_wake(&barrier->futex, barrier->threads_to_wait); + /* wait for more work */ + while (parmap->work == work) { + xbt_os_thread_yield(); } } @@ -163,36 +440,39 @@ void xbt_barrier_wait(xbt_barrier_t barrier) XBT_TEST_SUITE("parmap", "Parallel Map"); XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_parmap_unit); - - xbt_parmap_t parmap; void fun(void *arg); void fun(void *arg) { - //INFO1("I'm job %lu", (unsigned long)arg); + //XBT_INFO("I'm job %lu", (unsigned long)arg); } XBT_TEST_UNIT("basic", test_parmap_basic, "Basic usage") { - xbt_test_add0("Create the parmap"); + xbt_test_add("Create the parmap"); - unsigned long i,j; + unsigned long i, j; xbt_dynar_t data = xbt_dynar_new(sizeof(void *), NULL); /* Create the parallel map */ - parmap = xbt_parmap_new(10); - - for(j=0; j < 100; j++){ +#ifdef HAVE_FUTEX_H + parmap = xbt_parmap_new(10, XBT_PARMAP_FUTEX); +#else + parmap = xbt_parmap_new(10, XBT_PARMAP_BUSY_WAIT); +#endif + for (j = 0; j < 100; j++) { xbt_dynar_push_as(data, void *, (void *)j); } - for(i=0; i < 5; i++) + for (i = 0; i < 5; i++) { xbt_parmap_apply(parmap, fun, data); + } /* Destroy the parmap */ xbt_parmap_destroy(parmap); + xbt_dynar_free(&data); } #endif /* SIMGRID_TEST */