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