Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[simix] More generic mapping between function name and actor code
[simgrid.git] / src / simix / smx_private.h
index 1cb5514..6906a08 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2010, 2012-2014. The SimGrid Team.
+/* Copyright (c) 2007-2010, 2012-2015. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -7,8 +7,16 @@
 #ifndef _SIMIX_PRIVATE_H
 #define _SIMIX_PRIVATE_H
 
+#include <functional>
+#include <memory>
+#include <unordered_map>
+
+#include <xbt/functional.hpp>
+
+#include "src/internal_config.h"
 #include "simgrid/simix.h"
 #include "surf/surf.h"
+#include "xbt/base.h"
 #include "xbt/fifo.h"
 #include "xbt/swag.h"
 #include "xbt/dict.h"
 #include "xbt/config.h"
 #include "xbt/xbt_os_time.h"
 #include "xbt/function_types.h"
-#include "xbt/ex_interface.h"
-#include "instr/instr_private.h"
+#include "src/xbt/ex_interface.h"
+#include "src/instr/instr_private.h"
 #include "smx_process_private.h"
 #include "smx_host_private.h"
 #include "smx_io_private.h"
 #include "smx_network_private.h"
-#include "smx_smurf_private.h"
+#include "popping_private.h"
 #include "smx_synchro_private.h"
-/* ****************************************************************************************** */
-/* TUTORIAL: New API                                                                        */
-/* ****************************************************************************************** */
-#include "smx_new_api_private.h"
 
-/* Define only for SimGrid benchmarking purposes */
-//#define TIME_BENCH_PER_SR /* this aims at measuring the time spent in each scheduling round per each thread. The code is thus run in sequential to bench separately each SSR */
-//#define TIME_BENCH_AMDAHL /* this aims at measuring the porting of time that could be parallelized at maximum (to get the optimal speedup by applying the amdahl law). */
+#include <signal.h>
 
-/********************************** Simix Global ******************************/
-typedef struct s_smx_global {
-  smx_context_factory_t context_factory;
-  xbt_dynar_t process_to_run;
-  xbt_dynar_t process_that_ran;
-  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_pfn_smxprocess_t_smxprocess_t kill_process_function;
-  void_pfn_smxprocess_t cleanup_process_function;
-  xbt_mallocator_t action_mallocator;
-  void_pfn_smxhost_t autorestart;
-
-#ifdef TIME_BENCH_AMDAHL
-  xbt_os_timer_t timer_seq; /* used to bench the sequential and parallel parts of the simulation, if requested to */
-  xbt_os_timer_t timer_par;
-#endif
-} s_smx_global_t, *smx_global_t;
+#ifdef __cplusplus
 
-extern smx_global_t simix_global;
-extern unsigned long simix_process_maxpid;
+#include <simgrid/simix.hpp>
 
-extern xbt_dict_t watched_hosts_lib;
+namespace simgrid {
+namespace simix {
+
+/* This allows Java to hijack the context factory (Java induces factories of factory :) */
+typedef ContextFactory* (*ContextFactoryInitializer)(void);
+XBT_PUBLIC_DATA(ContextFactoryInitializer) factory_initializer;
+
+XBT_PRIVATE ContextFactory* thread_factory();
+XBT_PRIVATE ContextFactory* sysv_factory();
+XBT_PRIVATE ContextFactory* raw_factory();
+XBT_PRIVATE ContextFactory* boost_factory();
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-void SIMIX_clean(void);
-#ifdef __cplusplus
 }
+}
+
+typedef simgrid::simix::ContextFactory *smx_context_factory_t;
+
+#else
+
+typedef struct s_smx_context_factory *smx_context_factory_t;
+
 #endif
 
-/******************************** Exceptions *********************************/
+/********************************** Simix Global ******************************/
 
