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 static void smx_ctx_thread_free(smx_context_t context);
  33 static void smx_ctx_thread_stop(smx_context_t context);
  34 static void smx_ctx_thread_suspend(smx_context_t context);
  35
  36 static void
  37   smx_ctx_thread_resume(smx_context_t old_context, smx_context_t new_context);
  38
  39 static void *smx_ctx_thread_wrapper(void *param);
  40
  41 void SIMIX_ctx_thread_factory_init(smx_context_factory_t * factory)
  42 {
  43   *factory = xbt_new0(s_smx_context_factory_t, 1);
  44
  45   (*factory)->create_context = smx_ctx_thread_factory_create_context;
  46   (*factory)->finalize = smx_ctx_thread_factory_finalize;
  47   (*factory)->free = smx_ctx_thread_free;
  48   (*factory)->start = smx_ctx_thread_start;
  49   (*factory)->stop = smx_ctx_thread_stop;
  50   (*factory)->suspend = smx_ctx_thread_suspend;
  51   (*factory)->resume = smx_ctx_thread_resume;
  52   (*factory)->name = "ctx_thread_factory";
  53 }
  54
  55 static int smx_ctx_thread_factory_finalize(smx_context_factory_t * factory)
  56 {
  57   free(*factory);
  58   *factory = NULL;
  59   return 0;
  60 }
  61
  62 static smx_context_t
  63 smx_ctx_thread_factory_create_context(xbt_main_func_t code, int argc, char** argv,
  64                                       void_f_pvoid_t cleanup_func, void* cleanup_arg)
  65 {
  66   smx_ctx_thread_t context = xbt_new0(s_smx_ctx_thread_t, 1);
  67
  68   /* If the user provided a function for the process then use it
  69      otherwise is the context for maestro */
  70   if(code){
  71     context->code = code;
  72     context->argc = argc;
  73     context->argv = argv;
  74     context->cleanup_func = cleanup_func;
  75     context->cleanup_arg = cleanup_arg;
  76     context->begin = xbt_os_sem_init(0);
  77     context->end = xbt_os_sem_init(0);
  78
  79
  80     /* create and start the process */
  81     /* NOTE: The first argument to xbt_os_thread_create used to be the process *
  82      * name, but now the name is stored at SIMIX level, so we pass a null      */
  83     context->thread =
  84       xbt_os_thread_create(NULL, smx_ctx_thread_wrapper, ctx_thread);
  85
  86     /* wait the starting of the newly created process */
  87     xbt_os_sem_acquire(context->end);
  88   }
  89
  90   return (smx_context_t)context;
  91 }
  92
  93 static void smx_ctx_thread_free(smx_context_t pcontext)
  94 {
  95   int i;
  96   smx_ctx_thread_t context = (smx_ctx_thread_t)pcontext;
  97
  98   /* check if this is the context of maestro (it doesn't has a real thread) */
  99   if (context->thread) {
 100     /* wait about the thread terminason */
 101     xbt_os_thread_join(context->thread, NULL);
 102
 103     /* destroy the synchronisation objects */
 104     xbt_os_sem_destroy(context->begin);
 105     xbt_os_sem_destroy(context->end);
 106   }
 107
 108   /* free argv */
 109   if (context->argv) {
 110     for (i = 0; i < context->argc; i++)
 111       if (context->argv[i])
 112         free(context->argv[i]);
 113
 114     free(context->argv);
 115   }
 116
 117   /* finally destroy the context */
 118   free(context);
 119 }
 120
 121 static void smx_ctx_thread_stop(smx_context_t pcontext)
 122 {
 123
 124   smx_ctx_thread_t context = (smx_ctx_thread_t)pcontext;
 125
 126   /* please no debug here: our procdata was already free'd */
 127   if (context->cleanup_func)
 128     (*context->cleanup_func) (context->cleanup_arg);
 129
 130   /* signal to the maestro that it has finished */
 131   xbt_os_sem_release(((smx_ctx_thread_t) context)->end);
 132
 133   /* exit */
 134   /* We should provide return value in case other wants it */
 135   xbt_os_thread_exit(NULL);
 136 }
 137
 138 static void *smx_ctx_thread_wrapper(void *param)
 139 {
 140   smx_ctx_thread_t context = (smx_ctx_thread_t) param;
 141
 142   /* Tell the maestro we are starting, and wait for its green light */
 143   xbt_os_sem_release(context->end);
 144   xbt_os_sem_acquire(context->begin);
 145
 146   (context->code) (context->argc, context->argv);
 147
 148   smx_ctx_thread_stop((smx_context_t)context);
 149   return NULL;
 150 }
 151
 152 static void smx_ctx_thread_suspend(smx_context_t context)
 153 {
 154   xbt_os_sem_release(((smx_ctx_thread_t) context)->end);
 155   xbt_os_sem_acquire(((smx_ctx_thread_t) context)->begin);
 156 }
 157
 158 static void smx_ctx_thread_resume(smx_context_t not_used,
 159                                   smx_context_t new_context)
 160 {
 161   xbt_os_sem_release(((smx_ctx_thread_t) new_context)->begin);
 162   xbt_os_sem_acquire(((smx_ctx_thread_t) new_context)->end);
 163 }