Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
SIMIX_io_finish becomes IoImp::finish
[simgrid.git] / src / simix / libsmx.cpp
index a40d1b0..247dd90 100644 (file)
@@ -5,7 +5,7 @@
 /*                                                                            */
 /* This is somehow the "libc" of SimGrid                                      */
 
-/* Copyright (c) 2010-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2010-2019. 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. */
@@ -15,6 +15,8 @@
 #include "src/kernel/activity/CommImpl.hpp"
 #include "src/kernel/activity/ConditionVariableImpl.hpp"
 #include "src/kernel/activity/ExecImpl.hpp"
+#include "src/kernel/activity/IoImpl.hpp"
+#include "src/kernel/activity/MailboxImpl.hpp"
 #include "src/kernel/activity/MutexImpl.hpp"
 #include "src/mc/mc_replay.hpp"
 #include "src/plugins/vm/VirtualMachineImpl.hpp"
@@ -25,52 +27,28 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
 #include "popping_bodies.cpp"
 
 /**
- * \ingroup simix_process_management
- * \brief Creates a synchro that executes some computation of an host.
- *
- * This function creates a SURF action and allocates the data necessary
- * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
- *
- * \param name Name of the execution synchro to create
- * \param flops_amount amount Computation amount (in flops)
- * \param priority computation priority
- * \param bound
- * \param host host where the synchro will be executed
- * \return A new SIMIX execution synchronization
- */
-smx_activity_t simcall_execution_start(const char* name, double flops_amount, double priority, double bound,
-                                       simgrid::s4u::Host* host)
-{
-  /* checking for infinite values */
-  xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
-  xbt_assert(std::isfinite(priority), "priority is not finite!");
-
-  return simgrid::simix::simcall([name, flops_amount, priority, bound, host] {
-    return SIMIX_execution_start(name, flops_amount, priority, bound, host);
-  });
-}
-
-/**
- * \ingroup simix_process_management
- * \brief Creates a synchro that may involve parallel computation on
+ * @ingroup simix_process_management
+ * @brief Creates a synchro that may involve parallel computation on
  * several hosts and communication between them.
  *
- * \param name Name of the execution synchro to create
- * \param host_nb Number of hosts where the synchro will be executed
- * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
- * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
- * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
+ * @param name Name of the execution synchro to create
+ * @param host_nb Number of hosts where the synchro will be executed
+ * @param host_list Array (of size host_nb) of hosts where the synchro will be executed
+ * @param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
+ * @param bytes_amount Array (of size host_nb * host_nb) representing the communication
  * amount between each pair of hosts
- * \param rate the SURF action rate
- * \param timeout timeout
- * \return A new SIMIX execution synchronization
+ * @param rate the SURF action rate
+ * @param timeout timeout
+ * @return A new SIMIX execution synchronization
  */