-#define SMX_EXCEPTION(issuer, c, v, m)                                  \
-  if (1) {                                                              \
-    smx_process_t _smx_throw_issuer = (issuer);                         \
-    THROW_PREPARE(_smx_throw_issuer->running_ctx, (c), (v), xbt_strdup(m)); \
-    _smx_throw_issuer->doexception = 1;                                 \
-  } else ((void)0)
+namespace simgrid {
+namespace simix {
+
+// What's executed as SIMIX actor code:
+typedef std::function<void()> ActorCode;
+
+// Create ActorCode based on argv:
+typedef std::function<ActorCode(simgrid::xbt::args args)> ActorCodeFactory;
+
+class Global {
+public:
+  smx_context_factory_t context_factory = nullptr;
+  xbt_dynar_t process_to_run = nullptr;
+  xbt_dynar_t process_that_ran = nullptr;
+  xbt_swag_t process_list = nullptr;
+  xbt_swag_t process_to_destroy = nullptr;
+  smx_process_t maestro_process = nullptr;
+
+  // Maps function names to actor code:
+  std::unordered_map<std::string, simgrid::simix::ActorCodeFactory> registered_functions;
+
+  // This might be used when no corresponding function name is registered:
+  simgrid::simix::ActorCodeFactory default_function;
+
+  smx_creation_func_t create_process_function = nullptr;
+  void_pfn_smxprocess_t kill_process_function = nullptr;
+  /** Callback used when killing a SMX_process */
+  void_pfn_smxprocess_t cleanup_process_function = nullptr;
+  xbt_os_mutex_t mutex = nullptr;
+};
+
+}
+}
+
+SG_BEGIN_DECL()
+
+XBT_PUBLIC_DATA(std::unique_ptr<simgrid::simix::Global>) simix_global;
 
-#define SMX_THROW() RETHROW
+extern XBT_PRIVATE unsigned long simix_process_maxpid;
+
+XBT_PUBLIC(void) SIMIX_clean(void);
+
+/******************************** Exceptions *********************************/
+/** @brief Ask to the provided simix process to raise the provided exception */
+#define SMX_EXCEPTION(issuer, cat, val, msg) \
+  if (1) { \
+  smx_process_t _smx_throw_issuer = (issuer); /* evaluate only once */ \
+  xbt_ex e(msg); \
+  e.category = cat; \
+  e.value = val; \
+  e.file = __FILE__; \
+  e.line = __LINE__; \
+  e.func = __func__; \
+  _smx_throw_issuer->exception = std::make_exception_ptr(e); \
+  } else ((void)0)
 
 /* ******************************** File ************************************ */
 typedef struct s_smx_file {
@@ -84,130 +126,13 @@ typedef struct s_smx_file {
   void* data;                   /**< @brief user data */
 } s_smx_file_t;
 
-/*********************************** 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,
-  /* ****************************************************************************************** */
-  /* TUTORIAL: New API                                                                        */
-  /* ****************************************************************************************** */
-  SIMIX_ACTION_NEW_API
-} e_smx_action_type_t;
-
-typedef enum {
-  SIMIX_COMM_SEND,
-  SIMIX_COMM_RECEIVE,
-  SIMIX_COMM_READY,
-  SIMIX_COMM_DONE
-} e_smx_comm_type_t;
-
-typedef enum {
-  SIMIX_IO_OPEN,
-  SIMIX_IO_WRITE,
-  SIMIX_IO_READ,
-  SIMIX_IO_STAT
-} e_smx_io_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 simcalls;               /* List of simcalls waiting for 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 */
-
-#ifdef HAVE_MC
-      smx_rdv_t rdv_cpy;              /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
-                                         (comm.rdv set to NULL when the communication is removed from the mailbox
-                                         (used as garbage collector)) */
-#endif
-      int refcount;                   /* Number of processes involved in the cond */
-      int detached;                   /* If detached or not */
-
-      void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
-      int (*match_fun)(void*,void*,smx_action_t);  /* Filter function used by the other side. It is used when
-                                         looking if a given communication matches my needs. For that, myself must match the
-                                         expectations of the other side, too. See  */
-
-      /* 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;
-      unsigned copied:1;              /* whether the data were already 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;
-
-    struct {
-      smx_host_t host;
-      surf_action_t surf_io;
-    } io;
-
-    /* ****************************************************************************************** */
-    /* TUTORIAL: New API                                                                        */
-    /* ****************************************************************************************** */
-    struct {
-      surf_action_t surf_new_api;
-    } new_api;
-  };
-
-#ifdef HAVE_LATENCY_BOUND_TRACKING
-  int latency_limited;
-#endif
-
-#ifdef HAVE_TRACING
-  char *category;                     /* simix action category for instrumentation */
-#endif
-} s_smx_action_t;
+XBT_PRIVATE void SIMIX_context_mod_init(void);
+XBT_PRIVATE void SIMIX_context_mod_exit(void);
 
