src/simix/smx_context_sysv.c

   1 /* context_sysv - 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 <stdarg.h>
  10
  11 #include "smx_context_sysv_private.h"
  12 #include "xbt/parmap.h"
  13 #include "simix/private.h"
  14 #include "gras_config.h"
  15
  16 #ifdef HAVE_VALGRIND_VALGRIND_H
  17 #  include <valgrind/valgrind.h>
  18 #endif                          /* HAVE_VALGRIND_VALGRIND_H */
  19
  20 #ifdef _XBT_WIN32
  21 #include "win32_ucontext.h"
  22 #else
  23 #include "ucontext.h"
  24 #endif
  25
  26 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
  27
  28 #ifdef CONTEXT_THREADS
  29 static xbt_parmap_t smx_ctx_sysv_parmap;
  30 static ucontext_t* smx_ctx_sysv_local_maestro_uc;    /* space to save maestro's stack in each thread */
  31 #endif
  32 static unsigned long smx_ctx_sysv_process_index = 0; /* index of the next process to run in the
  33                                                       * list of runnable processes */
  34 static smx_ctx_sysv_t smx_ctx_sysv_maestro_context;
  35
  36
  37 static smx_context_t
  38 smx_ctx_sysv_create_context(xbt_main_func_t code, int argc, char **argv,
  39     void_pfn_smxprocess_t cleanup_func, void* data);
  40
  41 static void smx_ctx_sysv_wrapper(int count, ...);
  42
  43 static void smx_ctx_sysv_stop_serial(smx_context_t context);
  44 static void smx_ctx_sysv_suspend_serial(smx_context_t context);
  45 static void smx_ctx_sysv_resume_serial(smx_process_t first_process);
  46 static void smx_ctx_sysv_runall_serial(void);
  47
  48 static void smx_ctx_sysv_stop_parallel(smx_context_t context);
  49 static void smx_ctx_sysv_suspend_parallel(smx_context_t context);
  50 static void smx_ctx_sysv_resume_parallel(smx_process_t first_process);
  51 static void smx_ctx_sysv_runall_parallel(void);
  52
  53
  54 /* This is a bit paranoid about SIZEOF_VOIDP not being a multiple of SIZEOF_INT,
  55  * but it doesn't harm. */
  56 #define CTX_ADDR_LEN (SIZEOF_VOIDP / SIZEOF_INT + !!(SIZEOF_VOIDP % SIZEOF_INT))
  57 union u_ctx_addr {
  58   void *addr;
  59   int intv[CTX_ADDR_LEN];
  60 };
  61 #if (CTX_ADDR_LEN == 1)
  62 #  define CTX_ADDR_SPLIT(u) (u).intv[0]
  63 #elif (CTX_ADDR_LEN == 2)
  64 #  define CTX_ADDR_SPLIT(u) (u).intv[0], (u).intv[1]
  65 #else
  66 #  error Your architecture is not supported yet
  67 #endif
  68
  69 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory)
  70 {
  71   smx_ctx_base_factory_init(factory);
  72   XBT_VERB("Activating SYSV context factory");
  73
  74   (*factory)->finalize = smx_ctx_sysv_factory_finalize;
  75   (*factory)->create_context = smx_ctx_sysv_create_context;
  76   /* Do not overload that method (*factory)->finalize */
  77   (*factory)->free = smx_ctx_sysv_free;
  78   (*factory)->name = "smx_sysv_context_factory";
  79
  80   if (SIMIX_context_is_parallel()) {
  81 #ifdef CONTEXT_THREADS  /* To use parallel ucontexts a thread pool is needed */
  82     int nthreads = SIMIX_context_get_nthreads();
  83     smx_ctx_sysv_parmap = xbt_parmap_new(nthreads);
  84     smx_ctx_sysv_local_maestro_uc = xbt_new(ucontext_t, nthreads);
  85     (*factory)->stop = smx_ctx_sysv_stop_parallel;
  86     (*factory)->suspend = smx_ctx_sysv_suspend_parallel;
  87     (*factory)->runall = smx_ctx_sysv_runall_parallel;
  88     (*factory)->self = smx_ctx_sysv_self_parallel;
  89 #else
  90     THROWF(arg_error, 0, "No thread support for parallel context execution");
  91 #endif
  92   } else {
  93     (*factory)->stop = smx_ctx_sysv_stop_serial;
  94     (*factory)->suspend = smx_ctx_sysv_suspend_serial;
  95     (*factory)->runall = smx_ctx_sysv_runall_serial;
  96   }
  97 }
  98
  99 int smx_ctx_sysv_factory_finalize(smx_context_factory_t *factory)
 100 {
 101 #ifdef CONTEXT_THREADS
 102   if (smx_ctx_sysv_parmap)
 103     xbt_parmap_destroy(smx_ctx_sysv_parmap);
 104   xbt_free(smx_ctx_sysv_local_maestro_uc);
 105 #endif
 106   return smx_ctx_base_factory_finalize(factory);
 107 }
 108
 109 smx_context_t
 110 smx_ctx_sysv_create_context_sized(size_t size, xbt_main_func_t code,
 111                                   int argc, char **argv,
 112                                   void_pfn_smxprocess_t cleanup_func,
 113                                   void *data)
 114 {
 115   union u_ctx_addr ctx_addr;
 116   smx_ctx_sysv_t context =
 117       (smx_ctx_sysv_t) smx_ctx_base_factory_create_context_sized(size,
 118                                                                  code,
 119                                                                  argc,
 120                                                                  argv,
 121                                                                  cleanup_func,
 122                                                                  data);
 123
 124   /* if the user provided a function for the process then use it,
 125      otherwise it is the context for maestro */
 126   if (code) {
 127
 128     getcontext(&(context->uc));
 129
 130     context->uc.uc_link = NULL;
 131
 132     context->uc.uc_stack.ss_sp =
 133         pth_skaddr_makecontext(context->stack, smx_context_stack_size);
 134
 135     context->uc.uc_stack.ss_size =
 136         pth_sksize_makecontext(context->stack, smx_context_stack_size);
 137
 138 #ifdef HAVE_VALGRIND_VALGRIND_H
 139     context->valgrind_stack_id =
 140         VALGRIND_STACK_REGISTER(context->uc.uc_stack.ss_sp,
 141                                 ((char *) context->uc.uc_stack.ss_sp) +
 142                                 context->uc.uc_stack.ss_size);
 143 #endif                          /* HAVE_VALGRIND_VALGRIND_H */
 144     ctx_addr.addr = context;
 145     makecontext(&context->uc, (void (*)())smx_ctx_sysv_wrapper,
 146                 CTX_ADDR_LEN, CTX_ADDR_SPLIT(ctx_addr));
 147   } else {
 148     smx_ctx_sysv_maestro_context = context;
 149   }
 150
 151   return (smx_context_t) context;
 152 }
 153
 154 static smx_context_t
 155 smx_ctx_sysv_create_context(xbt_main_func_t code, int argc, char **argv,
 156     void_pfn_smxprocess_t cleanup_func,
 157     void *data)
 158 {
 159
 160   return smx_ctx_sysv_create_context_sized(sizeof(s_smx_ctx_sysv_t) + smx_context_stack_size,
 161                                            code, argc, argv, cleanup_func,
 162                                            data);
 163
 164 }
 165
 166 void smx_ctx_sysv_free(smx_context_t context)
 167 {
 168
 169   if (context) {
 170
 171 #ifdef HAVE_VALGRIND_VALGRIND_H
 172     VALGRIND_STACK_DEREGISTER(((smx_ctx_sysv_t)
 173                                context)->valgrind_stack_id);
 174 #endif                          /* HAVE_VALGRIND_VALGRIND_H */
 175
 176   }
 177   smx_ctx_base_free(context);
 178 }
 179
 180 void smx_ctx_sysv_wrapper(int first, ...)
 181 {
 182   union u_ctx_addr ctx_addr;
 183   smx_ctx_sysv_t context;
 184
 185   ctx_addr.intv[0] = first;
 186   if (CTX_ADDR_LEN > 1) {
 187     va_list ap;
 188     int i;
 189     va_start(ap, first);
 190     for (i = 1; i < CTX_ADDR_LEN; i++)
 191       ctx_addr.intv[i] = va_arg(ap, int);
 192     va_end(ap);
 193   }
 194   context = ctx_addr.addr;
 195   (context->super.code) (context->super.argc, context->super.argv);
 196
 197   simix_global->context_factory->stop((smx_context_t) context);
 198 }
 199
 200 static void smx_ctx_sysv_stop_serial(smx_context_t context)
 201 {
 202   smx_ctx_base_stop(context);
 203   smx_ctx_sysv_suspend_serial(context);
 204 }
 205
 206 static void smx_ctx_sysv_suspend_serial(smx_context_t context)
 207 {
 208   /* determine the next context */
 209   smx_context_t next_context;
 210   unsigned long int i = smx_ctx_sysv_process_index++;
 211
 212   if (i < xbt_dynar_length(simix_global->process_to_run)) {
 213     /* execute the next process */
 214     XBT_DEBUG("Run next process");
 215     next_context = xbt_dynar_get_as(
 216         simix_global->process_to_run,i, smx_process_t)->context;
 217   }
 218   else {
 219     /* all processes were run, return to maestro */
 220     XBT_DEBUG("No more process to run");
 221     next_context = (smx_context_t) smx_ctx_sysv_maestro_context;
 222   }
 223   SIMIX_context_set_current(next_context);
 224   swapcontext(&((smx_ctx_sysv_t) context)->uc,
 225       &((smx_ctx_sysv_t) next_context)->uc);
 226 }
 227
 228 static void smx_ctx_sysv_resume_serial(smx_process_t first_process)
 229 {
 230   smx_context_t context = first_process->context;
 231   SIMIX_context_set_current(context);
 232   swapcontext(&smx_ctx_sysv_maestro_context->uc,
 233       &((smx_ctx_sysv_t) context)->uc);
 234 }
 235
 236 static void smx_ctx_sysv_runall_serial(void)
 237 {
 238   if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
 239     smx_process_t first_process =
 240         xbt_dynar_get_as(simix_global->process_to_run, 0, smx_process_t);
 241     smx_ctx_sysv_process_index = 1;
 242
 243     /* execute the first process */
 244     smx_ctx_sysv_resume_serial(first_process);
 245   }
 246 }
 247
 248 static void smx_ctx_sysv_stop_parallel(smx_context_t context)
 249 {
 250   smx_ctx_base_stop(context);
 251   smx_ctx_sysv_suspend_parallel(context);
 252 }
 253
 254 static void smx_ctx_sysv_suspend_parallel(smx_context_t context)
 255 {
 256 #ifdef CONTEXT_THREADS
 257   /* determine the next context */
 258   smx_process_t next_work = xbt_parmap_next(smx_ctx_sysv_parmap);
 259   smx_context_t next_context;
 260   ucontext_t* next_uc;
 261
 262   if (next_work != NULL) {
 263     /* there is a next process to resume */
 264     XBT_DEBUG("Run next process");
 265     next_context = next_work->context;
 266     next_uc = &((smx_ctx_sysv_t) next_context)->uc;
 267   }
 268   else {
 269     /* all processes were run, go to the barrier */
 270     XBT_DEBUG("No more processes to run");
 271     next_context = (smx_context_t) smx_ctx_sysv_maestro_context;
 272     unsigned long worker_id = xbt_parmap_get_worker_id(smx_ctx_sysv_parmap);
 273     next_uc = &smx_ctx_sysv_local_maestro_uc[worker_id];
 274   }
 275
 276   SIMIX_context_set_current(next_context);
 277   swapcontext(&((smx_ctx_sysv_t) context)->uc, next_uc);
 278 #endif
 279 }
 280
 281 static void smx_ctx_sysv_resume_parallel(smx_process_t first_process)
 282 {
 283 #ifdef CONTEXT_THREADS
 284   unsigned long worker_id = xbt_parmap_get_worker_id(smx_ctx_sysv_parmap);
 285   ucontext_t* local_maestro_uc = &smx_ctx_sysv_local_maestro_uc[worker_id];
 286
 287   smx_context_t context = first_process->context;
 288   SIMIX_context_set_current(context);
 289   swapcontext(local_maestro_uc, &((smx_ctx_sysv_t) context)->uc);
 290 #endif
 291 }
 292
 293 static void smx_ctx_sysv_runall_parallel(void)
 294 {
 295 #ifdef CONTEXT_THREADS
 296   xbt_parmap_apply(smx_ctx_sysv_parmap, (void_f_pvoid_t) smx_ctx_sysv_resume_parallel,
 297       simix_global->process_to_run);
 298 #endif
 299 }
 300
 301 smx_context_t smx_ctx_sysv_self_parallel(void)
 302 {
 303   /*smx_context_t self_context = (smx_context_t) xbt_os_thread_get_extra_data();
 304   return self_context ? self_context : (smx_context_t) maestro_context;*/
 305   return SIMIX_context_get_current();
 306 }