-smx_activity_t simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list,
-                                                double* flops_amount, double* bytes_amount, double rate, double timeout)
+smx_activity_t simcall_execution_parallel_start(const std::string& name, int host_nb, const sg_host_t* host_list,
+                                                const double* flops_amount, const double* bytes_amount, double rate,
+                                                double timeout)
 {
   /* checking for infinite values */
   for (int i = 0 ; i < host_nb ; ++i) {
-    xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
+    if (flops_amount != nullptr)
+      xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
     if (bytes_amount != nullptr) {
       for (int j = 0 ; j < host_nb ; ++j) {
         xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
@@ -82,68 +60,16 @@ smx_activity_t simcall_execution_parallel_start(const char* name, int host_nb, s
   xbt_assert(std::isfinite(rate), "rate is not finite!");
 
   return simgrid::simix::simcall([name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout] {
-    return SIMIX_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout);
-  });
-}
-
-/**
- * \ingroup simix_process_management
- * \brief Cancels an execution synchro.
- *
- * This functions stops the execution. It calls a surf function.
- * \param execution The execution synchro to cancel
- */
-void simcall_execution_cancel(smx_activity_t execution)
-{
-  simgrid::kernel::activity::ExecImplPtr exec =
-      boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
-  if (exec->surf_action_ == nullptr) // FIXME: One test fails if I remove this, but I don't get why...
-    return;
-  simgrid::simix::simcall([exec] { exec->cancel(); });
-}
-
-/**
- * \ingroup simix_process_management
- * \brief Changes the priority of an execution synchro.
- *
- * This functions changes the priority only. It calls a surf function.
- * \param execution The execution synchro
- * \param priority The new priority
- */
-void simcall_execution_set_priority(smx_activity_t execution, double priority)
-{
-  /* checking for infinite values */
-  xbt_assert(std::isfinite(priority), "priority is not finite!");
-  simgrid::simix::simcall([execution, priority] {
-
-    simgrid::kernel::activity::ExecImplPtr exec =
-        boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
-    exec->set_priority(priority);
-  });
-}
-
-/**
- * \ingroup simix_process_management
- * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
- *
- * This functions changes the capping only. It calls a surf function.
- * \param execution The execution synchro
- * \param bound The new bound
- */
-void simcall_execution_set_bound(smx_activity_t execution, double bound)
-{
-  simgrid::simix::simcall([execution, bound] {
-    simgrid::kernel::activity::ExecImplPtr exec =
-        boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
-    exec->set_bound(bound);
+    return SIMIX_execution_parallel_start(std::move(name), host_nb, host_list, flops_amount, bytes_amount, rate,
+                                          timeout);
   });
 }
 
 /**
- * \ingroup simix_host_management
- * \brief Waits for the completion of an execution synchro and destroy it.
+ * @ingroup simix_host_management
+ * @brief Waits for the completion of an execution synchro and destroy it.
  *
- * \param execution The execution synchro
+ * @param execution The execution synchro
  */
 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
 {
@@ -161,13 +87,8 @@ void simcall_process_join(smx_actor_t process, double timeout)
 }
 
 /**
- * \ingroup simix_process_management
- * \brief Suspends a process.
- *
- * This function suspends the process by suspending the synchro
- * it was waiting for completion.
- *
- * \param process a SIMIX process
+ * @ingroup simix_process_management
+ * @brief Suspends an actor
  */
 void simcall_process_suspend(smx_actor_t process)
 {
@@ -175,44 +96,15 @@ void simcall_process_suspend(smx_actor_t process)
 }
 
 /**
- * \ingroup simix_process_management
- * \brief Set the user data of a #smx_actor_t.
- *
- * This functions sets the user data associated to \a process.
- * \param process SIMIX process
- * \param data User data
- */
-void simcall_process_set_data(smx_actor_t process, void *data)
-{
-  simgrid::simix::simcall([process, data] { process->set_user_data(data); });
-}
-
-/**
- * \ingroup simix_process_management
- * \brief Set the kill time of a process.
- */
-void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
-{
-
-  if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
-    return;
-  XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->get_cname(), process->host_->get_cname());
-  process->kill_timer = SIMIX_timer_set(kill_time, [process] {
-    simix_global->kill_process_function(process);
-    process->kill_timer=nullptr;
-  });
-}
-
-/**
- * \ingroup simix_process_management
- * \brief Creates a new sleep SIMIX synchro.
+ * @ingroup simix_process_management
+ * @brief Creates a new sleep SIMIX synchro.
  *
  * This function creates a SURF action and allocates the data necessary
- * to create the SIMIX synchro. It can raise a host_error exception if the
+ * to create the SIMIX synchro. It can raise a HostFailureException if the
  * host crashed. The default SIMIX name of the synchro is "sleep".
  *
- *   \param duration Time duration of the sleep.
- *   \return A result telling whether the sleep was successful
+ *   @param duration Time duration of the sleep.
+ *   @return A result telling whether the sleep was successful
  */
 e_smx_state_t simcall_process_sleep(double duration)
 {
@@ -222,7 +114,7 @@ e_smx_state_t simcall_process_sleep(double duration)
 }
 
 /**
- * \ingroup simix_comm_management
+ * @ingroup simix_comm_management
  */
 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
                        size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
@@ -250,7 +142,7 @@ void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size,
 }
 
 /**
- * \ingroup simix_comm_management
+ * @ingroup simix_comm_management
  */
 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
                                   size_t src_buff_size,
@@ -270,7 +162,7 @@ smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double
 }
 
 /**
- * \ingroup simix_comm_management
+ * @ingroup simix_comm_management
  */
 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
                        int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
@@ -293,7 +185,7 @@ void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
   }
 }
 /**
- * \ingroup simix_comm_management
+ * @ingroup simix_comm_management
  */
 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
@@ -306,30 +198,18 @@ smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void
 }
 
 /**
- * \ingroup simix_comm_management
+ * @ingroup simix_comm_management
  */
 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
                                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
 {
   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
 
-  return simcall_BODY_comm_iprobe(mbox, type, match_fun, data);
-}
-
-/**
- * \ingroup simix_comm_management
- */
-void simcall_comm_cancel(smx_activity_t synchro)
-{
-  simgrid::simix::simcall([synchro] {
-    simgrid::kernel::activity::CommImplPtr comm =
-        boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
-    comm->cancel();
-  });
+  return simgrid::simix::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
 }
 
 /**
- * \ingroup simix_comm_management
+ * @ingroup simix_comm_management
  */
 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
 {
@@ -337,7 +217,7 @@ unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
 }
 
 /**
- * \ingroup simix_comm_management
+ * @ingroup simix_comm_management
  */
 int simcall_comm_testany(smx_activity_t* comms, size_t count)
 {
@@ -347,7 +227,7 @@ int simcall_comm_testany(smx_activity_t* comms, size_t count)
 }
 
 /**
- * \ingroup simix_comm_management
+ * @ingroup simix_comm_management
  */
 void simcall_comm_wait(smx_activity_t comm, double timeout)
 {
@@ -356,22 +236,7 @@ void simcall_comm_wait(smx_activity_t comm, double timeout)
 }
 
 /**
- * \brief Set the category of an synchro.
- *
- * This functions changes the category only. It calls a surf function.
- * \param synchro The execution synchro
- * \param category The tracing category
- */
-void simcall_set_category(smx_activity_t synchro, const char *category)
-{
-  if (category == nullptr) {
-    return;
-  }
-  simgrid::simix::simcall([synchro, category] { SIMIX_set_category(synchro, category); });
-}
-
-/**
- * \ingroup simix_comm_management
+ * @ingroup simix_comm_management
  *
  */
 int simcall_comm_test(smx_activity_t comm)