-void SIMIX_context_mod_init(void);
-void SIMIX_context_mod_exit(void);
+XBT_PRIVATE smx_context_t SIMIX_context_new(
+  std::function<void()> code,
+  void_pfn_smxprocess_t cleanup_func,
+  smx_process_t simix_process);
 
 #ifndef WIN32
 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
@@ -216,129 +141,44 @@ XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
 /* We are using the bottom of the stack to save some information, like the
  * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
  * size for the stack. */
-#ifdef HAVE_VALGRIND_VALGRIND_H
+#if HAVE_VALGRIND_H
 # define smx_context_usable_stack_size                                  \
   (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
 #else
 # define smx_context_usable_stack_size smx_context_stack_size
 #endif
 
-void *SIMIX_context_stack_new(void);
-void SIMIX_context_stack_delete(void *stack);
-
-void SIMIX_context_set_current(smx_context_t context);
-smx_context_t SIMIX_context_get_current(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)
+/** @brief Executes all the processes to run (in parallel if possible). */
+static inline void SIMIX_context_runall(void)
 {
-  if (!simix_global)
-    xbt_die("simix is not initialized, please call MSG_init first");
-  return simix_global->context_factory->create_context(code,
-                                                       argc, argv,
-                                                       cleanup_func,
-                                                       simix_process);
+  if (!xbt_dynar_is_empty(simix_global->process_to_run))
+    simix_global->context_factory->run_all();
 }
 
-/**
- * \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)
+/** @brief returns the current running context */
+static inline smx_context_t SIMIX_context_self(void)
 {
-  simix_global->context_factory->free(context);
+  if (simix_global && simix_global->context_factory)
+    return simix_global->context_factory->self();
+  else
+    return nullptr;
 }
 
-/**
- * \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);
-}
+XBT_PRIVATE void *SIMIX_context_stack_new(void);
+XBT_PRIVATE void SIMIX_context_stack_delete(void *stack);
 
-/**
- \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);
-}
+XBT_PRIVATE void SIMIX_context_set_current(smx_context_t context);
+XBT_PRIVATE smx_context_t SIMIX_context_get_current(void);
 
-/**
- \brief Executes all the processes to run (in parallel if possible).
- */
-static XBT_INLINE void SIMIX_context_runall(void)
-{
-  if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
-    simix_global->context_factory->runall();
-  }
-}
+XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
 
-/**
- \brief returns the current running context
- */
-static XBT_INLINE smx_context_t SIMIX_context_self(void)
-{
-  if (simix_global && simix_global->context_factory) {
-    return simix_global->context_factory->self();
-  }
-  return NULL;
-}
+XBT_PRIVATE void SIMIX_post_create_environment(void);
 
-/**
- \brief returns the SIMIX process associated to a context
- \param context The context
- \return The SIMIX process
- */
-static XBT_INLINE smx_process_t SIMIX_context_get_process(smx_context_t context)
-{
-  return simix_global->context_factory->get_process(context);
-}
+// FIXME, Dirty hack for SMPI+MSG
+XBT_PRIVATE void SIMIX_process_set_cleanup_function(smx_process_t process, void_pfn_smxprocess_t cleanup);
 
-XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
+XBT_PRIVATE simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(const char *name);
 
-void SIMIX_post_create_environment(void);
+SG_END_DECL()
 
 #endif