Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doc cleanups
[simgrid.git] / src / simix / smx_host.cpp
index 91cb6c8..3127082 100644 (file)
 #include "src/surf/virtual_machine.hpp"
 #include "src/surf/HostImpl.hpp"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_host, simix,
-                                "SIMIX hosts");
+#include "src/simix/SynchroExec.hpp"
+#include "src/simix/SynchroComm.hpp"
 
-static void SIMIX_execution_finish(smx_synchro_t synchro);
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_host, simix, "SIMIX hosts");
 
-/**
- * \brief Internal function to create a SIMIX host.
- * \param name name of the host to create
- */
+/** @brief Internal function to create a SIMIX host. */
 void SIMIX_host_create(sg_host_t host) // FIXME: braindead prototype. Take sg_host as parameter
 {
   smx_host_priv_t smx_host = xbt_new0(s_smx_host_priv_t, 1);
-  s_smx_process_t proc;
 
   /* Host structure */
+  simgrid::simix::Process proc;
   smx_host->process_list = xbt_swag_new(xbt_swag_offset(proc, host_proc_hookup));
 
   /* Update global variables */
   sg_host_simix_set(host, smx_host);
 }
 
-/**
- * \brief Start the host if it is off
- *
- */
+/** @brief Start the host if it is off */
 void SIMIX_host_on(sg_host_t h)
 {
   smx_host_priv_t host = sg_host_simix(h);
@@ -49,31 +43,23 @@ void SIMIX_host_on(sg_host_t h)
     unsigned int cpt;
     smx_process_arg_t arg;
     xbt_dynar_foreach(host->boot_processes,cpt,arg) {
-
-      char** argv = xbt_new(char*, arg->argc);
-      for (int i=0; i<arg->argc; i++)
-        argv[i] = xbt_strdup(arg->argv[i]);
-
-      XBT_DEBUG("Booting Process %s(%s) right now", arg->argv[0], arg->hostname);
+      XBT_DEBUG("Booting Process %s(%s) right now",
+        arg->name.c_str(), arg->hostname);
       if (simix_global->create_process_function) {
-        simix_global->create_process_function(argv[0],
+        simix_global->create_process_function(arg->name.c_str(),
                                               arg->code,
                                               NULL,
                                               arg->hostname,
                                               arg->kill_time,
-                                              arg->argc,
-                                              argv,
                                               arg->properties,
                                               arg->auto_restart,
                                               NULL);
       } else {
-        simcall_process_create(arg->argv[0],
+        simcall_process_create(arg->name.c_str(),
                                arg->code,
                                NULL,
                                arg->hostname,
                                arg->kill_time,
-                               arg->argc,
-                               argv,
                                arg->properties,
                                arg->auto_restart);
       }
@@ -81,10 +67,7 @@ void SIMIX_host_on(sg_host_t h)
   }
 }
 
-/**
- * \brief Stop the host if it is on
- *
- */
+/** @brief Stop the host if it is on */
 void SIMIX_host_off(sg_host_t h, smx_process_t issuer)
 {
   smx_host_priv_t host = sg_host_simix(h);
@@ -100,11 +83,13 @@ void SIMIX_host_off(sg_host_t h, smx_process_t issuer)
       smx_process_t process = NULL;
       xbt_swag_foreach(process, host->process_list) {
         SIMIX_process_kill(process, issuer);
-        XBT_DEBUG("Killing %s on %s by %s", process->name,  sg_host_get_name(process->host), issuer->name);
+        XBT_DEBUG("Killing %s on %s by %s",
+          process->name.c_str(),  sg_host_get_name(process->host),
+          issuer->name.c_str());
       }
     }
   } else {
-    XBT_INFO("Host %s is already off",h->name().c_str());
+    XBT_INFO("Host %s is already off", h->name().c_str());
   }
 }
 
@@ -126,7 +111,7 @@ void SIMIX_host_destroy(void *h)
     smx_process_t process = NULL;
 
     xbt_swag_foreach(process, host->process_list) {
-      tmp = bprintf("%s\n\t%s", msg, process->name);
+      tmp = bprintf("%s\n\t%s", msg, process->name.c_str());
       free(msg);
       msg = tmp;
     }