@@ -380,20 +245,21 @@ int simcall_comm_test(smx_activity_t comm)
 }
 
 /**
- * \ingroup simix_synchro_management
+ * @ingroup simix_synchro_management
  *
  */
 smx_mutex_t simcall_mutex_init()
 {
-  if (not simix_global) {
-    fprintf(stderr,"You must run MSG_init before using MSG\n"); // We can't use xbt_die since we may get there before the initialization
+  if (simix_global == nullptr) {
+    fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
+                                                                                 // get there before the initialization
     xbt_abort();
   }
   return simgrid::simix::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
 }
 
 /**
- * \ingroup simix_synchro_management
+ * @ingroup simix_synchro_management
  *
  */
 void simcall_mutex_lock(smx_mutex_t mutex)
@@ -402,7 +268,7 @@ void simcall_mutex_lock(smx_mutex_t mutex)
 }
 
 /**
- * \ingroup simix_synchro_management
+ * @ingroup simix_synchro_management
  *
  */
 int simcall_mutex_trylock(smx_mutex_t mutex)
@@ -411,7 +277,7 @@ int simcall_mutex_trylock(smx_mutex_t mutex)
 }
 
 /**
- * \ingroup simix_synchro_management
+ * @ingroup simix_synchro_management
  *
  */
 void simcall_mutex_unlock(smx_mutex_t mutex)
@@ -420,7 +286,7 @@ void simcall_mutex_unlock(smx_mutex_t mutex)
 }
 
 /**
- * \ingroup simix_synchro_management
+ * @ingroup simix_synchro_management
  *
  */
 smx_cond_t simcall_cond_init()
@@ -429,7 +295,7 @@ smx_cond_t simcall_cond_init()
 }
 
 /**
- * \ingroup simix_synchro_management
+ * @ingroup simix_synchro_management
  *
  */
 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
@@ -438,7 +304,7 @@ void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
 }
 
 /**
- * \ingroup simix_synchro_management
+ * @ingroup simix_synchro_management
  *
  */
 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
@@ -448,7 +314,7 @@ int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout
 }
 
 /**
- * \ingroup simix_synchro_management
+ * @ingroup simix_synchro_management
  *
  */
 void simcall_sem_acquire(smx_sem_t sem)
@@ -457,7 +323,7 @@ void simcall_sem_acquire(smx_sem_t sem)
 }
 
 /**
- * \ingroup simix_synchro_management
+ * @ingroup simix_synchro_management
  *
  */
 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
@@ -466,14 +332,9 @@ int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
   return simcall_BODY_sem_acquire_timeout(sem, timeout);
 }
 
-sg_size_t simcall_storage_read(surf_storage_t st, sg_size_t size)
-{
-  return simcall_BODY_storage_read(st, size);
-}
-
-sg_size_t simcall_storage_write(surf_storage_t st, sg_size_t size)
+e_smx_state_t simcall_io_wait(smx_activity_t io)
 {
-  return simcall_BODY_storage_write(st, size);
+  return (e_smx_state_t)simcall_BODY_io_wait(io);
 }
 
 void simcall_run_kernel(std::function<void()> const& code)
@@ -505,6 +366,41 @@ void unblock(smx_actor_t process)
   xbt_assert(SIMIX_is_maestro());
   SIMIX_simcall_answer(&process->simcall);
 }
+} // namespace simix
+} // namespace simgrid
+
+/* ****************************DEPRECATED CALLS******************************* */
+void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
+{
+  simgrid::simix::simcall([process, kill_time] { process->set_kill_time(kill_time); });
+}
+void simcall_comm_cancel(smx_activity_t comm)
+{
+  simgrid::simix::simcall([comm] { boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(comm)->cancel(); });
+}
+void simcall_execution_cancel(smx_activity_t exec)
+{
+  simgrid::simix::simcall([exec] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->cancel(); });
+}
+void simcall_execution_set_priority(smx_activity_t exec, double priority)
+{
+  simgrid::simix::simcall([exec, priority] {
+    boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_priority(priority);
+  });
+}
 
+void simcall_execution_set_bound(smx_activity_t exec, double bound)
+{
+  simgrid::simix::simcall(
+      [exec, bound] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_bound(bound); });
 }
+
+smx_activity_t simcall_execution_start(const std::string& name, const std::string& category, double flops_amount,
+                                       double priority, double bound, sg_host_t host)
+{
+  return simgrid::simix::simcall([name, category, flops_amount, priority, bound, host] {
+    return simgrid::kernel::activity::ExecImplPtr(
+               new simgrid::kernel::activity::ExecImpl(std::move(name), std::move(category), nullptr, host))
+        ->start(flops_amount, priority, bound);
+  });
 }