-/* $Id$ */\r
-\r
-/* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.\r
- All rights reserved. */\r
-\r
-/* This program is free software; you can redistribute it and/or modify it\r
- * under the terms of the license (GNU LGPL) which comes with this package. */\r
-\r
-#ifndef SIMIX_PRIVATE_H\r
-#define SIMIX_PRIVATE_H\r
-\r
-#include <stdio.h>\r
-#include "simix/simix.h"\r
-#include "surf/surf.h"\r
-#include "xbt/fifo.h"\r
-#include "xbt/swag.h"\r
-#include "xbt/dict.h"\r
-#include "xbt/function_types.h"\r
-\r
-/******************************** Datatypes ***********************************/\r
-\r
-\r
-/*********************************** Host *************************************/\r
-\r
-/** @brief Host datatype\r
- @ingroup m_datatypes_management_details */\r
-typedef struct s_smx_host {\r
- char *name; /**< @brief host name if any */\r
- void *host; /* SURF modeling */\r
- xbt_swag_t process_list;\r
- void *data; /**< @brief user data */\r
-} s_smx_host_t;\r
-\r
-/********************************** Simix Global ******************************/\r
-\r
-typedef struct s_smx_context_factory *smx_context_factory_t;\r
-\r
-typedef struct SIMIX_Global {\r
- smx_context_factory_t context_factory;\r
- xbt_dict_t host;\r
- xbt_swag_t process_to_run;\r
- xbt_swag_t process_list;\r
- xbt_swag_t process_to_destroy;\r
- smx_process_t current_process;\r
- smx_process_t maestro_process;\r
- xbt_dict_t registered_functions;\r
- smx_creation_func_t create_process_function;\r
- void_f_pvoid_t kill_process_function;\r
- void_f_pvoid_t cleanup_process_function;\r
-} s_SIMIX_Global_t, *SIMIX_Global_t;\r
-\r
-extern SIMIX_Global_t simix_global;\r
-\r
-/******************************** Process *************************************/\r
-\r
-typedef struct s_smx_context *smx_context_t;\r
-\r
-/** @brief Process datatype\r
- @ingroup m_datatypes_management_details @{ */\r
- typedef struct s_smx_process {\r
- s_xbt_swag_hookup_t process_hookup;\r
- s_xbt_swag_hookup_t synchro_hookup;\r
- s_xbt_swag_hookup_t host_proc_hookup;\r
- s_xbt_swag_hookup_t destroy_hookup;\r
-\r
- char *name; /**< @brief process name if any */\r
- smx_host_t smx_host; /* the host on which the process is running */\r
- smx_context_t context; /* the context that executes the scheduler function */\r
- int argc; /* arguments number if any */\r
- char **argv; /* arguments table if any */\r
- int blocked : 1;\r
- int suspended : 1;\r
- int iwannadie : 1;\r
- smx_mutex_t mutex; /* mutex on which the process is blocked */\r
- smx_cond_t cond; /* cond on which the process is blocked */\r
- xbt_dict_t properties;\r
- void *data; /* kept for compatibility, it should be replaced with moddata */\r
- void_f_pvoid_t cleanup_func;\r
- void *cleanup_arg;\r
-\r
- } s_smx_process_t;\r
-/** @} */\r
-\r
-typedef struct s_smx_process_arg {\r
- const char *name;\r
- xbt_main_func_t code;\r
- void *data;\r
- char *hostname;\r
- int argc;\r
- char **argv;\r
- double kill_time;\r
- xbt_dict_t properties;\r
-} s_smx_process_arg_t, *smx_process_arg_t;\r
-\r
-void SIMIX_process_empty_trash(void);\r
-\r
-/*************************** Mutex and Conditional ****************************/\r
-\r
-typedef struct s_smx_mutex {\r
-\r
- /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_mutex */\r
- xbt_swag_t sleeping; /* list of sleeping process */\r
- int refcount;\r
- /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_mutex */\r
-\r
-} s_smx_mutex_t;\r
-\r
-typedef struct s_smx_cond {\r
-\r
- /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_cond */\r
- xbt_swag_t sleeping; /* list of sleeping process */\r
- smx_mutex_t mutex;\r
- xbt_fifo_t actions; /* list of actions */\r
- /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_cond */\r
-\r
-} s_smx_cond_t;\r
-\r
-/********************************* Action *************************************/\r
-\r
-/** @brief Action datatype\r
- @ingroup m_datatypes_management_details */\r
-typedef struct s_smx_action {\r
- char *name; /**< @brief action name if any */\r
- xbt_fifo_t cond_list; /*< conditional variables that must be signaled when the action finish. */\r
- void *data; /**< @brief user data */\r
- int refcount; /**< @brief reference counter */\r
- surf_action_t surf_action; /* SURF modeling of computation */\r
- smx_host_t source;\r
-} s_smx_action_t;\r
-\r
-/************************** Configuration support *****************************/\r
-\r
-extern int _simix_init_status; /* 0: beginning of time; FIXME: KILLME ?\r
- 1: pre-inited (cfg_set created);\r
- 2: inited (running) */\r
-\r
-#define SIMIX_CHECK_HOST() xbt_assert0(surf_workstation_model->extension.workstation. \\r
- get_state(SIMIX_host_self()->host)==SURF_RESOURCE_ON,\\r
- "Host failed, you cannot call this function.")\r
-\r
-smx_host_t __SIMIX_host_create(const char *name, void *workstation, void *data);\r
-void __SIMIX_host_destroy(void *host);\r
-void __SIMIX_cond_wait(smx_cond_t cond);\r
-void __SIMIX_cond_display_actions(smx_cond_t cond);\r
-void __SIMIX_action_display_conditions(smx_action_t action);\r
-void __SIMIX_create_maestro_process(void);\r
-\r
-/******************************** Context *************************************/\r
-\r
-void SIMIX_context_mod_init(void);\r
-\r
-void SIMIX_context_mod_exit(void);\r
-\r
-/* *********************** */\r
-/* Context type definition */\r
-/* *********************** */\r
-/* the following function pointers types describe the interface that all context\r
- concepts must implement */\r
-\r
-/* each context type must contain this macro at its begining -- OOP in C :/ */\r
-#define SMX_CTX_BASE_T \\r
- s_xbt_swag_hookup_t hookup; \\r
- ex_ctx_t *exception; \\r
- xbt_main_func_t code; \\r
-\r
-/* all other context types derive from this structure */\r
-typedef struct s_smx_context {\r
- SMX_CTX_BASE_T;\r
-} s_smx_context_t;\r
-\r
-/* *********************** */\r
-/* factory type definition */\r
-/* *********************** */\r
-\r
-/* Each context implementation define its own context factory\r
- * A context factory is responsable of the creation and manipulation of the \r
- * execution context of all the simulated processes (and maestro) using the\r
- * selected implementation.\r
- *\r
- * For example, the context switch based on java thread use the\r
- * java implementation of the context and the java factory to build and control\r
- * the contexts depending on this implementation.\r
-\r
- * The following function pointer types describe the interface that any context \r
- * factory should implement.\r
- */\r
-\r
-/* function used to create a new context */\r
-typedef int (*smx_pfn_context_factory_create_context_t) (smx_process_t *, xbt_main_func_t);\r
-\r
-/* function used to create the context for the maestro process */\r
-typedef int (*smx_pfn_context_factory_create_maestro_context_t) (smx_process_t*);\r
-\r
-/* this function finalize the specified context factory */\r
-typedef int (*smx_pfn_context_factory_finalize_t) (smx_context_factory_t*);\r
-\r
-/* function used to destroy the specified context */\r
-typedef void (*smx_pfn_context_free_t) (smx_process_t);\r
-\r
-/* function used to kill the specified context */\r
-typedef void (*smx_pfn_context_kill_t) (smx_process_t);\r
-\r
-/* function used to resume the specified context */\r
-typedef void (*smx_pfn_context_schedule_t) (smx_process_t);\r
-\r
-/* function used to yield the specified context */\r
-typedef void (*smx_pfn_context_yield_t) (void);\r
-\r
-/* function used to start the specified context */\r
-typedef void (*smx_pfn_context_start_t) (smx_process_t);\r
-\r
-/* function used to stop the current context */\r
-typedef void (*smx_pfn_context_stop_t) (int);\r
-\r
-/* interface of the context factories */\r
-typedef struct s_smx_context_factory {\r
- smx_pfn_context_factory_create_maestro_context_t create_maestro_context;\r
- smx_pfn_context_factory_create_context_t create_context;\r
- smx_pfn_context_factory_finalize_t finalize;\r
- smx_pfn_context_free_t free;\r
- smx_pfn_context_kill_t kill;\r
- smx_pfn_context_schedule_t schedule;\r
- smx_pfn_context_yield_t yield;\r
- smx_pfn_context_start_t start;\r
- smx_pfn_context_stop_t stop;\r
- const char *name;\r
-} s_smx_context_factory_t;\r
-\r
-/* Selects a context factory associated with the name specified by the parameter name.\r
- * If successful the function returns 0. Otherwise the function returns the error code.\r
- */\r
-int SIMIX_context_select_factory(const char *name);\r
-\r
-/* Initializes a context factory from the name specified by the parameter name.\r
- * If the factory cannot be found, an exception is raised.\r
- */\r
-void SIMIX_context_init_factory_by_name(smx_context_factory_t * factory, const char *name);\r
-\r
-/* All factories init */\r
-void SIMIX_ctx_thread_factory_init(smx_context_factory_t * factory);\r
-\r
-void SIMIX_ctx_sysv_factory_init(smx_context_factory_t * factory);\r
-\r
-void SIMIX_ctx_java_factory_init(smx_context_factory_t * factory);\r
-\r
-/* ******************************* */\r
-/* contexts manipulation functions */\r
-/* ******************************* */\r
-\r
-/**\r
- * \param smx_process the simix maestro process that contains this context\r
- */\r
-static inline int SIMIX_context_create_maestro(smx_process_t *process)\r
-{\r
- return (*(simix_global->context_factory->create_maestro_context)) (process);\r
-}\r
-\r
-/**\r
- * \param smx_process the simix process that contains this context\r
- * \param code a main function\r
- */\r
-static inline int SIMIX_context_new(smx_process_t *process, xbt_main_func_t code)\r
-{\r
- return (*(simix_global->context_factory->create_context)) (process, code);\r
-}\r
-\r
-/* Scenario for the end of a context:\r
- *\r
- * CASE 1: death after end of function\r
- * __context_wrapper, called by os thread, calls smx_context_stop after user code stops\r
- * smx_context_stop calls user cleanup_func if any (in context settings),\r
- * add current to trashbin\r
- * yields back to maestro (destroy os thread on need)\r
- * From time to time, maestro calls smx_context_empty_trash,\r
- * which maps smx_context_free on the content\r
- * smx_context_free frees some more memory,\r
- * joins os thread\r
- *\r
- * CASE 2: brutal death\r
- * smx_context_kill (from any context)\r
- * set context->wannadie to 1\r
- * yields to the context\r
- * the context is awaken in the middle of __yield.\r
- * At the end of it, it checks that wannadie == 1, and call smx_context_stop\r
- * (same than first case afterward)\r
- */\r
-static inline void SIMIX_context_kill(smx_process_t process)\r
-{\r
- (*(simix_global->context_factory->kill)) (process);\r
-}\r
-\r
-/* Argument must be stopped first -- runs in maestro context */\r
-static inline void SIMIX_context_free(smx_process_t process)\r
-{\r
- (*(simix_global->context_factory->free)) (process);\r
-}\r
-\r
-/**\r
- * \param context the context to start\r
- *\r
- * Calling this function prepares \a process to be run. It will\r
- however run effectively only when calling #SIMIX_context_schedule\r
- */\r
-static inline void SIMIX_context_start(smx_process_t process)\r
-{\r
- (*(simix_global->context_factory->start)) (process);\r
-}\r
-\r
-/**\r
- * Calling this function makes the current process yield. The process\r
- * that scheduled it returns from SIMIX_context_schedule as if nothing\r
- * had happened.\r
- *\r
- * Only the processes can call this function, giving back the control\r
- * to the maestro\r
- */\r
-static inline void SIMIX_context_yield(void)\r
-{\r
- (*(simix_global->context_factory->yield)) ();\r
-}\r
-\r
-/**\r
- * \param process to be scheduled\r
- *\r
- * Calling this function blocks the current process and schedule \a process.\r
- * When \a process would call SIMIX_context_yield, it will return\r
- * to this function as if nothing had happened.\r
- *\r
- * Only the maestro can call this function to run a given process.\r
- */\r
-static inline void SIMIX_context_schedule(smx_process_t process)\r
-{\r
- (*(simix_global->context_factory->schedule)) (process);\r
-}\r
-\r
-static inline void SIMIX_context_stop(int exit_code)\r
-{\r
- (*(simix_global->context_factory->stop)) (exit_code);\r
-}\r
-\r
-#endif\r
+/* Copyright (c) 2007, 2008, 2009, 2010. 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. */
+
+#ifndef _SIMIX_PRIVATE_H
+#define _SIMIX_PRIVATE_H
+
+#include "simix/simix.h"
+#include "surf/surf.h"
+#include "xbt/fifo.h"
+#include "xbt/swag.h"
+#include "xbt/dict.h"
+#include "xbt/config.h"
+#include "xbt/function_types.h"
+#include "xbt/ex_interface.h"
+#include "instr/instr_private.h"
+#include "process_private.h"
+#include "host_private.h"
+#include "network_private.h"
+#include "smurf_private.h"
+#include "synchro_private.h"
+#include "simix/context.h"
+
+/********************************** Simix Global ******************************/
+
+
+typedef struct s_smx_global {
+ smx_context_factory_t context_factory;
+ xbt_dict_t host;
+ xbt_dynar_t process_to_run;
+ xbt_swag_t process_list;
+ xbt_swag_t process_to_destroy;
+ smx_process_t maestro_process;
+ xbt_dict_t registered_functions;
+ smx_creation_func_t create_process_function;
+ void_f_pvoid_t kill_process_function;
+ void_pfn_smxprocess_t cleanup_process_function;
+} s_smx_global_t, *smx_global_t;
+
+extern smx_global_t simix_global;
+extern unsigned long simix_process_maxpid;
+
+/*********************************** Time ************************************/
+
+/** @brief Timer datatype */
+typedef struct s_smx_timer {
+ double date;
+ void* func;
+ void* args;
+} s_smx_timer_t;
+
+/********************************* Action *************************************/
+
+typedef enum {
+ SIMIX_ACTION_EXECUTE,
+ SIMIX_ACTION_PARALLEL_EXECUTE,
+ SIMIX_ACTION_COMMUNICATE,
+ SIMIX_ACTION_SLEEP,
+ SIMIX_ACTION_SYNCHRO,
+ SIMIX_ACTION_IO
+} e_smx_action_type_t;
+
+typedef enum {
+ SIMIX_COMM_SEND,
+ SIMIX_COMM_RECEIVE,
+ SIMIX_COMM_READY,
+ SIMIX_COMM_DONE
+} e_smx_comm_type_t;
+
+/** @brief Action datatype */
+typedef struct s_smx_action {
+
+ e_smx_action_type_t type; /* Type of SIMIX action*/
+ e_smx_state_t state; /* State of the action */
+ char *name; /* Action name if any */
+ xbt_fifo_t request_list; /* List of requests on this action */
+
+ /* Data specific to each action type */
+ union {
+
+ struct {
+ smx_host_t host; /* The host where the execution takes place */
+ surf_action_t surf_exec; /* The Surf execution action encapsulated */
+ } execution; /* Possibly parallel execution */
+
+ struct {
+ e_smx_comm_type_t type; /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
+ smx_rdv_t rdv; /* Rendez-vous where the comm is queued */
+ int refcount; /* Number of processes involved in the cond */
+ int detached; /* If detached or not */
+
+ /* Surf action data */
+ surf_action_t surf_comm; /* The Surf communication action encapsulated */
+ surf_action_t src_timeout; /* Surf's actions to instrument the timeouts */
+ surf_action_t dst_timeout; /* Surf's actions to instrument the timeouts */
+ smx_process_t src_proc;
+ smx_process_t dst_proc;
+ double rate;
+ double task_size;
+
+ /* Data to be transfered */
+ void *src_buff;
+ void *dst_buff;
+ size_t src_buff_size;
+ size_t *dst_buff_size;
+ char copied;
+
+ void* src_data; /* User data associated to communication */
+ void* dst_data;
+ } comm;
+
+ struct {
+ smx_host_t host; /* The host that is sleeping */
+ surf_action_t surf_sleep; /* The Surf sleeping action encapsulated */
+ } sleep;
+
+ struct {
+ surf_action_t sleep;
+ } synchro;
+
+ };
+
+#ifdef HAVE_LATENCY_BOUND_TRACKING
+ int latency_limited;
+#endif
+
+#ifdef HAVE_TRACING
+ char *category; /* simix action category for instrumentation */
+#endif
+} s_smx_action_t;
+
+/* FIXME: check if we can delete this function */
+static XBT_INLINE e_smx_state_t SIMIX_action_map_state(e_surf_action_state_t state)
+{
+ switch (state) {
+ case SURF_ACTION_READY:
+ return SIMIX_READY;
+ case SURF_ACTION_RUNNING:
+ return SIMIX_RUNNING;
+ case SURF_ACTION_FAILED:
+ return SIMIX_FAILED;
+ case SURF_ACTION_DONE:
+ return SIMIX_DONE;
+ default:
+ xbt_die("Unexpected SURF action state");
+ }
+}
+
+
+
+void SIMIX_context_mod_init(void);
+void SIMIX_context_mod_exit(void);
+
+
+/* All factories init */
+void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
+void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
+void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
+
+/* ****************************** */
+/* context manipulation functions */
+/* ****************************** */
+
+/* Scenario for the end of a context:
+ *
+ * CASE 1: death after end of the main function
+ * the context_wrapper, called internally by the context module, calls
+ * SIMIX_context_stop after user code stops, smx_context_stop calls user
+ * cleanup_func if any (in context settings), add current process to trashbin
+ * and yields back to maestro.
+ * From time to time, maestro calls SIMIX_context_empty_trash, which destroy
+ * all the process and context data structures, and frees the memory
+ *
+ * CASE 2: brutal death
+ * SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
+ * schedules the process. Then the process is awaken in the middle of the
+ * SIMIX_process_yield function, and at the end of it, it checks that
+ * iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
+ */
+
+/**
+ * \brief creates a new context for a user level process
+ * \param code a main function
+ * \param argc the number of arguments of the main function
+ * \param argv the vector of arguments of the main function
+ * \param cleanup_func the function to call when the context stops
+ * \param cleanup_arg the argument of the cleanup_func function
+ */
+static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
+ int argc, char **argv,
+ void_pfn_smxprocess_t cleanup_func,
+ smx_process_t simix_process)
+{
+
+ return (*(simix_global->context_factory->create_context))
+ (code, argc, argv, cleanup_func, simix_process);
+}
+
+/**
+ * \brief destroy a context
+ * \param context the context to destroy
+ * Argument must be stopped first -- runs in maestro context
+ */
+static XBT_INLINE void SIMIX_context_free(smx_context_t context)
+{
+ (*(simix_global->context_factory->free)) (context);
+}
+
+/**
+ * \brief stops the execution of a context
+ * \param context to stop
+ */
+static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
+{
+ (*(simix_global->context_factory->stop)) (context);
+}
+
+/**
+ \brief suspends a context and return the control back to the one which
+ scheduled it
+ \param context the context to be suspended (it must be the running one)
+ */
+static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
+{
+ (*(simix_global->context_factory->suspend)) (context);
+}
+
+/**
+ \brief executes all the processes (in parallel if possible)
+ \param processes the dynar of processes to execute
+ */
+static XBT_INLINE void SIMIX_context_runall(xbt_dynar_t processes)
+{
+ (*(simix_global->context_factory->runall)) (processes);
+}
+
+/**
+ \brief returns the current running context
+ */
+static XBT_INLINE smx_context_t SIMIX_context_self(void)
+{
+ if (simix_global && simix_global->context_factory != NULL) {
+ return (*(simix_global->context_factory->self))();
+ }
+
+ return NULL;
+}
+
+/**
+ \brief returns the data associated to a context
+ \param context The context
+ \return The data
+ */
+static XBT_INLINE void* SIMIX_context_get_data(smx_context_t context)
+{
+ return (*(simix_global->context_factory->get_data))(context);
+}
+
+/**
+ \brief returns the thread's pid running the current context
+ \return The pid
+ */
+static XBT_INLINE int SIMIX_context_get_thread_id(void)
+{
+ return (*(simix_global->context_factory->get_thread_id))();
+}
+
+XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
+#endif
