Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Deprecate e_smx_state_t.
[simgrid.git] / src / simix / libsmx.cpp
index c25eee7..8d915db 100644 (file)
@@ -5,7 +5,7 @@
 /*                                                                            */
 /* This is somehow the "libc" of SimGrid                                      */
 
-/* Copyright (c) 2010-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2010-2020. 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. */
  *
  * @param execution The execution synchro
  */
-e_smx_state_t simcall_execution_wait(const smx_activity_t& execution)
+simgrid::kernel::activity::State simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution,
+                                                        double timeout) // XBT_ATTRIB_DEPRECATED_v330
 {
-  return (e_smx_state_t)simcall_BODY_execution_wait(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()));
+  simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
+  simgrid::kernel::actor::simcall_blocking<void>(
+      [execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
+  return simgrid::kernel::activity::State::DONE;
 }
 
-bool simcall_execution_test(const smx_activity_t& execution)
+simgrid::kernel::activity::State simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution,
+                                                        double timeout) // XBT_ATTRIB_DEPRECATED_v330
 {
-  return simcall_BODY_execution_test(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()));
+  simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
+  simgrid::kernel::actor::simcall_blocking<void>(
+      [execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
+  return simgrid::kernel::activity::State::DONE;
+}
+
+bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution) // XBT_ATTRIB_DEPRECATED_v330
+{
+  return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
+}
+
+bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution) // XBT_ATTRIB_DEPRECATED_v330
+{
+  return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
 }
 
 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count, double timeout)
@@ -44,27 +62,27 @@ unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl*
   return simcall_BODY_execution_waitany_for(execs, count, timeout);
 }
 
-void simcall_process_join(smx_actor_t process, double timeout)
+void simcall_process_join(smx_actor_t process, double timeout) // XBT_DEPRECATED_v328
 {
-  SIMIX_process_self()->join(process, timeout);
+  simgrid::kernel::actor::ActorImpl::self()->join(process, timeout);
 }
 
-void simcall_process_suspend(smx_actor_t process)
+void simcall_process_suspend(smx_actor_t process) // XBT_DEPRECATED_v328
 {
   process->iface()->suspend();
 }
 
-e_smx_state_t simcall_process_sleep(double duration)
+simgrid::kernel::activity::State simcall_process_sleep(double duration) // XBT_ATTRIB_DEPRECATED_v329
 {
-  SIMIX_process_self()->sleep(duration);
-  return SIMIX_DONE;
+  simgrid::kernel::actor::ActorImpl::self()->sleep(duration);
+  return simgrid::kernel::activity::State::DONE;
 }
 
 /**
  * @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*),
+                       size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
                        double timeout)
 {
@@ -77,10 +95,11 @@ void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size,
 
   if (MC_is_active() || MC_record_replay_is_active()) {
     /* the model-checker wants two separate simcalls */
-    smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
+    simgrid::kernel::activity::ActivityImplPtr comm =
+        nullptr; /* MC needs the comm to be set to nullptr during the simcall */
     comm = simcall_comm_isend(sender, mbox, task_size, rate,
         src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
-    simcall_comm_wait(comm, timeout);
+    simcall_comm_wait(comm.get(), timeout);
     comm = nullptr;
   }
   else {
@@ -92,12 +111,11 @@ void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size,
 /**
  * @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,
-                                  int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
-                                  void (*clean_fun)(void*),
-                                  void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
-                                  void* data, bool detached)
+simgrid::kernel::activity::ActivityImplPtr
+simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
+                   size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
+                   void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
+                   void* data, bool detached)
 {
   /* checking for infinite values */
   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
@@ -113,7 +131,7 @@ smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double
  * @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*),
