Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fixed the pthread context implementation, now it compiles and runs
[simgrid.git] / src / simix / private.h
index 202f3f4..63a8d40 100644 (file)
@@ -15,7 +15,6 @@
 #include "xbt/fifo.h"\r
 #include "xbt/swag.h"\r
 #include "xbt/dict.h"\r
-#include "xbt/config.h"\r
 #include "xbt/function_types.h"\r
 \r
 /******************************** Datatypes ***********************************/\r
@@ -23,7 +22,7 @@
 \r
 /*********************************** Host *************************************/\r
 \r
-/** @brief Host datatype \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
@@ -54,9 +53,9 @@ extern SIMIX_Global_t simix_global;
 \r
 /******************************** Process *************************************/\r
 \r
-typedef struct s_xbt_context *xbt_context_t;\r
+typedef struct s_smx_context *smx_context_t;\r
 \r
-/** @brief Process datatype \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
@@ -66,7 +65,7 @@ typedef struct s_xbt_context *xbt_context_t;
 \r
        char *name;              /**< @brief process name if any */\r
        smx_host_t smx_host;     /* the host on which the process is running */\r
-       xbt_context_t context;   /* the context that executes the scheduler function */\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
@@ -93,6 +92,8 @@ typedef struct s_smx_process_arg {
   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
@@ -116,7 +117,7 @@ typedef struct s_smx_cond {
 \r
 /********************************* Action *************************************/\r
 \r
-/** @brief Action datatype \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
@@ -127,8 +128,11 @@ typedef struct s_smx_action {
   smx_host_t source;\r
 } s_smx_action_t;\r
 \r
-/******************************* Other **********************************/\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
@@ -143,19 +147,195 @@ void __SIMIX_create_maestro_process(void);
 \r
 /******************************** Context *************************************/\r
 \r
-int SIMIX_context_create_maestro(smx_process_t *process);\r
-\r
-int SIMIX_context_new(smx_process_t *process, xbt_main_func_t code);\r
-\rvoid SIMIX_context_kill(smx_process_t process);\r
-\rvoid SIMIX_context_start(smx_process_t process);\r
-\rvoid SIMIX_context_yield(void);\r
-\rvoid SIMIX_context_schedule(smx_process_t process);\r
-     \rvoid SIMIX_context_empty_trash(void);\r
-\r
-void SIMIX_context_stop(int exit_code);\r
-     \rvoid SIMIX_context_free(smx_process_t process);\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