Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
obey sonar and make SwappedContext::stack_ private
[simgrid.git] / src / kernel / context / ContextRaw.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 #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 Context* RawContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func,
190                                            smx_actor_t process)
191 {
192   return this->new_context<RawContext>(std::move(code), cleanup_func, process, this);
193 }
194
195 // RawContext
196
197 RawContext::RawContext(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process,
198                        SwappedContextFactory* factory)
199     : SwappedContext(std::move(code), cleanup, process, factory)
200 {
201    if (has_code()) {
202 #if PTH_STACKGROWTH == -1
203      ASAN_ONLY(this->asan_stack_ = static_cast<char*>(get_stack()) + smx_context_usable_stack_size);
204 #else
205      ASAN_ONLY(this->asan_stack_ = get_stack());
206 #endif
207      this->stack_top_ = raw_makecontext(get_stack(), smx_context_usable_stack_size, RawContext::wrapper, this);
208    } else {
209      set_maestro(this); // save maestro for run_all()
210      if (MC_is_active())
211        MC_ignore_heap(&stack_top_, sizeof(stack_top_));
212    }
213 }
214
215 void RawContext::wrapper(void* arg)
216 {
217   RawContext* context = static_cast<RawContext*>(arg);
218   ASAN_FINISH_SWITCH(nullptr, &context->asan_ctx_->asan_stack_, &context->asan_ctx_->asan_stack_size_);
219   try {
220     (*context)();
221   } catch (StopRequest const&) {
222     XBT_DEBUG("Caught a StopRequest");
223   } catch (simgrid::Exception const& e) {
224     XBT_INFO("Actor killed by an uncatched exception %s", simgrid::xbt::demangle(typeid(e).name()).get());
225     throw;
226   }
227   context->Context::stop();
228
229   ASAN_ONLY(context->asan_stop_ = true);
230   context->suspend();
231 }
232
233 void RawContext::swap_into(SwappedContext* to_)
234 {
235   RawContext* to = static_cast<RawContext*>(to_);
236   ASAN_ONLY(void* fake_stack = nullptr);
237   ASAN_ONLY(to->asan_ctx_ = this);
238   ASAN_START_SWITCH(this->asan_stop_ ? nullptr : &fake_stack, to->asan_stack_, to->asan_stack_size_);
239   raw_swapcontext(&this->stack_top_, to->stack_top_);
240   ASAN_FINISH_SWITCH(fake_stack, &this->asan_ctx_->asan_stack_, &this->asan_ctx_->asan_stack_size_);
241 }
242
243 ContextFactory* raw_factory()
244 {
245   XBT_VERB("Using raw contexts. Because the glibc is just not good enough for us.");
246   return new RawContextFactory();
247 }
248 }}}