@@ -148,8 +133,7 @@ sg_host_t SIMIX_host_self(void)
   return (process == NULL) ? NULL : SIMIX_process_get_host(process);
 }
 
-/* needs to be public and without simcall because it is called
-   by exceptions and logging events */
+/* needs to be public and without simcall for exceptions and logging events */
 const char* SIMIX_host_self_get_name(void)
 {
   sg_host_t host = SIMIX_host_self();
@@ -162,12 +146,7 @@ const char* SIMIX_host_self_get_name(void)
 void _SIMIX_host_free_process_arg(void *data)
 {
   smx_process_arg_t arg = *(smx_process_arg_t*)data;
-  int i;
-  for (i = 0; i < arg->argc; i++)
-    xbt_free(arg->argv[i]);
-  xbt_free(arg->argv);
-  xbt_free(arg->name);
-  xbt_free(arg);
+  delete arg;
 }
 /**
  * \brief Add a process to the list of the processes that the host will restart when it comes back
@@ -176,48 +155,30 @@ void _SIMIX_host_free_process_arg(void *data)
  * The processes will only be restarted once, meaning that you will have to register the process
  * again to restart the process again.
  */
-void SIMIX_host_add_auto_restart_process(sg_host_t host,
-                                         const char *name,
-                                         xbt_main_func_t code,
-                                         void *data,
-                                         const char *hostname,
-                                         double kill_time,
-                                         int argc, char **argv,
-                                         xbt_dict_t properties,
-                                         int auto_restart)
+void SIMIX_host_add_auto_restart_process(
+  sg_host_t host, const char *name, std::function<void()> code,
+  void* data, const char *hostname, double kill_time,
+  xbt_dict_t properties, int auto_restart)
 {
   if (!sg_host_simix(host)->auto_restart_processes) {
     sg_host_simix(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
   }
-  smx_process_arg_t arg = xbt_new(s_smx_process_arg_t,1);
-  arg->name = xbt_strdup(name);
-  arg->code = code;
+  smx_process_arg_t arg = new simgrid::simix::ProcessArg();
+  arg->name = name;
+  arg->code = std::move(code);
   arg->data = data;
   arg->hostname = hostname;
   arg->kill_time = kill_time;
-  arg->argc = argc;
-
-  arg->argv = xbt_new(char*,argc + 1);
-
-  int i;
-  for (i = 0; i < argc; i++) {
-    arg->argv[i] = xbt_strdup(argv[i]);
-  }
-  arg->argv[argc] = NULL;
-
   arg->properties = properties;
   arg->auto_restart = auto_restart;
 
-  if( ! sg_host_is_on(host)
-      && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_get_name(host))){
+  if( host->isOff() && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_get_name(host))){
     xbt_dict_set(watched_hosts_lib,sg_host_get_name(host),host,NULL);
-    XBT_DEBUG("Have pushed host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_get_name(host));
+    XBT_DEBUG("Push host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_get_name(host));
   }
   xbt_dynar_push_as(sg_host_simix(host)->auto_restart_processes,smx_process_arg_t,arg);
 }
-/**
- * \brief Restart the list of processes that have been registered to the host
- */
+/** @brief Restart the list of processes that have been registered to the host */
 void SIMIX_host_autorestart(sg_host_t host)
 {
   unsigned int cpt;
@@ -228,35 +189,25 @@ void SIMIX_host_autorestart(sg_host_t host)
 
   xbt_dynar_foreach (process_list, cpt, arg) {
 
-    XBT_DEBUG("Restarting Process %s(%s) right now", arg->argv[0], arg->hostname);
+    XBT_DEBUG("Restarting Process %s(%s) right now", arg->name.c_str(), arg->hostname);
     if (simix_global->create_process_function) {
-      simix_global->create_process_function(arg->argv[0],
+      simix_global->create_process_function(arg->name.c_str(),
                                             arg->code,
                                             NULL,
                                             arg->hostname,
                                             arg->kill_time,
-                                            arg->argc,
-                                            arg->argv,
                                             arg->properties,
                                             arg->auto_restart,
                                             NULL);
     } else {
-      simcall_process_create(arg->argv[0],
-                             (xbt_main_func_t) arg->code,
+      simcall_process_create(arg->name.c_str(),
+                             arg->code,
                              NULL,
                              arg->hostname,
                              arg->kill_time,
-                             arg->argc,
-                             arg->argv,
                              arg->properties,
                              arg->auto_restart);
-
     }
-    /* arg->argv is used by the process created above.  Hide it to
-     * _SIMIX_host_free_process_arg() which is called by xbt_dynar_reset()
-     * below. */
-    arg->argc = 0;
-    arg->argv = NULL;
   }
   xbt_dynar_reset(process_list);
 }
@@ -269,35 +220,32 @@ smx_synchro_t SIMIX_execution_start(smx_process_t issuer, const char *name,
      double flops_amount, double priority, double bound, unsigned long affinity_mask){
 
   /* alloc structures and initialize */
-  smx_synchro_t synchro = (smx_synchro_t) xbt_mallocator_get(simix_global->synchro_mallocator);
-  synchro->type = SIMIX_SYNC_EXECUTE;
-  synchro->name = xbt_strdup(name);
-  synchro->state = SIMIX_RUNNING;
-  synchro->execution.host = issuer->host;
-  synchro->category = NULL;
+  simgrid::simix::Exec *exec = new simgrid::simix::Exec();
+  exec->name = xbt_strdup(name);
+  exec->state = SIMIX_RUNNING;
+  exec->host = issuer->host;
 
   /* set surf's action */
   if (!MC_is_active() && !MC_record_replay_is_active()) {
 
-    synchro->execution.surf_exec = issuer->host->pimpl_cpu->execution_start(flops_amount);
-    synchro->execution.surf_exec->setData(synchro);
-    synchro->execution.surf_exec->setPriority(priority);
+    exec->surf_exec = issuer->host->pimpl_cpu->execution_start(flops_amount);
+    exec->surf_exec->setData(exec);
+    exec->surf_exec->setPriority(priority);
 
     if (bound != 0)
-      static_cast<simgrid::surf::CpuAction*>(synchro->execution.surf_exec)
-        ->setBound(bound);
+      static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)->setBound(bound);
 
     if (affinity_mask != 0) {
       /* just a double check to confirm that this host is the host where this task is running. */
-      xbt_assert(synchro->execution.host == issuer->host);
-      static_cast<simgrid::surf::CpuAction*>(synchro->execution.surf_exec)
+      xbt_assert(exec->host == issuer->host);
+      static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)
         ->setAffinity(issuer->host->pimpl_cpu, affinity_mask);
     }
   }
 
-  XBT_DEBUG("Create execute synchro %p: %s", synchro, synchro->name);
+  XBT_DEBUG("Create execute synchro %p: %s", exec, exec->name);
 
-  return synchro;
+  return exec;
 }
 
 smx_synchro_t SIMIX_execution_parallel_start(const char *name,
@@ -305,16 +253,14 @@ smx_synchro_t SIMIX_execution_parallel_start(const char *name,
     double *flops_amount, double *bytes_amount,
     double amount, double rate){
 
-  sg_host_t*host_list_cpy = NULL;
+  sg_host_t *host_list_cpy = NULL;
   int i;
 
   /* alloc structures and initialize */
-  smx_synchro_t synchro = (smx_synchro_t) xbt_mallocator_get(simix_global->synchro_mallocator);
-  synchro->type = SIMIX_SYNC_PARALLEL_EXECUTE;
-  synchro->name = xbt_strdup(name);
-  synchro->state = SIMIX_RUNNING;
-  synchro->execution.host = NULL; /* FIXME: do we need the list of hosts? */
-  synchro->category = NULL;
+  simgrid::simix::Exec *exec = new simgrid::simix::Exec();
+  exec->name = xbt_strdup(name);
+  exec->state = SIMIX_RUNNING;
+  exec->host = nullptr; /* FIXME: do we need the list of hosts? */
 
   /* set surf's synchro */
   host_list_cpy = xbt_new0(sg_host_t, host_nb);
@@ -331,79 +277,50 @@ smx_synchro_t SIMIX_execution_parallel_start(const char *name,
 
   /* set surf's synchro */
   if (!MC_is_active() && !MC_record_replay_is_active()) {
-    synchro->execution.surf_exec =
-      surf_host_model->executeParallelTask(
-          host_nb, host_list_cpy, flops_amount, bytes_amount, rate);
-
-    synchro->execution.surf_exec->setData(synchro);
+    exec->surf_exec = surf_host_model->executeParallelTask(host_nb, host_list_cpy, flops_amount, bytes_amount, rate);
+    exec->surf_exec->setData(exec);
   }
-  XBT_DEBUG("Create parallel execute synchro %p", synchro);
-
-  return synchro;
-}
+  XBT_DEBUG("Create parallel execute synchro %p", exec);
 
-void SIMIX_execution_destroy(smx_synchro_t synchro)
-{
-  XBT_DEBUG("Destroy synchro %p", synchro);
-
-  if (synchro->execution.surf_exec) {
-    synchro->execution.surf_exec->unref();
-    synchro->execution.surf_exec = NULL;
-  }
-  xbt_free(synchro->name);
-  xbt_mallocator_release(simix_global->synchro_mallocator, synchro);
+  return exec;
 }
 
 void SIMIX_execution_cancel(smx_synchro_t synchro)
 {
   XBT_DEBUG("Cancel synchro %p", synchro);
+  simgrid::simix::Exec *exec = static_cast<simgrid::simix::Exec *>(synchro);
 
-  if (synchro->execution.surf_exec)
-    synchro->execution.surf_exec->cancel();
-}
-
-double SIMIX_execution_get_remains(smx_synchro_t synchro)
-{
-  double result = 0.0;
-
-  if (synchro->state == SIMIX_RUNNING)
-    result = synchro->execution.surf_exec->getRemains();
-
-  return result;
-}
-
-e_smx_state_t SIMIX_execution_get_state(smx_synchro_t synchro)
-{
-  return synchro->state;
+  if (exec->surf_exec)
+    exec->surf_exec->cancel();
 }
 
 void SIMIX_execution_set_priority(smx_synchro_t synchro, double priority)
 {
-  if(synchro->execution.surf_exec)
-    synchro->execution.surf_exec->setPriority(priority);
+  simgrid::simix::Exec *exec = static_cast<simgrid::simix::Exec *>(synchro);
+  if(exec->surf_exec)
+    exec->surf_exec->setPriority(priority);
 }
 
 void SIMIX_execution_set_bound(smx_synchro_t synchro, double bound)
 {
-  if(synchro->execution.surf_exec)
-    static_cast<simgrid::surf::CpuAction*>(synchro->execution.surf_exec)->setBound(bound);
+  simgrid::simix::Exec *exec = static_cast<simgrid::simix::Exec *>(synchro);
+  if(exec->surf_exec)
+    static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)->setBound(bound);
 }
 
 void SIMIX_execution_set_affinity(smx_synchro_t synchro, sg_host_t host, unsigned long mask)
 {
-  xbt_assert(synchro->type == SIMIX_SYNC_EXECUTE);
-
-  if (synchro->execution.surf_exec) {
+  simgrid::simix::Exec *exec = static_cast<simgrid::simix::Exec *>(synchro);
+  if(exec->surf_exec) {
     /* just a double check to confirm that this host is the host where this task is running. */
-    xbt_assert(synchro->execution.host == host);
-    static_cast<simgrid::surf::CpuAction*>(synchro->execution.surf_exec)
-      ->setAffinity(host->pimpl_cpu, mask);
+    xbt_assert(exec->host == host);
+    static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)->setAffinity(host->pimpl_cpu, mask);
   }
 }
 
 void simcall_HANDLER_execution_wait(smx_simcall_t simcall, smx_synchro_t synchro)
 {
-
+  simgrid::simix::Exec *exec = static_cast<simgrid::simix::Exec *>(synchro);
   XBT_DEBUG("Wait for execution of synchro %p, state %d", synchro, (int)synchro->state);
 
   /* Associate this simcall to the synchro */
@@ -413,35 +330,23 @@ void simcall_HANDLER_execution_wait(smx_simcall_t simcall, smx_synchro_t synchro
   /* set surf's synchro */
   if (MC_is_active() || MC_record_replay_is_active()) {
     synchro->state = SIMIX_DONE;
-    SIMIX_execution_finish(synchro);
+    SIMIX_execution_finish(exec);
     return;
   }
 
   /* If the synchro is already finished then perform the error handling */
   if (synchro->state != SIMIX_RUNNING)
-    SIMIX_execution_finish(synchro);
-}
-
-void SIMIX_execution_suspend(smx_synchro_t synchro)
-{
-  if(synchro->execution.surf_exec)
-    synchro->execution.surf_exec->suspend();
+    SIMIX_execution_finish(exec);
 }
 
-void SIMIX_execution_resume(smx_synchro_t synchro)
-{
-  if(synchro->execution.surf_exec)
-    synchro->execution.surf_exec->resume();
-}
-
-void SIMIX_execution_finish(smx_synchro_t synchro)
+void SIMIX_execution_finish(simgrid::simix::Exec *exec)
 {
   xbt_fifo_item_t item;
   smx_simcall_t simcall;
 
-  xbt_fifo_foreach(synchro->simcalls, item, simcall, smx_simcall_t) {
+  xbt_fifo_foreach(exec->simcalls, item, simcall, smx_simcall_t) {
 
-    switch (synchro->state) {
+    switch (exec->state) {
 
       case SIMIX_DONE:
         /* do nothing, synchro done */
@@ -461,57 +366,34 @@ void SIMIX_execution_finish(smx_synchro_t synchro)
 
       default:
         xbt_die("Internal error in SIMIX_execution_finish: unexpected synchro state %d",
-            (int)synchro->state);
+            (int)exec->state);
     }
-    /* check if the host is down */
-    if (simcall->issuer->host->isOff()) {
+    /* Fail the process if the host is down */
+    if (simcall->issuer->host->isOff())
       simcall->issuer->context->iwannadie = 1;
-    }
 
-    simcall->issuer->waiting_synchro =    NULL;
-    simcall_execution_wait__set__result(simcall, synchro->state);
+    simcall->issuer->waiting_synchro = NULL;
+    simcall_execution_wait__set__result(simcall, exec->state);
     SIMIX_simcall_answer(simcall);
   }
 
   /* We no longer need it */
-  SIMIX_execution_destroy(synchro);
+  exec->unref();
 }
 
-
-void SIMIX_post_host_execute(smx_synchro_t synchro)
+void SIMIX_set_category(smx_synchro_t synchro, const char *category)
 {
-  if (synchro->type == SIMIX_SYNC_EXECUTE && /* FIMXE: handle resource failure
-                                               * for parallel tasks too */
-      synchro->execution.host->isOff()) {
-    /* If the host running the synchro failed, notice it so that the asking
-     * process can be killed if it runs on that host itself */
-    synchro->state = SIMIX_FAILED;
-  } else if (synchro->execution.surf_exec->getState() == SURF_ACTION_FAILED) {
-    /* If the host running the synchro didn't fail, then the synchro was
-     * canceled */
-    synchro->state = SIMIX_CANCELED;
-  } else {
-    synchro->state = SIMIX_DONE;
-  }
-
-  if (synchro->execution.surf_exec) {
-    synchro->execution.surf_exec->unref();
-    synchro->execution.surf_exec = NULL;
-  }
+  if (synchro->state != SIMIX_RUNNING) return;
 
-  /* If there are simcalls associated with the synchro, then answer them */
-  if (xbt_fifo_size(synchro->simcalls)) {
-    SIMIX_execution_finish(synchro);
+  simgrid::simix::Exec *exec = dynamic_cast<simgrid::simix::Exec *>(synchro);
+  if (exec != nullptr) {
+    exec->surf_exec->setCategory(category);
+    return;
   }
-}
 
-
-void SIMIX_set_category(smx_synchro_t synchro, const char *category)
-{
-  if (synchro->state != SIMIX_RUNNING) return;
-  if (synchro->type == SIMIX_SYNC_EXECUTE){
-    synchro->execution.surf_exec->setCategory(category);
-  }else if (synchro->type == SIMIX_SYNC_COMMUNICATE){
-    synchro->comm.surf_comm->setCategory(category);
+  simgrid::simix::Comm *comm = dynamic_cast<simgrid::simix::Comm *>(synchro);
+  if (comm != nullptr) {
+    comm->surf_comm->setCategory(category);
+    return;
   }
 }