src/xbt/parmap.c

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