-/* $Id$ */
-
/* context_thread - implementation of context switching with native threads */
-/* Copyright (c) 2004-2008 the SimGrid team. All right reserved */
+/* Copyright (c) 2009-2012. The SimGrid Team.
+ * All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#include "xbt/function_types.h"
-#include "private.h"
-
+#include "smx_private.h"
#include "portable.h" /* loads context system definitions */
#include "xbt/swag.h"
#include "xbt/xbt_os_thread.h"
+#include "xbt_modinter.h" /* prototype of os thread module's init/exit in XBT */
-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(smx_context);
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
typedef struct s_smx_ctx_thread {
- SMX_CTX_BASE_T;
+ s_smx_ctx_base_t super; /* Fields of super implementation */
xbt_os_thread_t thread; /* a plain dumb thread (portable to posix or windows) */
xbt_os_sem_t begin; /* this semaphore is used to schedule/yield the process */
xbt_os_sem_t end; /* this semaphore is used to schedule/unschedule the process */
} s_smx_ctx_thread_t, *smx_ctx_thread_t;
-static int
-smx_ctx_thread_factory_create_context(smx_process_t *smx_process, xbt_main_func_t code);
-
-static int
-smx_ctx_thread_factory_create_master_context(smx_process_t * maestro);
-
-static int smx_ctx_thread_factory_finalize(smx_context_factory_t * factory);
-
-static void smx_ctx_thread_free(smx_process_t process);
-
-static void smx_ctx_thread_kill(smx_process_t process);
-
-static void smx_ctx_thread_schedule(smx_process_t process);
-
-static void smx_ctx_thread_yield(void);
+static xbt_os_sem_t smx_ctx_thread_sem;
-static void smx_ctx_thread_start(smx_process_t process);
+static smx_context_t
+smx_ctx_thread_factory_create_context(xbt_main_func_t code, int argc,
+ char **argv,
+ void_pfn_smxprocess_t cleanup_func,
+ void *data);
-static void smx_ctx_thread_stop(int exit_code);
-
-static void smx_ctx_thread_swap(smx_process_t process);
-
-static void smx_ctx_thread_schedule(smx_process_t process);
-
-static void smx_ctx_thread_yield(void);
-
-static void smx_ctx_thread_suspend(smx_process_t process);
-
-static void smx_ctx_thread_resume(smx_process_t process);
+static void smx_ctx_thread_free(smx_context_t context);
+static void smx_ctx_thread_stop(smx_context_t context);
+static void smx_ctx_thread_suspend(smx_context_t context);
+static void smx_ctx_thread_runall_serial(void);
+static void smx_ctx_thread_runall_parallel(void);
+static smx_context_t smx_ctx_thread_self(void);
+static int smx_ctx_thread_factory_finalize(smx_context_factory_t *factory);
static void *smx_ctx_thread_wrapper(void *param);
void SIMIX_ctx_thread_factory_init(smx_context_factory_t * factory)
{
- *factory = xbt_new0(s_smx_context_factory_t, 1);
+ smx_ctx_base_factory_init(factory);
+ XBT_VERB("Activating thread context factory");
+ (*factory)->finalize = smx_ctx_thread_factory_finalize;
(*factory)->create_context = smx_ctx_thread_factory_create_context;
- (*factory)->finalize = smx_ctx_thread_factory_finalize;
- (*factory)->create_maestro_context = smx_ctx_thread_factory_create_master_context;
+ /* Do not overload that method (*factory)->finalize */
(*factory)->free = smx_ctx_thread_free;
- (*factory)->kill = smx_ctx_thread_kill;
- (*factory)->schedule = smx_ctx_thread_schedule;
- (*factory)->yield = smx_ctx_thread_yield;
- (*factory)->start = smx_ctx_thread_start;
(*factory)->stop = smx_ctx_thread_stop;
+ (*factory)->suspend = smx_ctx_thread_suspend;
+
+ if (SIMIX_context_is_parallel())
+ (*factory)->runall = smx_ctx_thread_runall_parallel;
+ else
+ (*factory)->runall = smx_ctx_thread_runall_serial;
+
+ (*factory)->self = smx_ctx_thread_self;
(*factory)->name = "ctx_thread_factory";
-}
-static int
-smx_ctx_thread_factory_create_master_context(smx_process_t * maestro)
-{
- (*maestro)->context = (smx_context_t) xbt_new0(s_smx_ctx_thread_t, 1);
- return 0;
+ if (SIMIX_context_is_parallel()) {
+ smx_ctx_thread_sem = xbt_os_sem_init(SIMIX_context_get_nthreads());
+ } else {
+ smx_ctx_thread_sem = NULL;
+ }
}
-static int smx_ctx_thread_factory_finalize(smx_context_factory_t * factory)
+static int smx_ctx_thread_factory_finalize(smx_context_factory_t *factory)
{
- free(*factory);
- *factory = NULL;
- return 0;
+ if (smx_ctx_thread_sem) {
+ xbt_os_sem_destroy(smx_ctx_thread_sem);
+ smx_ctx_thread_sem = NULL;
+ }
+ return smx_ctx_base_factory_finalize(factory);
}
-static int
-smx_ctx_thread_factory_create_context(smx_process_t *smx_process, xbt_main_func_t code)
+static smx_context_t
+smx_ctx_thread_factory_create_context(xbt_main_func_t code, int argc,
+ char **argv,
+ void_pfn_smxprocess_t cleanup_func,
+ void *data)
{
- smx_ctx_thread_t context = xbt_new0(s_smx_ctx_thread_t, 1);
+ smx_ctx_thread_t context = (smx_ctx_thread_t)
+ smx_ctx_base_factory_create_context_sized(sizeof(s_smx_ctx_thread_t),
+ code, argc, argv,
+ cleanup_func, data);
+
+ /* If the user provided a function for the process then use it
+ otherwise is the context for maestro */
+ if (code) {
+ context->begin = xbt_os_sem_init(0);
+ context->end = xbt_os_sem_init(0);
+ if (smx_context_stack_size_was_set)
+ xbt_os_thread_setstacksize(smx_context_stack_size);
+
+ /* create and start the process */
+ /* NOTE: The first argument to xbt_os_thread_create used to be the process *
+ * name, but now the name is stored at SIMIX level, so we pass a null */
+ context->thread =
+ xbt_os_thread_create(NULL, smx_ctx_thread_wrapper, context, context);
- VERB1("Create context %s", (*smx_process)->name);
- context->code = code;
- context->begin = xbt_os_sem_init(0);
- context->end = xbt_os_sem_init(0);
- (*smx_process)->context = (smx_context_t)context;
- (*smx_process)->iwannadie = 0;
+ /* wait the starting of the newly created process */
+ xbt_os_sem_acquire(context->end);
- /* FIXME: Check what should return */
- return 1;
+ } else {
+ xbt_os_thread_set_extra_data(context);
+ }
+
+ return (smx_context_t) context;
}
-static void smx_ctx_thread_free(smx_process_t process)
+static void smx_ctx_thread_free(smx_context_t pcontext)
{
- smx_ctx_thread_t context = (smx_ctx_thread_t)process->context;
+ smx_ctx_thread_t context = (smx_ctx_thread_t) pcontext;
- /* Check if this is the context of maestro (it doesn't has a real thread) */
+ /* check if this is the context of maestro (it doesn't have a real thread) */
if (context->thread) {
/* wait about the thread terminason */
xbt_os_thread_join(context->thread, NULL);
- free(context->thread);
-
+
/* destroy the synchronisation objects */
xbt_os_sem_destroy(context->begin);
xbt_os_sem_destroy(context->end);
}
-
- /* finally destroy the context */
- free(context);
-}
-static void smx_ctx_thread_kill(smx_process_t process)
-{
- DEBUG1("Kill process '%s'", process->name);
- process->iwannadie = 1;
- smx_ctx_thread_swap(process);
+ smx_ctx_base_free(pcontext);
}
-/**
- * \param context the winner
- *
- * Calling this function blocks the current context and schedule \a context.
- * When \a context will call smx_context_yield, it will return
- * to this function as if nothing had happened.
- *
- * Only the maestro can call this function to run a given process.
- */
-static void smx_ctx_thread_schedule(smx_process_t process)
+static void smx_ctx_thread_stop(smx_context_t pcontext)
{
- DEBUG1("Schedule process '%s'", process->name);
- xbt_assert0((simix_global->current_process == simix_global->maestro_process),
- "You are not supposed to run this function here!");
- smx_ctx_thread_swap(process);
-}
+ smx_ctx_thread_t context = (smx_ctx_thread_t) pcontext;
-/**
- * Calling this function makes the current context yield. The context
- * that scheduled it returns from smx_context_schedule as if nothing
- * had happened.
- *
- * Only the processes can call this function, giving back the control
- * to the maestro
- */
-static void smx_ctx_thread_yield(void)
-{
- DEBUG1("Yield process '%s'", simix_global->current_process->name);
- xbt_assert0((simix_global->current_process != simix_global->maestro_process),
- "You are not supposed to run this function here!");
- smx_ctx_thread_swap(simix_global->current_process);
-}
-
-static void smx_ctx_thread_start(smx_process_t process)
-{
- smx_ctx_thread_t ctx_thread = (smx_ctx_thread_t) process->context;
-
- DEBUG1("Start context '%s'", process->name);
- /* create and start the process */
- ctx_thread->thread =
- xbt_os_thread_create(process->name, smx_ctx_thread_wrapper,
- ctx_thread);
-
- /* wait the starting of the newly created process */
- xbt_os_sem_acquire(ctx_thread->end);
-}
-
-static void smx_ctx_thread_stop(int exit_code)
-{
/* please no debug here: our procdata was already free'd */
- if (simix_global->current_process->cleanup_func)
- ((*simix_global->current_process->cleanup_func)) (simix_global->current_process->cleanup_arg);
+ smx_ctx_base_stop(pcontext);
+
+ if (smx_ctx_thread_sem) /* parallel run */
+ xbt_os_sem_release(smx_ctx_thread_sem);
/* signal to the maestro that it has finished */
- xbt_os_sem_release(((smx_ctx_thread_t) simix_global->current_process->context)->end);
+ xbt_os_sem_release(((smx_ctx_thread_t) context)->end);
/* exit */
- xbt_os_thread_exit(NULL); /* We should provide return value in case other wants it */
-}
-
-static void smx_ctx_thread_swap(smx_process_t process)
-{
-
- DEBUG2("Swap context: '%s' -> '%s'", simix_global->current_process->name, process->name);
- if ((simix_global->current_process != simix_global->maestro_process) && !process->iwannadie) {
- /* (0) it's not the scheduler and the process doesn't want to die, it just wants to yield */
-
- /* yield itself, resume the maestro */
- smx_ctx_thread_suspend(process);
- } else {
- /* (1) the current process is the scheduler and the process doesn't want to die
- * <-> the maestro wants to schedule the process
- * -> the maestro schedules the process and waits
- *
- * (2) the current process is the scheduler and the process wants to die
- * <-> the maestro wants to kill the process (has called the function smx_context_kill())
- * -> the maestro schedule the process and waits (xbt_os_sem_acquire(context->end))
- * -> if the process stops (smx_context_stop())
- * -> the process resumes the maestro (xbt_os_sem_release(current_context->end)) and exit (xbt_os_thread_exit())
- * -> else the process call smx_context_yield()
- * -> goto (3.1)
- *
- * (3) the current process is not the scheduler and the process wants to die
- * -> (3.1) if the current process is the process who wants to die
- * -> (resume not need) goto (4)
- * -> (3.2) else the current process is not the process who wants to die
- * <-> the current process wants to kill an other process
- * -> the current process resumes the process to die and waits
- * -> if the process to kill stops
- * -> it resumes the process who kill it and exit
- * -> else if the process to kill calls to smx_context_yield()
- * -> goto (3.1)
- */
- /* schedule the process associated with this context */
- smx_ctx_thread_resume(process);
-
- }
-
- /* (4) the current process wants to die */
- if (simix_global->current_process->iwannadie)
- smx_ctx_thread_stop(1);
+ /* We should provide return value in case other wants it */
+ xbt_os_thread_exit(NULL);
}
static void *smx_ctx_thread_wrapper(void *param)
/* Tell the maestro we are starting, and wait for its green light */
xbt_os_sem_release(context->end);
xbt_os_sem_acquire(context->begin);
+ if (smx_ctx_thread_sem) /* parallel run */
+ xbt_os_sem_acquire(smx_ctx_thread_sem);
- smx_ctx_thread_stop((context->code) (simix_global->current_process->argc, simix_global->current_process->argv));
+ (context->super.code) (context->super.argc, context->super.argv);
+
+ smx_ctx_thread_stop((smx_context_t) context);
return NULL;
}
-static void smx_ctx_thread_suspend(smx_process_t process)
+static void smx_ctx_thread_suspend(smx_context_t context)
{
- /* save the current process */
- smx_process_t self = simix_global->current_process;
-
- DEBUG1("Suspend context '%s'", process->name);
-
- /* update the current process to this process */
- simix_global->current_process = process;
+ if (smx_ctx_thread_sem) /* parallel run */
+ xbt_os_sem_release(smx_ctx_thread_sem);
+ xbt_os_sem_release(((smx_ctx_thread_t) context)->end);
+ xbt_os_sem_acquire(((smx_ctx_thread_t) context)->begin);
+ if (smx_ctx_thread_sem) /* parallel run */
+ xbt_os_sem_acquire(smx_ctx_thread_sem);
+}
- xbt_os_sem_release(((smx_ctx_thread_t) process->context)->end);
- xbt_os_sem_acquire(((smx_ctx_thread_t) process->context)->begin);
+static void smx_ctx_thread_runall_serial(void)
+{
+ smx_process_t process;
+ unsigned int cursor;
- /* restore the current process to the previously saved process */
- simix_global->current_process = self;
+ xbt_dynar_foreach(simix_global->process_to_run, cursor, process) {
+ xbt_os_sem_release(((smx_ctx_thread_t) process->context)->begin);
+ xbt_os_sem_acquire(((smx_ctx_thread_t) process->context)->end);
+ }
}
-static void smx_ctx_thread_resume(smx_process_t process)
+static void smx_ctx_thread_runall_parallel(void)
{
- /* save the current process */
- smx_process_t self = simix_global->current_process;
-
- DEBUG1("Resume context '%s'", process->name);
+ unsigned int index;
+ smx_process_t process;
- /* update the current process */
- simix_global->current_process = process;
+ xbt_dynar_foreach(simix_global->process_to_run, index, process)
+ xbt_os_sem_release(((smx_ctx_thread_t) process->context)->begin);
- xbt_os_sem_release(((smx_ctx_thread_t) process->context)->begin);
- xbt_os_sem_acquire(((smx_ctx_thread_t) process->context)->end);
+ xbt_dynar_foreach(simix_global->process_to_run, index, process) {
+ xbt_os_sem_acquire(((smx_ctx_thread_t) process->context)->end);
+ }
+}
- /* restore the current process to the previously saved process */
- simix_global->current_process = self;
+static smx_context_t smx_ctx_thread_self(void)
+{
+ return (smx_context_t) xbt_os_thread_get_extra_data();
}
