src/kernel/context/ContextRaw.cpp

   1 /* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "ContextRaw.hpp"
   7 #include "context_private.hpp"
   8 #include "mc/mc.h"
   9 #include "simgrid/Exception.hpp"
  10 #include "src/simix/smx_private.hpp"
  11
  12 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
  13
  14 // Raw context routines
  15
  16 typedef void (*rawctx_entry_point_t)(void *);
  17
  18 typedef void* raw_stack_t;
  19 extern "C" raw_stack_t raw_makecontext(void* malloced_stack, int stack_size,
  20                                    rawctx_entry_point_t entry_point, void* arg);
  21 extern "C" void raw_swapcontext(raw_stack_t* old, raw_stack_t new_context);
  22
  23 // TODO, we should handle FP, MMX and the x87 control-word (for x86 and x86_64)
  24
  25 #if SIMGRID_PROCESSOR_x86_64
  26 __asm__ (
  27 #if defined(__APPLE__)
  28    ".text\n"
  29    ".globl _raw_makecontext\n"
  30    "_raw_makecontext:\n"
  31 #elif defined(_WIN32)
  32    ".text\n"
  33    ".globl raw_makecontext\n"
  34    "raw_makecontext:\n"
  35 #else
  36    ".text\n"
  37    ".globl raw_makecontext\n"
  38    ".type raw_makecontext,@function\n"
  39    "raw_makecontext:\n"/* Calling convention sets the arguments in rdi, rsi, rdx and rcx, respectively */
  40 #endif
  41    "   mov %rdi,%rax\n"      /* stack */
  42    "   add %rsi,%rax\n"      /* size  */
  43    "   andq $-16, %rax\n"    /* align stack */
  44    "   movq $0,   -8(%rax)\n" /* @return for func */
  45    "   mov %rdx,-16(%rax)\n" /* func */
  46    "   mov %rcx,-24(%rax)\n" /* arg/rdi */
  47    "   movq $0,  -32(%rax)\n" /* rsi */
  48    "   movq $0,  -40(%rax)\n" /* rdx */
  49    "   movq $0,  -48(%rax)\n" /* rcx */
  50    "   movq $0,  -56(%rax)\n" /* r8  */
  51    "   movq $0,  -64(%rax)\n" /* r9  */
  52    "   movq $0,  -72(%rax)\n" /* rbp */
  53    "   movq $0,  -80(%rax)\n" /* rbx */
  54    "   movq $0,  -88(%rax)\n" /* r12 */
  55    "   movq $0,  -96(%rax)\n" /* r13 */
  56    "   movq $0, -104(%rax)\n" /* r14 */
  57    "   movq $0, -112(%rax)\n" /* r15 */
  58    "   sub $112,%rax\n"
  59    "   ret\n"
  60 );
  61
  62 __asm__ (
  63 #if defined(__APPLE__)
  64    ".text\n"
  65    ".globl _raw_swapcontext\n"
  66    "_raw_swapcontext:\n"
  67 #elif defined(_WIN32)
  68    ".text\n"
  69    ".globl raw_swapcontext\n"
  70    "raw_swapcontext:\n"
  71 #else
  72    ".text\n"
  73    ".globl raw_swapcontext\n"
  74    ".type raw_swapcontext,@function\n"
  75    "raw_swapcontext:\n" /* Calling convention sets the arguments in rdi and rsi, respectively */
  76 #endif
  77    "   push %rdi\n"
  78    "   push %rsi\n"
  79    "   push %rdx\n"
  80    "   push %rcx\n"
  81    "   push %r8\n"
  82    "   push %r9\n"
  83    "   push %rbp\n"
  84    "   push %rbx\n"
  85    "   push %r12\n"
  86    "   push %r13\n"
  87    "   push %r14\n"
  88    "   push %r15\n"
  89    "   mov %rsp,(%rdi)\n" /* old */
  90    "   mov %rsi,%rsp\n" /* new */
  91    "   pop %r15\n"
  92    "   pop %r14\n"
  93    "   pop %r13\n"
  94    "   pop %r12\n"
  95    "   pop %rbx\n"
  96    "   pop %rbp\n"
  97    "   pop %r9\n"
  98    "   pop %r8\n"
  99    "   pop %rcx\n"
 100    "   pop %rdx\n"
 101    "   pop %rsi\n"
 102    "   pop %rdi\n"
 103    "   ret\n"
 104 );
 105 #elif SIMGRID_PROCESSOR_i686
 106 __asm__ (
 107 #if defined(__APPLE__) || defined(_WIN32)
 108    ".text\n"
 109    ".globl _raw_makecontext\n"
 110    "_raw_makecontext:\n"
 111 #else
 112    ".text\n"
 113    ".globl raw_makecontext\n"
 114    ".type raw_makecontext,@function\n"
 115    "raw_makecontext:\n"
 116 #endif
 117    "   movl 4(%esp),%eax\n"   /* stack */
 118    "   addl 8(%esp),%eax\n"   /* size  */
 119    "   andl $-16, %eax\n"     /* align stack */
 120    "   movl 12(%esp),%ecx\n"  /* func  */
 121    "   movl 16(%esp),%edx\n"  /* arg   */
 122    "   movl %edx, -4(%eax)\n"
 123    "   movl $0,   -8(%eax)\n" /* @return for func */
 124    "   movl %ecx,-12(%eax)\n"
 125    "   movl $0,  -16(%eax)\n" /* ebp */
 126    "   movl $0,  -20(%eax)\n" /* ebx */
 127    "   movl $0,  -24(%eax)\n" /* esi */
 128    "   movl $0,  -28(%eax)\n" /* edi */
 129    "   subl $28,%eax\n"
 130    "   retl\n"
 131 );
 132
 133 __asm__ (
 134 #if defined(__APPLE__) || defined(_WIN32)
 135    ".text\n"
 136    ".globl _raw_swapcontext\n"
 137    "_raw_swapcontext:\n"
 138 #else
 139    ".text\n"
 140    ".globl raw_swapcontext\n"
 141    ".type raw_swapcontext,@function\n"
 142    "raw_swapcontext:\n"
 143 #endif
 144    // Fetch the parameters:
 145    "   movl 4(%esp),%eax\n" /* old (raw_stack_t*) */
 146    "   movl 8(%esp),%edx\n" /* new (raw_stack_t)  */
 147    // Save registers of the current context on the stack:
 148    "   pushl %ebp\n"
 149    "   pushl %ebx\n"
 150    "   pushl %esi\n"
 151    "   pushl %edi\n"
 152    // Save the current context (stack pointer) in *old:
 153    "   movl %esp,(%eax)\n"
 154    // Switch to the stack of the new context:
 155    "   movl %edx,%esp\n"
 156    // Pop the values of the new context:
 157    "   popl %edi\n"
 158    "   popl %esi\n"
 159    "   popl %ebx\n"
 160    "   popl %ebp\n"
 161    // Return using the return address of the new context:
 162    "   retl\n"
 163 );
 164 #else
 165
 166
 167 /* If you implement raw contexts for other processors, don't forget to
 168    update the definition of HAVE_RAW_CONTEXTS in tools/cmake/CompleteInFiles.cmake */
 169
 170 raw_stack_t raw_makecontext(void* malloced_stack, int stack_size,
 171                             rawctx_entry_point_t entry_point, void* arg) {
 172    THROW_UNIMPLEMENTED;
 173 }
 174
 175 void raw_swapcontext(raw_stack_t* old, raw_stack_t new_context) {
 176    THROW_UNIMPLEMENTED;
 177 }
 178
 179 #endif
 180
 181 // ***** Method definitions
 182
 183 namespace simgrid {
 184 namespace kernel {
 185 namespace context {
 186
 187 // RawContextFactory
 188
 189 RawContextFactory::RawContextFactory() : ContextFactory("RawContextFactory"), parallel_(SIMIX_context_is_parallel())
 190 {
 191   RawContext::set_maestro(nullptr);
 192   if (parallel_) {
 193     // TODO: choose dynamically when SIMIX_context_get_parallel_threshold() > 1
 194     SwappedContext::initialize();
 195   }
 196 }
 197
 198 RawContextFactory::~RawContextFactory()
 199 {
 200   if (parallel_)
 201     SwappedContext::finalize();
 202 }
 203
 204 Context* RawContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func,
 205                                            smx_actor_t process)
 206 {
 207   if (parallel_)
 208     return this->new_context<ParallelRawContext>(std::move(code), cleanup_func, process);
 209   return this->new_context<RawContext>(std::move(code), cleanup_func, process);
 210 }
 211
 212 void RawContextFactory::run_all()
 213 {
 214   if (parallel_)
 215     ParallelRawContext::run_all();
 216   else
 217     SwappedContext::run_all();
 218 }
 219
 220 // RawContext
 221
 222 RawContext::RawContext(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process)
 223     : SwappedContext(std::move(code), cleanup, process)
 224 {
 225    if (has_code()) {
 226 #if PTH_STACKGROWTH == -1
 227      ASAN_ONLY(this->asan_stack_ = static_cast<char*>(this->stack_) + smx_context_usable_stack_size);
 228 #else
 229      ASAN_ONLY(this->asan_stack_ = this->stack_);
 230 #endif
 231      this->stack_top_ = raw_makecontext(this->stack_, smx_context_usable_stack_size, RawContext::wrapper, this);
 232    } else {
 233      if (process != nullptr && get_maestro() == nullptr)
 234        set_maestro(this);
 235      if (MC_is_active()) {
 236        XBT_ATTRIB_UNUSED RawContext* maestro = static_cast<RawContext*>(get_maestro());
 237        MC_ignore_heap(&maestro->stack_top_, sizeof(maestro->stack_top_));
 238      }
 239    }
 240 }
 241
 242 RawContext::~RawContext() = default;
 243
 244 void RawContext::wrapper(void* arg)
 245 {
 246   RawContext* context = static_cast<RawContext*>(arg);
 247   ASAN_FINISH_SWITCH(nullptr, &context->asan_ctx_->asan_stack_, &context->asan_ctx_->asan_stack_size_);
 248   try {
 249     (*context)();
 250   } catch (StopRequest const&) {
 251     XBT_DEBUG("Caught a StopRequest");
 252   } catch (simgrid::Exception const& e) {
 253     XBT_INFO("Actor killed by an uncatched exception %s", simgrid::xbt::demangle(typeid(e).name()).get());
 254     throw;
 255   }
 256   context->Context::stop();
 257
 258   ASAN_ONLY(context->asan_stop_ = true);
 259   context->suspend();
 260 }
 261
 262 void RawContext::swap_into(SwappedContext* to_)
 263 {
 264   RawContext* to = static_cast<RawContext*>(to_);
 265   ASAN_ONLY(void* fake_stack = nullptr);
 266   ASAN_ONLY(to->asan_ctx_ = from);
 267   ASAN_START_SWITCH(from->asan_stop_ ? nullptr : &fake_stack, to->asan_stack_, to->asan_stack_size_);
 268   raw_swapcontext(&this->stack_top_, to->stack_top_);
 269   ASAN_FINISH_SWITCH(fake_stack, &from->asan_ctx_->asan_stack_, &from->asan_ctx_->asan_stack_size_);
 270 }
 271
 272 void RawContext::stop()
 273 {
 274   Context::stop();
 275   throw StopRequest();
 276 }
 277
 278 // ParallelRawContext
 279
 280 void ParallelRawContext::run_all()
 281 {
 282   threads_working_ = 0;
 283   if (parmap_ == nullptr)
 284     parmap_ = new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
 285   parmap_->apply(
 286       [](smx_actor_t process) {
 287         ParallelRawContext* context = static_cast<ParallelRawContext*>(process->context_);
 288         context->resume();
 289       },
 290       simix_global->process_to_run);
 291 }
 292
 293 void ParallelRawContext::suspend()
 294 {
 295   /* determine the next context */
 296   boost::optional<smx_actor_t> next_work = parmap_->next();
 297   SwappedContext* next_context;
 298   if (next_work) {
 299     /* there is a next process to resume */
 300     XBT_DEBUG("Run next process");
 301     next_context = static_cast<ParallelRawContext*>(next_work.get()->context_);
 302   } else {
 303     /* all processes were run, go to the barrier */
 304     XBT_DEBUG("No more processes to run");
 305     next_context = workers_context_[worker_id_];
 306     XBT_DEBUG("Restoring worker stack %zu (working threads = %zu)", worker_id_, threads_working_.load());
 307   }
 308
 309   Context::set_current(next_context);
 310   this->swap_into(next_context);
 311 }
 312
 313 void ParallelRawContext::resume()
 314 {
 315   worker_id_                     = threads_working_.fetch_add(1, std::memory_order_relaxed);
 316   SwappedContext* worker_context = static_cast<SwappedContext*>(self());
 317   workers_context_[worker_id_]   = worker_context;
 318   XBT_DEBUG("Saving worker stack %zu", worker_id_);
 319   Context::set_current(this);
 320   worker_context->swap_into(this);
 321 }
 322
 323 ContextFactory* raw_factory()
 324 {
 325   XBT_VERB("Using raw contexts. Because the glibc is just not good enough for us.");
 326   return new RawContextFactory();
 327 }
 328 }}}