+                       bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
                        double timeout, double rate)
 {
@@ -122,10 +140,11 @@ void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
 
   if (MC_is_active() || MC_record_replay_is_active()) {
     /* the model-checker wants two separate simcalls */
-    smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
+    simgrid::kernel::activity::ActivityImplPtr comm =
+        nullptr; /* MC needs the comm to be set to nullptr during the simcall */
     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
                               match_fun, copy_data_fun, data, rate);
-    simcall_comm_wait(comm, timeout);
+    simcall_comm_wait(comm.get(), timeout);
     comm = nullptr;
   }
   else {
@@ -136,10 +155,10 @@ void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
 /**
  * @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*),
-                                  void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
-                                  void* data, double rate)
+simgrid::kernel::activity::ActivityImplPtr
+simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
+                   bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
+                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
 {
   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 
@@ -150,8 +169,9 @@ smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void
 /**
  * @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)
+simgrid::kernel::activity::ActivityImplPtr
+simcall_comm_iprobe(smx_mailbox_t mbox, int type, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
+                    void* data) // XBT_ATTRIB_DEPRECATED_v330
 {
   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
 
@@ -161,10 +181,11 @@ smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
 /**
  * @ingroup simix_comm_management
  */
-unsigned int simcall_comm_waitany(smx_activity_t comms[], size_t count, double timeout)
+unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count,
+                                  double timeout) // XBT_ATTRIB_DEPRECATED_v330
 {
   std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
-  std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& comm) {
+  std::transform(comms, comms + count, rcomms.get(), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
     return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
   });
   return simcall_BODY_comm_waitany(rcomms.get(), count, timeout);
@@ -178,12 +199,12 @@ unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[],
 /**
  * @ingroup simix_comm_management
  */
-int simcall_comm_testany(smx_activity_t comms[], size_t count)
+int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v330
 {
   if (count == 0)
     return -1;
   std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
-  std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& comm) {
+  std::transform(comms, comms + count, rcomms.get(), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
     return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
   });
   return simcall_BODY_comm_testany(rcomms.get(), count);
@@ -199,26 +220,26 @@ int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t co
 /**
  * @ingroup simix_comm_management
  */
-void simcall_comm_wait(const smx_activity_t& comm, double timeout)
+void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
 {
   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
-  simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()), timeout);
+  simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
 }
 
 /**
  * @ingroup simix_comm_management
  *
  */
-bool simcall_comm_test(const smx_activity_t& comm)
+bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm)
 {
-  return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()));
+  return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm));
 }
 
 /**
  * @ingroup simix_synchro_management
  *
  */
-smx_mutex_t simcall_mutex_init()
+smx_mutex_t simcall_mutex_init() // XBT_ATTRIB_DEPRECATED_v330
 {
   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
@@ -259,7 +280,7 @@ void simcall_mutex_unlock(smx_mutex_t mutex)
  * @ingroup simix_synchro_management
  *
  */
-smx_cond_t simcall_cond_init()
+smx_cond_t simcall_cond_init() // XBT_ATTRIB_DEPRECATED_v330
 {
   return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
 }
@@ -302,20 +323,41 @@ int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
   return simcall_BODY_sem_acquire_timeout(sem, timeout);
 }
 
-e_smx_state_t simcall_io_wait(const smx_activity_t& io)
+simgrid::kernel::activity::State simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io,
+                                                 double timeout) // XBT_ATTRIB_DEPRECATED_v330
 {
-  return (e_smx_state_t)simcall_BODY_io_wait(static_cast<simgrid::kernel::activity::IoImpl*>(io.get()));
+  simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
+  simgrid::kernel::actor::simcall_blocking<void>([io, issuer, timeout] { io->wait_for(issuer, timeout); });
+  return simgrid::kernel::activity::State::DONE;
+}
+
+simgrid::kernel::activity::State simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io,
+                                                 double timeout) // XBT_ATTRIB_DEPRECATED_v330
+{
+  simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
+  simgrid::kernel::actor::simcall_blocking<void>([io, issuer, timeout] { io->wait_for(issuer, timeout); });
+  return simgrid::kernel::activity::State::DONE;
+}
+
+bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io) // XBT_ATTRIB_DEPRECATED_v330
+{
+  return simgrid::kernel::actor::simcall([io] { return io->test(); });
+}
+
+bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io) // XBT_ATTRIB_DEPRECATD_v330
+{
+  return simgrid::kernel::actor::simcall([io] { return io->test(); });
 }
 
 void simcall_run_kernel(std::function<void()> const& code, simgrid::mc::SimcallInspector* t)
 {
-  SIMIX_process_self()->simcall.inspector_ = t;
+  simgrid::kernel::actor::ActorImpl::self()->simcall.inspector_ = t;
   simcall_BODY_run_kernel(&code);
 }
 
 void simcall_run_blocking(std::function<void()> const& code, simgrid::mc::SimcallInspector* t = nullptr)
 {
-  SIMIX_process_self()->simcall.inspector_ = t;
+  simgrid::kernel::actor::ActorImpl::self()->simcall.inspector_ = t;
   simcall_BODY_run_blocking(&code);
 }
 
