src/kernel/context/ContextUnix.cpp

   1 /* Copyright (c) 2009-2019. 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 /* \file UContext.cpp Context switching with ucontexts from System V        */
   7
   8 #include "context_private.hpp"
   9
  10 #include "mc/mc.h"
  11 #include "simgrid/Exception.hpp"
  12 #include "src/mc/mc_ignore.hpp"
  13 #include "src/simix/ActorImpl.hpp"
  14 #include "src/simix/smx_private.hpp"
  15
  16 #include "ContextUnix.hpp"
  17
  18 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
  19
  20 /** Up to two integers may be needed to store a pointer on the system we target */
  21 constexpr int CTX_ADDR_LEN = 2;
  22
  23 static_assert(sizeof(simgrid::kernel::context::UContext*) <= CTX_ADDR_LEN * sizeof(int),
  24               "Ucontexts are not supported on this arch yet. Please increase CTX_ADDR_LEN.");
  25
  26 /* Make sure that this symbol is easy to recognize by name, even on exotic platforms */
  27 extern "C" {
  28 static void smx_ctx_wrapper(int i1, int i2);
  29 }
  30
  31 // The name of this function is currently hardcoded in MC (as string).
  32 // Do not change it without fixing those references as well.
  33 static void smx_ctx_wrapper(int i1, int i2)
  34 {
  35   // Rebuild the Context* pointer from the integers:
  36   int ctx_addr[CTX_ADDR_LEN] = {i1, i2};
  37   simgrid::kernel::context::UContext* context;
  38   memcpy(&context, ctx_addr, sizeof context);
  39
  40   ASAN_FINISH_SWITCH(nullptr, &context->asan_ctx_->asan_stack_, &context->asan_ctx_->asan_stack_size_);
  41   try {
  42     (*context)();
  43     context->Context::stop();
  44   } catch (simgrid::kernel::context::Context::StopRequest const&) {
  45     XBT_DEBUG("Caught a StopRequest");
  46   } catch (simgrid::Exception const& e) {
  47     XBT_INFO("Actor killed by an uncatched exception %s", simgrid::xbt::demangle(typeid(e).name()).get());
  48     throw;
  49   }
  50   ASAN_ONLY(context->asan_stop_ = true);
  51   context->suspend();
  52 }
  53
  54 namespace simgrid {
  55 namespace kernel {
  56 namespace context {
  57
  58 // UContextFactory
  59 Context* UContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t actor)
  60 {
  61   return new_context<UContext>(std::move(code), cleanup, actor, this);
  62 }
  63
  64
  65 // UContext
  66
  67 UContext::UContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t actor,
  68                    SwappedContextFactory* factory)
  69     : SwappedContext(std::move(code), cleanup_func, actor, factory)
  70 {
  71   /* if the user provided a function for the actor then use it. If not, nothing to do for maestro. */
  72   if (has_code()) {
  73     getcontext(&this->uc_);
  74     this->uc_.uc_link = nullptr;
  75     this->uc_.uc_stack.ss_sp   = sg_makecontext_stack_addr(get_stack());
  76     this->uc_.uc_stack.ss_size = sg_makecontext_stack_size(smx_context_usable_stack_size);
  77     // Makecontext expects integer arguments; we want to pass a pointer.
  78     // This context address is decomposed into a serie of integers, which are passed as arguments to makecontext.
  79
  80     int ctx_addr[CTX_ADDR_LEN]{};
  81     UContext* arg = this;
  82     memcpy(ctx_addr, &arg, sizeof this);
  83     makecontext(&this->uc_, (void (*)())smx_ctx_wrapper, 2, ctx_addr[0], ctx_addr[1]);
  84
  85 #if SIMGRID_HAVE_MC
  86     if (MC_is_active()) {
  87       MC_register_stack_area(get_stack(), actor, &(this->uc_), smx_context_usable_stack_size);
  88     }
  89 #endif
  90   }
  91 }
  92
  93 void UContext::swap_into(SwappedContext* to_)
  94 {
  95   UContext* to = static_cast<UContext*>(to_);
  96   ASAN_ONLY(void* fake_stack = nullptr);
  97   ASAN_ONLY(to->asan_ctx_ = this);
  98   ASAN_START_SWITCH(this->asan_stop_ ? nullptr : &fake_stack, to->asan_stack_, to->asan_stack_size_);
  99   swapcontext(&this->uc_, &to->uc_);
 100   ASAN_FINISH_SWITCH(fake_stack, &this->asan_ctx_->asan_stack_, &this->asan_ctx_->asan_stack_size_);
 101 }
 102
 103
 104 XBT_PRIVATE ContextFactory* sysv_factory()
 105 {
 106   XBT_VERB("Activating SYSV context factory");
 107   return new UContextFactory();
 108 }
 109 }}} // namespace simgrid::kernel::context