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
  46   (*factory)->create_context = smx_ctx_thread_factory_create_context;
  47   /* Do not overload that method (*factory)->finalize */
  48   (*factory)->free = smx_ctx_thread_free;
  49   (*factory)->stop = smx_ctx_thread_stop;
  50   (*factory)->suspend = smx_ctx_thread_suspend;
  51
  52   if(_surf_parallel_contexts)
  53     (*factory)->runall = smx_ctx_thread_runall_parallel;
  54   else
  55     (*factory)->runall = smx_ctx_thread_runall_serial;
  56
  57   (*factory)->self = smx_ctx_thread_self;
  58   (*factory)->name = "ctx_thread_factory";
  59 }
  60
  61 static smx_context_t
  62 smx_ctx_thread_factory_create_context(xbt_main_func_t code, int argc,
  63                                       char **argv,
  64                                       void_pfn_smxprocess_t cleanup_func,
  65                                       void *data)
  66 {
  67   smx_ctx_thread_t context = (smx_ctx_thread_t)
  68       smx_ctx_base_factory_create_context_sized(sizeof(s_smx_ctx_thread_t),
  69                                                 code, argc, argv,
  70                                                 cleanup_func, data);
  71
  72   /* If the user provided a function for the process then use it
  73      otherwise is the context for maestro */
  74   if (code) {
  75     context->begin = xbt_os_sem_init(0);
  76     context->end = xbt_os_sem_init(0);
  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, context);
  82
  83     /* wait the starting of the newly created process */
  84     xbt_os_sem_acquire(context->end);
  85
  86   } else {
  87     xbt_os_thread_set_extra_data(context);
  88   }
  89
  90   return (smx_context_t) context;
  91 }
  92
  93 static void smx_ctx_thread_free(smx_context_t pcontext)
  94 {
  95   smx_ctx_thread_t context = (smx_ctx_thread_t) pcontext;
  96
  97   /* check if this is the context of maestro (it doesn't has a real thread) */
  98   if (context->thread) {
  99     /* wait about the thread terminason */
 100     xbt_os_thread_join(context->thread, NULL);
 101
 102     /* destroy the synchronisation objects */
 103     xbt_os_sem_destroy(context->begin);
 104     xbt_os_sem_destroy(context->end);
 105   }
 106
 107   smx_ctx_base_free(pcontext);
 108 }
 109
 110 static void smx_ctx_thread_stop(smx_context_t pcontext)
 111 {
 112   smx_ctx_thread_t context = (smx_ctx_thread_t) pcontext;
 113
 114   /* please no debug here: our procdata was already free'd */
 115   smx_ctx_base_stop(pcontext);
 116
 117   /* signal to the maestro that it has finished */
 118   xbt_os_sem_release(((smx_ctx_thread_t) context)->end);
 119
 120   /* exit */
 121   /* We should provide return value in case other wants it */
 122   xbt_os_thread_exit(NULL);
 123 }
 124
 125 static void *smx_ctx_thread_wrapper(void *param)
 126 {
 127   smx_ctx_thread_t context = (smx_ctx_thread_t) param;
 128
 129   /* Tell the maestro we are starting, and wait for its green light */
 130   xbt_os_sem_release(context->end);
 131   xbt_os_sem_acquire(context->begin);
 132
 133   (context->super.code) (context->super.argc, context->super.argv);
 134
 135   smx_ctx_thread_stop((smx_context_t) context);
 136   return NULL;
 137 }
 138
 139 static void smx_ctx_thread_suspend(smx_context_t context)
 140 {
 141   xbt_os_sem_release(((smx_ctx_thread_t) context)->end);
 142   xbt_os_sem_acquire(((smx_ctx_thread_t) context)->begin);
 143 }
 144
 145 static void smx_ctx_thread_runall_serial(xbt_dynar_t processes)
 146 {
 147   smx_process_t process;
 148   while (xbt_dynar_length(processes)){
 149     process = xbt_dynar_pop_as(processes,smx_process_t);
 150     xbt_os_sem_release(((smx_ctx_thread_t) process->context)->begin);
 151     xbt_os_sem_acquire(((smx_ctx_thread_t) process->context)->end);
 152   }
 153 }
 154
 155 static void smx_ctx_thread_runall_parallel(xbt_dynar_t processes)
 156 {
 157   unsigned int index;
 158   smx_process_t process;
 159
 160   xbt_dynar_foreach(processes, index, process)
 161     xbt_os_sem_release(((smx_ctx_thread_t) process->context)->begin);
 162
 163   while(xbt_dynar_length(processes)){
 164      process = xbt_dynar_pop_as(processes,smx_process_t);
 165      xbt_os_sem_acquire(((smx_ctx_thread_t) process->context)->end);
 166   }
 167 }
 168
 169 static smx_context_t smx_ctx_thread_self(void)
 170 {
 171   return (smx_context_t) xbt_os_thread_get_extra_data();
 172 }