src/simix/smx_context_raw.c

   1 /* context_raw - context switching with ucontextes from System V           */
   2
   3 /* Copyright (c) 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include "simix/private.h"
  10 #include "xbt/parmap.h"
  11
  12
  13 #ifdef HAVE_VALGRIND_VALGRIND_H
  14 #  include <valgrind/valgrind.h>
  15 #endif                          /* HAVE_VALGRIND_VALGRIND_H */
  16
  17 #ifdef _XBT_WIN32
  18 #include "win32_ucontext.h"
  19 #include "win32_ucontext.c"
  20 #else
  21 #include "ucontext.h"
  22 #endif
  23
  24 /* lower this if you want to reduce the memory consumption  */
  25 #ifndef CONTEXT_STACK_SIZE      /* allow lua to override this */
  26 #define CONTEXT_STACK_SIZE 128*1024
  27 #endif                          /*CONTEXT_STACK_SIZE */
  28
  29
  30 typedef char * raw_stack_t;
  31 typedef void (*rawctx_entry_point_t)(void *);
  32
  33 typedef struct s_smx_ctx_raw {
  34   s_smx_ctx_base_t super;       /* Fields of super implementation */
  35   char *malloced_stack; /* malloced area containing the stack */
  36   raw_stack_t stack_top; /* pointer to stack top (within previous area) */
  37   raw_stack_t old_stack_top; /* to whom I should return the control */
  38 #ifdef HAVE_VALGRIND_VALGRIND_H
  39   unsigned int valgrind_stack_id;       /* the valgrind stack id */
  40 #endif
  41 } s_smx_ctx_raw_t, *smx_ctx_raw_t;
  42
  43 smx_ctx_raw_t maestro_raw_context;
  44
  45 extern raw_stack_t raw_makecontext(char* malloced_stack, int stack_size,
  46                                    rawctx_entry_point_t entry_point, void* arg);
  47 extern void raw_swapcontext(raw_stack_t* old, raw_stack_t new);
  48
  49 #ifdef PROCESSOR_i686
  50 __asm__ (
  51    ".text\n"
  52    ".globl raw_makecontext\n"
  53    ".type raw_makecontext,@function\n"
  54    "raw_makecontext:\n"
  55    "   movl 4(%esp),%eax\n"   /* stack */
  56    "   addl 8(%esp),%eax\n"   /* size  */
  57    "   movl 12(%esp),%ecx\n"  /* func  */
  58    "   movl 16(%esp),%edx\n"  /* arg   */
  59    "   movl %edx, -4(%eax)\n"
  60    "   movl $0,   -8(%eax)\n" /* @return for func */
  61    "   movl %ecx,-12(%eax)\n"
  62    "   movl $0,  -16(%eax)\n" /* ebp */
  63    "   movl $0,  -20(%eax)\n" /* ebx */
  64    "   movl $0,  -24(%eax)\n" /* esi */
  65    "   movl $0,  -28(%eax)\n" /* edi */
  66    "   subl $28,%eax\n"
  67    "   retl\n"
  68 );
  69
  70 __asm__ (
  71    ".text\n"
  72    ".globl raw_swapcontext\n"
  73    ".type raw_swapcontext,@function\n"
  74    "raw_swapcontext:\n"
  75    "   movl 4(%esp),%eax\n" /* old */
  76    "   movl 8(%esp),%edx\n" /* new */
  77    "   pushl %ebp\n"
  78    "   pushl %ebx\n"
  79    "   pushl %esi\n"
  80    "   pushl %edi\n"
  81    "   movl %esp,(%eax)\n"
  82    "   movl %edx,%esp\n"
  83    "   popl %edi\n"
  84    "   popl %esi\n"
  85    "   popl %ebx\n"
  86    "   popl %ebp\n"
  87    "   retl\n"
  88 );
  89 #elif PROCESSOR_x86_64
  90 __asm__ (
  91    ".text\n"
  92    ".globl raw_makecontext\n"
  93    ".type raw_makecontext,@function\n"
  94    "raw_makecontext:\n" /* Calling convention sets the arguments in rdi, rsi, rdx and rcx, respectively */
  95    "   movq %rdi,%rax\n"      /* stack */
  96    "   addq %rsi,%rax\n"      /* size  */
  97    "   movq $0,   -8(%rax)\n" /* @return for func */
  98    "   movq %rdx,-16(%rax)\n" /* func */
  99    "   movq %rcx,-24(%rax)\n" /* arg/rdi */
 100    "   movq $0,  -32(%rax)\n" /* rsi */
 101    "   movq $0,  -40(%rax)\n" /* rdx */
 102    "   movq $0,  -48(%rax)\n" /* rcx */
 103    "   movq $0,  -56(%rax)\n" /* r8  */
 104    "   movq $0,  -64(%rax)\n" /* r9  */
 105    "   movq $0,  -72(%rax)\n" /* rbp */
 106    "   movq $0,  -80(%rax)\n" /* rbx */
 107    "   movq $0,  -88(%rax)\n" /* r12 */
 108    "   movq $0,  -96(%rax)\n" /* r13 */
 109    "   movq $0, -104(%rax)\n" /* r14 */
 110    "   movq $0, -112(%rax)\n" /* r15 */
 111    "   subq $112,%rax\n"
 112    "   retq\n"
 113 );
 114
 115 __asm__ (
 116    ".text\n"
 117    ".globl raw_swapcontext\n"
 118    ".type raw_swapcontext,@function\n"
 119    "raw_swapcontext:\n" /* Calling convention sets the arguments in rdi and rsi, respectively */
 120    "   pushq %rdi\n"
 121    "   pushq %rsi\n"
 122    "   pushq %rdx\n"
 123    "   pushq %rcx\n"
 124    "   pushq %r8\n"
 125    "   pushq %r9\n"
 126    "   pushq %rbp\n"
 127    "   pushq %rbx\n"
 128    "   pushq %r12\n"
 129    "   pushq %r13\n"
 130    "   pushq %r14\n"
 131    "   pushq %r15\n"
 132    "   movq %rsp,(%rdi)\n" /* old */
 133    "   movq %rsi,%rsp\n" /* new */
 134    "   popq %r15\n"
 135    "   popq %r14\n"
 136    "   popq %r13\n"
 137    "   popq %r12\n"
 138    "   popq %rbx\n"
 139    "   popq %rbp\n"
 140    "   popq %r9\n"
 141    "   popq %r8\n"
 142    "   popq %rcx\n"
 143    "   popq %rdx\n"
 144    "   popq %rsi\n"
 145    "   popq %rdi\n"
 146    "   retq\n"
 147 );
 148 #else
 149 raw_stack_t raw_makecontext(char* malloced_stack, int stack_size,
 150                             rawctx_entry_point_t entry_point, void* arg) {
 151    THROW_UNIMPLEMENTED;
 152 }
 153
 154 void raw_swapcontext(raw_stack_t* old, raw_stack_t new) {
 155    THROW_UNIMPLEMENTED;
 156 }
 157
 158 #endif
 159
 160 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
 161
 162 static xbt_parmap_t parmap;
 163
 164 static void smx_ctx_raw_wrapper(smx_ctx_raw_t context);
 165
 166 static int smx_ctx_raw_factory_finalize(smx_context_factory_t *factory)
 167 {
 168   if(parmap)
 169       xbt_parmap_destroy(parmap);
 170   return smx_ctx_base_factory_finalize(factory);
 171 }
 172
 173
 174 static smx_context_t
 175 smx_ctx_raw_create_context(xbt_main_func_t code, int argc, char **argv,
 176     void_pfn_smxprocess_t cleanup_func,
 177     void *data)
 178 {
 179
 180   smx_ctx_raw_t context =
 181       (smx_ctx_raw_t) smx_ctx_base_factory_create_context_sized(
 182           sizeof(s_smx_ctx_raw_t),
 183           code,
 184           argc,
 185           argv,
 186           cleanup_func,
 187           data);
 188
 189   /* If the user provided a function for the process then use it
 190      otherwise is the context for maestro */
 191      if (code) {
 192        context->malloced_stack = xbt_malloc0(CONTEXT_STACK_SIZE);
 193        context->stack_top =
 194            raw_makecontext(context->malloced_stack,CONTEXT_STACK_SIZE,
 195                (void(*)(void*))smx_ctx_raw_wrapper,context);
 196
 197 #ifdef HAVE_VALGRIND_VALGRIND_H
 198        context->valgrind_stack_id =
 199            VALGRIND_STACK_REGISTER(context->malloced_stack,
 200                context->malloced_stack + CONTEXT_STACK_SIZE);
 201 #endif                          /* HAVE_VALGRIND_VALGRIND_H */
 202
 203      }else{
 204        maestro_raw_context = context;
 205      }
 206
 207      return (smx_context_t) context;
 208 }
 209
 210 static void smx_ctx_raw_free(smx_context_t context)
 211 {
 212
 213   if (context) {
 214
 215 #ifdef HAVE_VALGRIND_VALGRIND_H
 216     VALGRIND_STACK_DEREGISTER(((smx_ctx_raw_t)
 217         context)->valgrind_stack_id);
 218 #endif                          /* HAVE_VALGRIND_VALGRIND_H */
 219
 220     free(((smx_ctx_raw_t)context)->malloced_stack);
 221   }
 222   smx_ctx_base_free(context);
 223 }
 224
 225 static void smx_ctx_raw_suspend(smx_context_t context)
 226 {
 227   smx_current_context = (smx_context_t)maestro_raw_context;
 228   raw_swapcontext(
 229       &((smx_ctx_raw_t) context)->stack_top,
 230       ((smx_ctx_raw_t) context)->old_stack_top);
 231 }
 232
 233 static void smx_ctx_raw_stop(smx_context_t context)
 234 {
 235   smx_ctx_base_stop(context);
 236   smx_ctx_raw_suspend(context);
 237 }
 238
 239 static void smx_ctx_raw_wrapper(smx_ctx_raw_t context)
 240 {
 241   (context->super.code) (context->super.argc, context->super.argv);
 242
 243   smx_ctx_raw_stop((smx_context_t) context);
 244 }
 245
 246 static void smx_ctx_raw_resume(smx_context_t context)
 247 {
 248   smx_current_context = context;
 249   raw_swapcontext(
 250       &((smx_ctx_raw_t) context)->old_stack_top,
 251       ((smx_ctx_raw_t) context)->stack_top);
 252 }
 253
 254 static void smx_ctx_raw_runall(xbt_dynar_t processes)
 255 {
 256   smx_process_t process;
 257   unsigned int cursor;
 258
 259   xbt_dynar_foreach(processes, cursor, process) {
 260     DEBUG2("Schedule item %u of %lu",cursor,xbt_dynar_length(processes));
 261     smx_ctx_raw_resume(process->context);
 262   }
 263   xbt_dynar_reset(processes);
 264 }
 265
 266 static void smx_ctx_raw_resume_parallel(smx_process_t process)
 267 {
 268   smx_ctx_raw_t context = (smx_ctx_raw_t)process->context;
 269   xbt_os_thread_set_extra_data(context);
 270   raw_swapcontext(
 271       &context->old_stack_top,
 272       context->stack_top);
 273   xbt_os_thread_set_extra_data(NULL);
 274 }
 275
 276 static void smx_ctx_raw_runall_parallel(xbt_dynar_t processes)
 277 {
 278   xbt_parmap_apply(parmap, (void_f_pvoid_t)smx_ctx_raw_resume_parallel, processes);
 279   xbt_dynar_reset(processes);
 280 }
 281
 282 static smx_context_t smx_ctx_raw_self_parallel(void)
 283 {
 284   smx_context_t self_context = (smx_context_t) xbt_os_thread_get_extra_data();
 285   return self_context ? self_context : (smx_context_t) maestro_raw_context;
 286 }
 287
 288 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory)
 289 {
 290   VERB0("Using raw contexts. Because the glibc is just not good enough for us.");
 291   smx_ctx_base_factory_init(factory);
 292
 293   (*factory)->finalize  = smx_ctx_raw_factory_finalize;
 294   (*factory)->create_context = smx_ctx_raw_create_context;
 295   /* Do not overload that method (*factory)->finalize */
 296   (*factory)->free = smx_ctx_raw_free;
 297   (*factory)->stop = smx_ctx_raw_stop;
 298   (*factory)->suspend = smx_ctx_raw_suspend;
 299   (*factory)->name = "smx_raw_context_factory";
 300
 301   if (smx_parallel_contexts) {
 302 #ifdef CONTEXT_THREADS  /* To use parallel ucontexts a thread pool is needed */
 303     parmap = xbt_parmap_new(2);
 304     (*factory)->runall = smx_ctx_raw_runall_parallel;
 305     (*factory)->self = smx_ctx_raw_self_parallel;
 306 #else
 307     THROW0(arg_error, 0, "No thread support for parallel context execution");
 308 #endif
 309   }else{
 310     (*factory)->runall = smx_ctx_raw_runall;
 311   }
 312 }