src/simix/smx_context_thread.c

   1 /* $Id$ */
   2
   3 /* context_thread - implementation of context switching with native threads */
   4
   5 /* Copyright (c) 2004-2008 the SimGrid team. All right reserved */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 #include "xbt/function_types.h"
  11 #include "private.h"
  12
  13 #include "portable.h"           /* loads context system definitions */
  14 #include "xbt/swag.h"
  15 #include "xbt/xbt_os_thread.h"
  16 #include "xbt_modinter.h"       /* prototype of os thread module's init/exit in XBT */
  17
  18 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
  19
  20 typedef struct s_smx_ctx_thread {
  21   SMX_CTX_BASE_T;
  22   xbt_os_thread_t thread;       /* a plain dumb thread (portable to posix or windows) */
  23   xbt_os_sem_t begin;           /* this semaphore is used to schedule/yield the process  */
  24   xbt_os_sem_t end;             /* this semaphore is used to schedule/unschedule the process   */
  25 } s_smx_ctx_thread_t, *smx_ctx_thread_t;
  26
  27 static smx_context_t
  28 smx_ctx_thread_factory_create_context(xbt_main_func_t code, int argc, char** argv,
  29                                       void_f_pvoid_t cleanup_func, void* cleanup_arg);
  30
  31 static int smx_ctx_thread_factory_finalize(smx_context_factory_t * factory);
  32
  33 static void smx_ctx_thread_free(smx_context_t context);
  34
  35 static void smx_ctx_thread_start(smx_context_t context);
  36
  37 static void smx_ctx_thread_stop(smx_context_t context);
  38
  39 static void smx_ctx_thread_suspend(smx_context_t context);
  40
  41 static void
  42   smx_ctx_thread_resume(smx_context_t old_context, smx_context_t new_context);
  43
  44 static void *smx_ctx_thread_wrapper(void *param);
  45
  46 void SIMIX_ctx_thread_factory_init(smx_context_factory_t * factory)
  47 {
  48   *factory = xbt_new0(s_smx_context_factory_t, 1);
  49
  50   (*factory)->create_context = smx_ctx_thread_factory_create_context;
  51   (*factory)->finalize = smx_ctx_thread_factory_finalize;
  52   (*factory)->free = smx_ctx_thread_free;
  53   (*factory)->start = smx_ctx_thread_start;
  54   (*factory)->stop = smx_ctx_thread_stop;
  55   (*factory)->suspend = smx_ctx_thread_suspend;
  56   (*factory)->resume = smx_ctx_thread_resume;
  57   (*factory)->name = "ctx_thread_factory";
  58 }
  59
  60 static int smx_ctx_thread_factory_finalize(smx_context_factory_t * factory)
  61 {
  62   free(*factory);
  63   *factory = NULL;
  64   return 0;
  65 }
  66
  67 static smx_context_t
  68 smx_ctx_thread_factory_create_context(xbt_main_func_t code, int argc, char** argv,
  69                                       void_f_pvoid_t cleanup_func, void* cleanup_arg)
  70 {
  71   smx_ctx_thread_t context = xbt_new0(s_smx_ctx_thread_t, 1);
  72
  73   /* If the user provided a function for the process then use it
  74      otherwise is the context for maestro */
  75   if(code){
  76     context->code = code;
  77     context->argc = argc;
  78     context->argv = argv;
  79     context->cleanup_func = cleanup_func;
  80     context->cleanup_arg = cleanup_arg;
  81     context->begin = xbt_os_sem_init(0);
  82     context->end = xbt_os_sem_init(0);
  83   }
  84
  85   return (smx_context_t)context;
  86 }
  87
  88 static void smx_ctx_thread_free(smx_context_t pcontext)
  89 {
  90   int i;
  91   smx_ctx_thread_t context = (smx_ctx_thread_t)pcontext;
  92
  93   /* check if this is the context of maestro (it doesn't has a real thread) */
  94   if (context->thread) {
  95     /* wait about the thread terminason */
  96     xbt_os_thread_join(context->thread, NULL);
  97
  98     /* destroy the synchronisation objects */
  99     xbt_os_sem_destroy(context->begin);
 100     xbt_os_sem_destroy(context->end);
 101   }
 102
 103   /* free argv */
 104   if (context->argv) {
 105     for (i = 0; i < context->argc; i++)
 106       if (context->argv[i])
 107         free(context->argv[i]);
 108
 109     free(context->argv);
 110   }
 111
 112   /* finally destroy the context */
 113   free(context);
 114 }
 115
 116 static void smx_ctx_thread_start(smx_context_t context)
 117 {
 118   smx_ctx_thread_t ctx_thread = (smx_ctx_thread_t)context;
 119
 120   /* create and start the process */
 121   /* NOTE: The first argument to xbt_os_thread_create used to be the process *
 122    * name, but now the name is stored at SIMIX level, so we pass a null      */
 123   ctx_thread->thread =
 124     xbt_os_thread_create(NULL, smx_ctx_thread_wrapper, ctx_thread);
 125
 126   /* wait the starting of the newly created process */
 127   xbt_os_sem_acquire(ctx_thread->end);
 128 }
 129
 130 static void smx_ctx_thread_stop(smx_context_t pcontext)
 131 {
 132
 133   smx_ctx_thread_t context = (smx_ctx_thread_t)pcontext;
 134
 135   /* please no debug here: our procdata was already free'd */
 136   if (context->cleanup_func)
 137     (*context->cleanup_func) (context->cleanup_arg);
 138
 139   /* signal to the maestro that it has finished */
 140   xbt_os_sem_release(((smx_ctx_thread_t) context)->end);
 141
 142   /* exit */
 143   /* We should provide return value in case other wants it */
 144   xbt_os_thread_exit(NULL);
 145 }
 146
 147 static void *smx_ctx_thread_wrapper(void *param)
 148 {
 149   smx_ctx_thread_t context = (smx_ctx_thread_t) param;
 150
 151   /* Tell the maestro we are starting, and wait for its green light */
 152   xbt_os_sem_release(context->end);
 153   xbt_os_sem_acquire(context->begin);
 154
 155   (context->code) (context->argc, context->argv);
 156
 157   smx_ctx_thread_stop((smx_context_t)context);
 158   return NULL;
 159 }
 160
 161 static void smx_ctx_thread_suspend(smx_context_t context)
 162 {
 163   xbt_os_sem_release(((smx_ctx_thread_t) context)->end);
 164   xbt_os_sem_acquire(((smx_ctx_thread_t) context)->begin);
 165 }
 166
 167 static void smx_ctx_thread_resume(smx_context_t not_used,
 168                                   smx_context_t new_context)
 169 {
 170   xbt_os_sem_release(((smx_ctx_thread_t) new_context)->begin);
 171   xbt_os_sem_acquire(((smx_ctx_thread_t) new_context)->end);
 172 }