Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Avoid unnecessary copy of parameters for parallel_execute.
[simgrid.git] / src / simix / libsmx.cpp
index 850f15d..f8d41b2 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. */
@@ -26,33 +26,6 @@ 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 HostFailureException exception if the host crashed.
- *
- * @param name Name of the execution synchro to create
- * @param category Tracing category
- * @param flops_amount amount Computation amount (in flops)
- * @param priority computation priority
- * @param bound Maximal speed for this execution (in flops) or -1 if no limit
- * @param host host where the synchro will be executed
- * @return A new SIMIX execution synchronization
- */
-smx_activity_t simcall_execution_start(std::string name, std::string category, 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, category, flops_amount, priority, bound, host] {
-    return SIMIX_execution_start(name, category, flops_amount, priority, bound, host);
-  });
-}
-
 /**
  * @ingroup simix_process_management
  * @brief Creates a synchro that may involve parallel computation on
@@ -68,8 +41,9 @@ smx_activity_t simcall_execution_start(std::string name, std::string category, d
  * @param timeout timeout
  * @return A new SIMIX execution synchronization
  */
-smx_activity_t simcall_execution_parallel_start(std::string 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) {
@@ -90,59 +64,6 @@ smx_activity_t simcall_execution_parallel_start(std::string name, int host_nb, s
   });
 }
 
-/**
- * @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);
-  });
-}
-
 /**
  * @ingroup simix_host_management
  * @brief Waits for the completion of an execution synchro and destroy it.
@@ -166,47 +87,13 @@ 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
+ * @brief Suspends an actor
  */
 void simcall_process_suspend(smx_actor_t process)
 {
   simcall_BODY_process_suspend(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())
-    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_process_kill(process, nullptr);
-    process->kill_timer=nullptr;
-  });
-}
-
 /**
  * @ingroup simix_process_management
  * @brief Creates a new sleep SIMIX synchro.
@@ -320,18 +207,6 @@ smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
   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();
-  });
-}
-
 /**
  * @ingroup simix_comm_management
  */
@@ -359,21 +234,6 @@ void simcall_comm_wait(smx_activity_t comm, double timeout)
   simcall_BODY_comm_wait(comm, 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, std::string category)
-{
-  if (category.empty()) {
-    return;
-  }
-  simgrid::simix::simcall([synchro, category] { SIMIX_set_category(synchro, category); });
-}
-
 /**
  * @ingroup simix_comm_management
  *
@@ -389,8 +249,9 @@ int simcall_comm_test(smx_activity_t comm)
  */
 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(); });
@@ -504,6 +365,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(std::string name, 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(name, category, nullptr, host))
+        ->start(flops_amount, priority, bound);
+  });
 }