@@ -340,94 +382,3 @@ void unblock(smx_actor_t actor)
 }
 } // namespace simix
 } // namespace simgrid
-
-/* ****************************DEPRECATED CALLS******************************* */
-void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
-{
-  simgrid::kernel::actor::simcall([process, kill_time] { process->set_kill_time(kill_time); });
-}
-void simcall_comm_cancel(smx_activity_t comm)
-{
-  simgrid::kernel::actor::simcall(
-      [comm] { boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(comm)->cancel(); });
-}
-void simcall_execution_cancel(smx_activity_t exec)
-{
-  simgrid::kernel::actor::simcall(
-      [exec] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->cancel(); });
-}
-
-void simcall_execution_set_bound(smx_activity_t exec, double bound)
-{
-  simgrid::kernel::actor::simcall(
-      [exec, bound] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_bound(bound); });
-}
-
-// deprecated
-smx_activity_t simcall_execution_start(const std::string& name, const std::string& category, double flops_amount,
-                                       double sharing_penalty, double bound, sg_host_t host)
-{
-  return simgrid::kernel::actor::simcall([name, category, flops_amount, sharing_penalty, bound, host] {
-    simgrid::kernel::activity::ExecImpl* exec = new simgrid::kernel::activity::ExecImpl();
-    (*exec)
-        .set_name(name)
-        .set_tracing_category(category)
-        .set_host(host)
-        .set_sharing_penalty(sharing_penalty)
-        .set_bound(bound)
-        .set_flops_amount(flops_amount)
-        .start();
-    return simgrid::kernel::activity::ExecImplPtr(exec);
-  });
-}
-
-// deprecated
-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)
-{
-  /* Check that we are not mixing VMs and PMs in the parallel task */
-  bool is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[0]));
-  for (int i = 1; i < host_nb; i++) {
-    bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[i]));
-    xbt_assert(is_a_vm == tmp_is_a_vm, "parallel_execute: mixing VMs and PMs is not supported (yet).");
-  }
-
-  /* checking for infinite values */
-  for (int i = 0; i < host_nb; ++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]), "bytes_amount[%d+%d*%d] is not finite!", i, host_nb,
-                   j);
-      }
-    }
-  }
-  xbt_assert(std::isfinite(rate), "rate is not finite!");
-
-  std::vector<simgrid::s4u::Host*> hosts(host_list, host_list + host_nb);
-  std::vector<double> flops_parallel_amount;
-  std::vector<double> bytes_parallel_amount;
-  if (flops_amount != nullptr)
-    flops_parallel_amount = std::vector<double>(flops_amount, flops_amount + host_nb);
-  if (bytes_amount != nullptr)
-    bytes_parallel_amount = std::vector<double>(bytes_amount, bytes_amount + host_nb * host_nb);
-  return simgrid::kernel::actor::simcall([name, hosts, flops_parallel_amount, bytes_parallel_amount, timeout] {
-    simgrid::kernel::activity::ExecImpl* exec = new simgrid::kernel::activity::ExecImpl();
-    (*exec)
-        .set_name(name)
-        .set_hosts(hosts)
-        .set_timeout(timeout)
-        .set_flops_amounts(flops_parallel_amount)
-        .set_bytes_amounts(bytes_parallel_amount)
-        .start();
-    return simgrid::kernel::activity::ExecImplPtr(exec);
-  });
-}
-
-// deprecated
-void SIMIX_comm_finish(smx_activity_t synchro)
-{
-  boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro)->finish();
-}