src/simix/RawContext.cpp

   1 /* Copyright (c) 2009-2015. 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 /** \file RawContext.cpp
   8   * Fast context switching inspired from SystemV ucontexts.
   9   *
  10   * In contrast to System V context, it does not touch the signal mask
  11   * which avoids making a system call (at least on Linux).
  12   */
  13
  14 #include <math.h>
  15
  16 #include <utility>
  17 #include <functional>
  18
  19 #include "src/internal_config.h"
  20
  21 #include "xbt/log.h"
  22 #include "xbt/parmap.h"
  23 #include "xbt/dynar.h"
  24
  25 #include "smx_private.h"
  26 #include "smx_private.hpp"
  27 #include "mc/mc.h"
  28
  29 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
  30
  31 // ***** Class definitions
  32
  33 namespace simgrid {
  34 namespace simix {
  35
  36 class RawContext;
  37 class RawContextFactory;
  38
  39 class RawContext : public Context {
  40 protected:
  41   void* stack_ = nullptr;
  42   /** pointer to top the stack stack */
  43   void* stack_top_ = nullptr;
  44 public:
  45   friend class RawContextFactory;
  46   RawContext(std::function<void()> code,
  47           void_pfn_smxprocess_t cleanup_func,
  48           smx_process_t process);
  49   ~RawContext();
  50 public:
  51   static void wrapper(void* arg);
  52   void stop() override;
  53   void suspend() override;
  54   void resume();
  55 private:
  56   void suspend_serial();
  57   void suspend_parallel();
  58   void resume_serial();
  59   void resume_parallel();
  60 };
  61
  62 class RawContextFactory : public ContextFactory {
  63 public:
  64   RawContextFactory();
  65   ~RawContextFactory();
  66   RawContext* create_context(std::function<void()> code,
  67     void_pfn_smxprocess_t, smx_process_t process) override;
  68   void run_all() override;
  69 private:
  70   void run_all_adaptative();
  71   void run_all_serial();
  72   void run_all_parallel();
  73 };
  74
  75 ContextFactory* raw_factory()
  76 {
  77   XBT_VERB("Using raw contexts. Because the glibc is just not good enough for us.");
  78   return new RawContextFactory();
  79 }
  80
  81 }
  82 }
  83
  84 // ***** Loads of static stuff
  85
  86 #if HAVE_THREAD_CONTEXTS
  87 static xbt_parmap_t raw_parmap;
  88 static simgrid::simix::RawContext** raw_workers_context;    /* space to save the worker context in each thread */
  89 static uintptr_t raw_threads_working;     /* number of threads that have started their work */
  90 static xbt_os_thread_key_t raw_worker_id_key; /* thread-specific storage for the thread id */
  91 #endif
  92 #ifdef ADAPTIVE_THRESHOLD
  93 #define SCHED_ROUND_LIMIT 5
  94 static xbt_os_timer_t round_time;
  95 static double par_time,seq_time;
  96 static double par_ratio,seq_ratio;
  97 static int reached_seq_limit, reached_par_limit;
  98 static unsigned int par_proc_that_ran = 0,seq_proc_that_ran = 0;  /* Counters of processes that have run in SCHED_ROUND_LIMIT scheduling rounds */
  99 static unsigned int seq_sched_round=0, par_sched_round=0; /* Amount of SR that ran serial/parallel*/
 100 /*Varables used to calculate running variance and mean*/
 101 static double prev_avg_par_proc=0,prev_avg_seq_proc=0;
 102 static double delta=0;
 103 static double s_par_proc=0,s_seq_proc=0; /*Standard deviation of number of processes computed in par/seq during the current simulation*/
 104 static double avg_par_proc=0,sd_par_proc=0;
 105 static double avg_seq_proc=0,sd_seq_proc=0;
 106 static long long par_window=(long long)HUGE_VAL,seq_window=0;
 107 #endif
 108 static unsigned long raw_process_index = 0;   /* index of the next process to run in the
 109                                                * list of runnable processes */
 110 static simgrid::simix::RawContext* raw_maestro_context;
 111
 112 static bool raw_context_parallel = false;
 113 #ifdef ADAPTIVE_THRESHOLD
 114 static bool raw_context_adaptative = false;
 115 #endif
 116
 117 // ***** Raw context routines
 118
 119 typedef void (*rawctx_entry_point_t)(void *);
 120
 121 typedef void* raw_stack_t;
 122 extern "C" raw_stack_t raw_makecontext(void* malloced_stack, int stack_size,
 123                                    rawctx_entry_point_t entry_point, void* arg);
 124 extern "C" void raw_swapcontext(raw_stack_t* old, raw_stack_t new_context);
 125
 126 #if SIMGRID_PROCESSOR_x86_64
 127 __asm__ (
 128 #if defined(__APPLE__)
 129    ".text\n"
 130    ".globl _raw_makecontext\n"
 131    "_raw_makecontext:\n"
 132 #elif defined(_WIN32)
 133    ".text\n"
 134    ".globl raw_makecontext\n"
 135    "raw_makecontext:\n"
 136 #else
 137    ".text\n"
 138    ".globl raw_makecontext\n"
 139    ".type raw_makecontext,@function\n"
 140    "raw_makecontext:\n"/* Calling convention sets the arguments in rdi, rsi, rdx and rcx, respectively */
 141 #endif
 142    "   mov %rdi,%rax\n"      /* stack */
 143    "   add %rsi,%rax\n"      /* size  */
 144    "   andq $-16, %rax\n"    /* align stack */
 145    "   movq $0,   -8(%rax)\n" /* @return for func */
 146    "   mov %rdx,-16(%rax)\n" /* func */
 147    "   mov %rcx,-24(%rax)\n" /* arg/rdi */
 148    "   movq $0,  -32(%rax)\n" /* rsi */
 149    "   movq $0,  -40(%rax)\n" /* rdx */
 150    "   movq $0,  -48(%rax)\n" /* rcx */
 151    "   movq $0,  -56(%rax)\n" /* r8  */
 152    "   movq $0,  -64(%rax)\n" /* r9  */
 153    "   movq $0,  -72(%rax)\n" /* rbp */
 154    "   movq $0,  -80(%rax)\n" /* rbx */
 155    "   movq $0,  -88(%rax)\n" /* r12 */
 156    "   movq $0,  -96(%rax)\n" /* r13 */
 157    "   movq $0, -104(%rax)\n" /* r14 */
 158    "   movq $0, -112(%rax)\n" /* r15 */
 159    "   sub $112,%rax\n"
 160    "   ret\n"
 161 );
 162
 163 __asm__ (
 164 #if defined(__APPLE__)
 165    ".text\n"
 166    ".globl _raw_swapcontext\n"
 167    "_raw_swapcontext:\n"
 168 #elif defined(_WIN32)
 169    ".text\n"
 170    ".globl raw_swapcontext\n"
 171    "raw_swapcontext:\n"
 172 #else
 173    ".text\n"
 174    ".globl raw_swapcontext\n"
 175    ".type raw_swapcontext,@function\n"
 176    "raw_swapcontext:\n" /* Calling convention sets the arguments in rdi and rsi, respectively */
 177 #endif
 178    "   push %rdi\n"
 179    "   push %rsi\n"
 180    "   push %rdx\n"
 181    "   push %rcx\n"
 182    "   push %r8\n"
 183    "   push %r9\n"
 184    "   push %rbp\n"
 185    "   push %rbx\n"
 186    "   push %r12\n"
 187    "   push %r13\n"
 188    "   push %r14\n"
 189    "   push %r15\n"
 190    "   mov %rsp,(%rdi)\n" /* old */
 191    "   mov %rsi,%rsp\n" /* new */
 192    "   pop %r15\n"
 193    "   pop %r14\n"
 194    "   pop %r13\n"
 195    "   pop %r12\n"
 196    "   pop %rbx\n"
 197    "   pop %rbp\n"
 198    "   pop %r9\n"
 199    "   pop %r8\n"
 200    "   pop %rcx\n"
 201    "   pop %rdx\n"
 202    "   pop %rsi\n"
 203    "   pop %rdi\n"
 204    "   ret\n"
 205 );
 206 #elif SIMGRID_PROCESSOR_i686
 207 __asm__ (
 208 #if defined(__APPLE__) || defined(_WIN32)
 209    ".text\n"
 210    ".globl _raw_makecontext\n"
 211    "_raw_makecontext:\n"
 212 #else
 213    ".text\n"
 214    ".globl raw_makecontext\n"
 215    ".type raw_makecontext,@function\n"
 216    "raw_makecontext:\n"
 217 #endif
 218    "   movl 4(%esp),%eax\n"   /* stack */
 219    "   addl 8(%esp),%eax\n"   /* size  */
 220    "   andl $-16, %eax\n"     /* align stack */
 221    "   movl 12(%esp),%ecx\n"  /* func  */
 222    "   movl 16(%esp),%edx\n"  /* arg   */
 223    "   movl %edx, -4(%eax)\n"
 224    "   movl $0,   -8(%eax)\n" /* @return for func */
 225    "   movl %ecx,-12(%eax)\n"
 226    "   movl $0,  -16(%eax)\n" /* ebp */
 227    "   movl $0,  -20(%eax)\n" /* ebx */
 228    "   movl $0,  -24(%eax)\n" /* esi */
 229    "   movl $0,  -28(%eax)\n" /* edi */
 230    "   subl $28,%eax\n"
 231    "   retl\n"
 232 );
 233
 234 __asm__ (
 235 #if defined(__APPLE__) || defined(_WIN32)
 236    ".text\n"
 237    ".globl _raw_swapcontext\n"
 238    "_raw_swapcontext:\n"
 239 #else
 240    ".text\n"
 241    ".globl raw_swapcontext\n"
 242    ".type raw_swapcontext,@function\n"
 243    "raw_swapcontext:\n"
 244 #endif
 245    "   movl 4(%esp),%eax\n" /* old */
 246    "   movl 8(%esp),%edx\n" /* new */
 247    "   pushl %ebp\n"
 248    "   pushl %ebx\n"
 249    "   pushl %esi\n"
 250    "   pushl %edi\n"
 251    "   movl %esp,(%eax)\n"
 252    "   movl %edx,%esp\n"
 253    "   popl %edi\n"
 254    "   popl %esi\n"
 255    "   popl %ebx\n"
 256    "   popl %ebp\n"
 257    "   retl\n"
 258 );
 259 #else
 260
 261
 262 /* If you implement raw contexts for other processors, don't forget to
 263    update the definition of HAVE_RAW_CONTEXTS in tools/cmake/CompleteInFiles.cmake */
 264
 265 raw_stack_t raw_makecontext(void* malloced_stack, int stack_size,
 266                             rawctx_entry_point_t entry_point, void* arg) {
 267    THROW_UNIMPLEMENTED;
 268 }
 269
 270 void raw_swapcontext(raw_stack_t* old, raw_stack_t new_context) {
 271    THROW_UNIMPLEMENTED;
 272 }
 273
 274 #endif
 275
 276 // ***** Method definitions
 277
 278 namespace simgrid {
 279 namespace simix {
 280
 281 RawContextFactory::RawContextFactory()
 282   : ContextFactory("RawContextFactory")
 283 {
 284 #ifdef ADAPTIVE_THRESHOLD
 285   raw_context_adaptative = (SIMIX_context_get_parallel_threshold() > 1);
 286 #endif
 287   raw_context_parallel = SIMIX_context_is_parallel();
 288   if (raw_context_parallel) {
 289 #if HAVE_THREAD_CONTEXTS
 290     int nthreads = SIMIX_context_get_nthreads();
 291     xbt_os_thread_key_create(&raw_worker_id_key);
 292     // TODO, lazily init
 293     raw_parmap = nullptr;
 294     raw_workers_context = xbt_new(RawContext*, nthreads);
 295     raw_maestro_context = nullptr;
 296 #endif
 297     // TODO, if(SIMIX_context_get_parallel_threshold() > 1) => choose dynamically
 298   }
 299 #ifdef ADAPTIVE_THRESHOLD
 300   round_time = xbt_os_timer_new();
 301   reached_seq_limit = 0;
 302   reached_par_limit = 0;
 303 #endif
 304 }
 305
 306 RawContextFactory::~RawContextFactory()
 307 {
 308 #if HAVE_THREAD_CONTEXTS
 309   if (raw_parmap)
 310     xbt_parmap_destroy(raw_parmap);
 311   xbt_free(raw_workers_context);
 312 #endif
 313 }
 314
 315 RawContext* RawContextFactory::create_context(std::function<void()> code,
 316     void_pfn_smxprocess_t cleanup, smx_process_t process)
 317 {
 318   return this->new_context<RawContext>(std::move(code),
 319     cleanup, process);
 320 }
 321
 322 void RawContext::wrapper(void* arg)
 323 {
 324   RawContext* context = (RawContext*) arg;
 325   (*context)();
 326   context->stop();
 327 }
 328
 329 RawContext::RawContext(std::function<void()> code,
 330     void_pfn_smxprocess_t cleanup, smx_process_t process)
 331   : Context(std::move(code), cleanup, process)
 332 {
 333    if (has_code()) {
 334      this->stack_ = SIMIX_context_stack_new();
 335      this->stack_top_ = raw_makecontext(this->stack_,
 336                          smx_context_usable_stack_size,
 337                          RawContext::wrapper,
 338                          this);
 339    } else {
 340      if(process != nullptr && raw_maestro_context == nullptr)
 341        raw_maestro_context = this;
 342      if (MC_is_active())
 343        MC_ignore_heap(
 344          &raw_maestro_context->stack_top_,
 345          sizeof(raw_maestro_context->stack_top_));
 346    }
 347 }
 348
 349 RawContext::~RawContext()
 350 {
 351   SIMIX_context_stack_delete(this->stack_);
 352 }
 353
 354 void RawContext::stop()
 355 {
 356   Context::stop();
 357   this->suspend();
 358 }
 359
 360 void RawContextFactory::run_all()
 361 {
 362 #ifdef ADAPTIVE_THRESHOLD
 363   if (raw_context_adaptative)
 364     run_all_adaptative();
 365   else
 366 #endif
 367   if (raw_context_parallel)
 368     run_all_parallel();
 369   else
 370     run_all_serial();
 371 }
 372
 373 void RawContextFactory::run_all_serial()
 374 {
 375   smx_process_t first_process =
 376       xbt_dynar_get_as(simix_global->process_to_run, 0, smx_process_t);
 377   raw_process_index = 1;
 378   static_cast<RawContext*>(first_process->context)->resume_serial();
 379 }
 380
 381 void RawContextFactory::run_all_parallel()
 382 {
 383 #if HAVE_THREAD_CONTEXTS
 384   raw_threads_working = 0;
 385   if (raw_parmap == nullptr)
 386     raw_parmap = xbt_parmap_new(
 387       SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
 388   xbt_parmap_apply(raw_parmap,
 389       [](void* arg) {
 390         smx_process_t process = static_cast<smx_process_t>(arg);
 391         RawContext* context = static_cast<RawContext*>(process->context);
 392         context->resume_parallel();
 393       },
 394       simix_global->process_to_run);
 395 #else
 396   xbt_die("You asked for a parallel execution, but you don't have any threads.");
 397 #endif
 398 }
 399
 400 void RawContext::suspend()
 401 {
 402   if (raw_context_parallel)
 403     RawContext::suspend_parallel();
 404   else
 405     RawContext::suspend_serial();
 406 }
 407
 408 void RawContext::suspend_serial()
 409 {
 410   /* determine the next context */
 411   RawContext* next_context = nullptr;
 412   unsigned long int i;
 413   i = raw_process_index++;
 414   if (i < xbt_dynar_length(simix_global->process_to_run)) {
 415     /* execute the next process */
 416     XBT_DEBUG("Run next process");
 417     next_context = (RawContext*) xbt_dynar_get_as(
 418         simix_global->process_to_run, i, smx_process_t)->context;
 419   }
 420   else {
 421     /* all processes were run, return to maestro */
 422     XBT_DEBUG("No more process to run");
 423     next_context = (RawContext*) raw_maestro_context;
 424   }
 425   SIMIX_context_set_current(next_context);
 426   raw_swapcontext(&this->stack_top_, next_context->stack_top_);
 427 }
 428
 429 void RawContext::suspend_parallel()
 430 {
 431 #if HAVE_THREAD_CONTEXTS
 432   /* determine the next context */
 433   smx_process_t next_work = (smx_process_t) xbt_parmap_next(raw_parmap);
 434   RawContext* next_context = nullptr;
 435
 436   if (next_work != NULL) {
 437     /* there is a next process to resume */
 438     XBT_DEBUG("Run next process");
 439     next_context = (RawContext*) next_work->context;
 440   }
 441   else {
 442     /* all processes were run, go to the barrier */
 443     XBT_DEBUG("No more processes to run");
 444     uintptr_t worker_id = (uintptr_t)
 445       xbt_os_thread_get_specific(raw_worker_id_key);
 446     next_context = (RawContext*) raw_workers_context[worker_id];
 447     XBT_DEBUG("Restoring worker stack %zu (working threads = %zu)",
 448         worker_id, raw_threads_working);
 449   }
 450
 451   SIMIX_context_set_current(next_context);
 452   raw_swapcontext(&this->stack_top_, next_context->stack_top_);
 453 #endif
 454 }
 455
 456 void RawContext::resume()
 457 {
 458   if (raw_context_parallel)
 459     resume_parallel();
 460   else
 461     resume_serial();
 462 }
 463
 464 void RawContext::resume_serial()
 465 {
 466   SIMIX_context_set_current(this);
 467   raw_swapcontext(&raw_maestro_context->stack_top_, this->stack_top_);
 468 }
 469
 470 void RawContext::resume_parallel()
 471 {
 472 #if HAVE_THREAD_CONTEXTS
 473   uintptr_t worker_id = __sync_fetch_and_add(&raw_threads_working, 1);
 474   xbt_os_thread_set_specific(raw_worker_id_key, (void*) worker_id);
 475   RawContext* worker_context = (RawContext*) SIMIX_context_self();
 476   raw_workers_context[worker_id] = worker_context;
 477   XBT_DEBUG("Saving worker stack %zu", worker_id);
 478   SIMIX_context_set_current(this);
 479   raw_swapcontext(&worker_context->stack_top_, this->stack_top_);
 480 #else
 481   xbt_die("Parallel execution disabled");
 482 #endif
 483 }
 484
 485 /**
 486  * \brief Resumes all processes ready to run.
 487  */
 488 #ifdef ADAPTIVE_THRESHOLD
 489 void RawContectFactory::run_all_adaptative()
 490 {
 491   unsigned long nb_processes = xbt_dynar_length(simix_global->process_to_run);
 492   unsigned long threshold = SIMIX_context_get_parallel_threshold();
 493   reached_seq_limit = (seq_sched_round % SCHED_ROUND_LIMIT == 0);
 494   reached_par_limit = (par_sched_round % SCHED_ROUND_LIMIT == 0);
 495
 496   if(reached_seq_limit && reached_par_limit){
 497     par_ratio = (par_proc_that_ran != 0) ? (par_time / (double)par_proc_that_ran) : 0;
 498     seq_ratio = (seq_proc_that_ran != 0) ? (seq_time / (double)seq_proc_that_ran) : 0;
 499     if(seq_ratio > par_ratio){
 500        if(nb_processes < avg_par_proc) {
 501           threshold = (threshold>2) ? threshold - 1 : threshold ;
 502           SIMIX_context_set_parallel_threshold(threshold);
 503         }
 504     } else {
 505         if(nb_processes > avg_seq_proc){
 506           SIMIX_context_set_parallel_threshold(threshold+1);
 507         }
 508     }
 509   }
 510
 511   if (nb_processes >= SIMIX_context_get_parallel_threshold()) {
 512     simix_global->context_factory->suspend = smx_ctx_raw_suspend_parallel;
 513     if (nb_processes < par_window){
 514       par_sched_round++;
 515       xbt_os_walltimer_start(round_time);
 516       smx_ctx_raw_runall_parallel();
 517       xbt_os_walltimer_stop(round_time);
 518       par_time += xbt_os_timer_elapsed(round_time);
 519
 520       prev_avg_par_proc = avg_par_proc;
 521       delta = nb_processes - avg_par_proc;
 522       avg_par_proc = (par_sched_round==1) ? nb_processes : avg_par_proc + delta / (double) par_sched_round;
 523
 524       if(par_sched_round>=2){
 525         s_par_proc = s_par_proc + (nb_processes - prev_avg_par_proc) * delta;
 526         sd_par_proc = sqrt(s_par_proc / (par_sched_round-1));
 527         par_window = (int) (avg_par_proc + sd_par_proc);
 528       }else{
 529         sd_par_proc = 0;
 530       }
 531
 532       par_proc_that_ran += nb_processes;
 533     } else{
 534       smx_ctx_raw_runall_parallel();
 535     }
 536   } else {
 537     simix_global->context_factory->suspend = smx_ctx_raw_suspend_serial;
 538     if(nb_processes > seq_window){
 539       seq_sched_round++;
 540       xbt_os_walltimer_start(round_time);
 541       smx_ctx_raw_runall_serial();
 542       xbt_os_walltimer_stop(round_time);
 543       seq_time += xbt_os_timer_elapsed(round_time);
 544
 545       prev_avg_seq_proc = avg_seq_proc;
 546       delta = (nb_processes-avg_seq_proc);
 547       avg_seq_proc = (seq_sched_round==1) ? nb_processes : avg_seq_proc + delta / (double) seq_sched_round;
 548
 549       if(seq_sched_round>=2){
 550         s_seq_proc = s_seq_proc + (nb_processes - prev_avg_seq_proc)*delta;
 551         sd_seq_proc = sqrt(s_seq_proc / (seq_sched_round-1));
 552         seq_window = (int) (avg_seq_proc - sd_seq_proc);
 553       } else {
 554         sd_seq_proc = 0;
 555       }
 556
 557       seq_proc_that_ran += nb_processes;
 558     } else {
 559       smx_ctx_raw_runall_serial();
 560     }
 561   }
 562 }
 563
 564 #else
 565
 566 // TODO
 567 void RawContextFactory::run_all_adaptative()
 568 {
 569   unsigned long nb_processes = xbt_dynar_length(simix_global->process_to_run);
 570   if (SIMIX_context_is_parallel()
 571     && (unsigned long) SIMIX_context_get_parallel_threshold() < nb_processes) {
 572         raw_context_parallel = true;
 573         XBT_DEBUG("Runall // %lu", nb_processes);
 574         this->run_all_parallel();
 575     } else {
 576         XBT_DEBUG("Runall serial %lu", nb_processes);
 577         raw_context_parallel = false;
 578         this->run_all_serial();
 579     }
 580 }
 581 #endif
 582
 583 }
 584 }