src/simix/smx_context_thread.c

   1 /* context_thread - implementation of context switching with native threads */
   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 "xbt/function_types.h"
  10 #include "private.h"
  11 #include "portable.h"           /* loads context system definitions */
  12 #include "xbt/swag.h"
  13 #include "xbt/xbt_os_thread.h"
  14 #include "xbt_modinter.h"       /* prototype of os thread module's init/exit in XBT */
  15 #include "simix/context.h"
  16
  17 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
  18
  19 typedef struct s_smx_ctx_thread {
  20   s_smx_ctx_base_t super;       /* Fields of super implementation */
  21   xbt_os_thread_t thread;       /* a plain dumb thread (portable to posix or windows) */
  22   xbt_os_sem_t begin;           /* this semaphore is used to schedule/yield the process  */
  23   xbt_os_sem_t end;             /* this semaphore is used to schedule/unschedule the process   */
  24 } s_smx_ctx_thread_t, *smx_ctx_thread_t;
  25
  26 static smx_context_t
  27 smx_ctx_thread_factory_create_context(xbt_main_func_t code, int argc,
  28                                       char **argv,
  29                                       void_pfn_smxprocess_t cleanup_func,
  30                                       void *data);
  31
  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 static void smx_ctx_thread_runall_serial(xbt_dynar_t processes);
  37 static void smx_ctx_thread_runall_parallel(xbt_dynar_t processes);
  38 static smx_context_t smx_ctx_thread_self(void);
  39
  40 static void *smx_ctx_thread_wrapper(void *param);
  41
  42 void SIMIX_ctx_thread_factory_init(smx_context_factory_t * factory)
  43 {
  44   smx_ctx_base_factory_init(factory);
  45   VERB0("Activating thread context factory");
  46
  47   (*factory)->create_context = smx_ctx_thread_factory_create_context;
  48   /* Do not overload that method (*factory)->finalize */
  49   (*factory)->free = smx_ctx_thread_free;
  50   (*factory)->stop = smx_ctx_thread_stop;
  51   (*factory)->suspend = smx_ctx_thread_suspend;
  52
  53   if (SIMIX_context_is_parallel())
  54     (*factory)->runall = smx_ctx_thread_runall_parallel;
  55   else
  56     (*factory)->runall = smx_ctx_thread_runall_serial;
  57
  58   (*factory)->self = smx_ctx_thread_self;
  59   (*factory)->name = "ctx_thread_factory";
  60 }
  61
  62 static smx_context_t
  63 smx_ctx_thread_factory_create_context(xbt_main_func_t code, int argc,
  64                                       char **argv,
  65                                       void_pfn_smxprocess_t cleanup_func,
  66                                       void *data)
  67 {
  68   smx_ctx_thread_t context = (smx_ctx_thread_t)
  69       smx_ctx_base_factory_create_context_sized(sizeof(s_smx_ctx_thread_t),
  70                                                 code, argc, argv,
  71                                                 cleanup_func, data);
  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->begin = xbt_os_sem_init(0);
  77     context->end = xbt_os_sem_init(0);
  78     /* create and start the process */
  79     /* NOTE: The first argument to xbt_os_thread_create used to be the process *
  80     * name, but now the name is stored at SIMIX level, so we pass a null  */
  81     context->thread =
  82       xbt_os_thread_create(NULL, smx_ctx_thread_wrapper, context, context);
  83
  84     /* wait the starting of the newly created process */
  85     xbt_os_sem_acquire(context->end);
  86
  87   } else {
  88     xbt_os_thread_set_extra_data(context);
  89   }
  90
  91   return (smx_context_t) context;
  92 }
  93
  94 static void smx_ctx_thread_free(smx_context_t pcontext)
  95 {
  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   smx_ctx_base_free(pcontext);
 109 }
 110
 111 static void smx_ctx_thread_stop(smx_context_t pcontext)
 112 {
 113   smx_ctx_thread_t context = (smx_ctx_thread_t) pcontext;
 114
 115   /* please no debug here: our procdata was already free'd */
 116   smx_ctx_base_stop(pcontext);
 117
 118   /* signal to the maestro that it has finished */
 119   xbt_os_sem_release(((smx_ctx_thread_t) context)->end);
 120
 121   /* exit */
 122   /* We should provide return value in case other wants it */
 123   xbt_os_thread_exit(NULL);
 124 }
 125
 126 static void *smx_ctx_thread_wrapper(void *param)
 127 {
 128   smx_ctx_thread_t context = (smx_ctx_thread_t) param;
 129
 130   /* Tell the maestro we are starting, and wait for its green light */
 131   xbt_os_sem_release(context->end);
 132   xbt_os_sem_acquire(context->begin);
 133
 134   (context->super.code) (context->super.argc, context->super.argv);
 135
 136   smx_ctx_thread_stop((smx_context_t) context);
 137   return NULL;
 138 }
 139
 140 static void smx_ctx_thread_suspend(smx_context_t context)
 141 {
 142   xbt_os_sem_release(((smx_ctx_thread_t) context)->end);
 143   xbt_os_sem_acquire(((smx_ctx_thread_t) context)->begin);
 144 }
 145
 146 static void smx_ctx_thread_runall_serial(xbt_dynar_t processes)
 147 {
 148   smx_process_t process;
 149   unsigned int cursor;
 150
 151   xbt_dynar_foreach(processes, cursor, process) {
 152     xbt_os_sem_release(((smx_ctx_thread_t) process->context)->begin);
 153     xbt_os_sem_acquire(((smx_ctx_thread_t) process->context)->end);
 154   }
 155   xbt_dynar_reset(processes);
 156 }
 157
 158 static void smx_ctx_thread_runall_parallel(xbt_dynar_t processes)
 159 {
 160   unsigned int index;
 161   smx_process_t process;
 162
 163   xbt_dynar_foreach(processes, index, process)
 164     xbt_os_sem_release(((smx_ctx_thread_t) process->context)->begin);
 165
 166   xbt_dynar_foreach(processes, index, process) {
 167      xbt_os_sem_acquire(((smx_ctx_thread_t) process->context)->end);
 168   }
 169   xbt_dynar_reset(processes);
 170 }
 171
 172 static smx_context_t smx_ctx_thread_self(void)
 173 {
 174   return (smx_context_t) xbt_os_thread_get_extra_data();
 175 }