Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove deprecated features for next release (3.30).
[simgrid.git] / src / msg / msg_legacy.cpp
index 431070e..bc717ec 100644 (file)
@@ -1,9 +1,12 @@
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2021. 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. */
 
+#include "simgrid/Exception.hpp"
+#include "simgrid/s4u/Engine.hpp"
 #include "src/msg/msg_private.hpp"
+#include "xbt/functional.hpp"
 
 #define MSG_CALL(type, oldname, args)
 
@@ -22,13 +25,17 @@ msg_error_t MSG_main()
   simgrid_run();
   return MSG_OK;
 }
-void MSG_function_register(const char* name, xbt_main_func_t code)
+void MSG_function_register(const char* name, int (*code)(int, char**))
 {
-  simgrid_register_function(name, code);
+  simgrid::kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
+    return simgrid::xbt::wrap_main(code, std::move(args));
+  };
+  simgrid::s4u::Engine::get_instance()->register_function(name, code_factory);
 }
-void MSG_function_register_default(xbt_main_func_t code)
+void MSG_function_register_default(int (*code)(int, char**))
 {
-  simgrid_register_default(code);
+  simgrid::s4u::Engine::get_instance()->register_default(
+      [code](std::vector<std::string> args) { return simgrid::xbt::wrap_main(code, std::move(args)); });
 }
 double MSG_get_clock()
 {
@@ -46,31 +53,38 @@ int MSG_task_listen(const char* alias)
 }
 
 /* ************************** Actors *************************** */
-int MSG_process_get_PID(sg_actor_t actor)
+void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data)
 {
-  return sg_actor_get_PID(actor);
+  /* We can't use the sg_actor_on_exit, as the return type of the callback changed: the int in MSG is ignored and was
+   * removed in sg */
+  simgrid::s4u::this_actor::on_exit([fun, data](bool failed) { fun(failed ? 1 /*FAILURE*/ : 0 /*SUCCESS*/, data); });
 }
-int MSG_process_get_PPID(sg_actor_t actor)
+
+int MSG_process_get_PID(const_sg_actor_t actor)
+{
+  return sg_actor_get_pid(actor);
+}
+int MSG_process_get_PPID(const_sg_actor_t actor)
 {
-  return sg_actor_get_PPID(actor);
+  return sg_actor_get_ppid(actor);
 }
-msg_process_t MSG_process_from_PID(int PID)
+msg_process_t MSG_process_from_PID(int pid)
 {
-  return sg_actor_by_PID(PID);
+  return sg_actor_by_pid(pid);
 }
-const char* MSG_process_get_name(sg_actor_t actor)
+const char* MSG_process_get_name(const_sg_actor_t actor)
 {
   return sg_actor_get_name(actor);
 }
-sg_host_t MSG_process_get_host(sg_actor_t actor)
+sg_host_t MSG_process_get_host(const_sg_actor_t actor)
 {
   return sg_actor_get_host(actor);
 }
-xbt_dict_t MSG_process_get_properties(sg_actor_t actor)
+xbt_dict_t MSG_process_get_properties(const_sg_actor_t actor)
 {
   return sg_actor_get_properties(actor);
 }
-const char* MSG_process_get_property_value(sg_actor_t actor, const char* name)
+const char* MSG_process_get_property_value(const_sg_actor_t actor, const char* name)
 {
   return sg_actor_get_property_value(actor, name);
 }
@@ -82,7 +96,7 @@ void MSG_process_resume(sg_actor_t actor)
 {
   sg_actor_resume(actor);
 }
-int MSG_process_is_suspended(sg_actor_t actor)
+int MSG_process_is_suspended(const_sg_actor_t actor)
 {
   return sg_actor_is_suspended(actor);
 }
@@ -101,9 +115,9 @@ void MSG_process_daemonize(sg_actor_t actor)
 }
 void MSG_process_migrate(sg_actor_t actor, sg_host_t host)
 {
-  sg_actor_migrate(actor, host);
+  sg_actor_set_host(actor, host);
 }
-void MSG_process_join(sg_actor_t actor, double timeout)
+void MSG_process_join(const_sg_actor_t actor, double timeout)
 {
   sg_actor_join(actor, timeout);
 }
@@ -124,87 +138,119 @@ void MSG_process_yield()
   sg_actor_yield();
 }
 
-/* ************************** NetZones *************************** */
-sg_netzone_t MSG_zone_get_root()
+msg_error_t MSG_process_sleep(double duration)
 {
-  return sg_zone_get_root();
+  try {
+    sg_actor_sleep_for(duration);
+    return MSG_OK;
+  } catch (const simgrid::HostFailureException&) {
+    return MSG_HOST_FAILURE;
+  }
 }
-const char* MSG_zone_get_name(sg_netzone_t zone)
+
+/** @brief Returns the user data of a process.
+ *
+ * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
+ */
+void* MSG_process_get_data(const_sg_actor_t process)
 {
-  return sg_zone_get_name(zone);
+  xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
+
+  /* get from SIMIX the MSG process data, and then the user data */
+  return sg_actor_get_data(process);
 }
-sg_netzone_t MSG_zone_get_by_name(const char* name)
-{
-  return sg_zone_get_by_name(name);
+
+/** @brief Sets the user data of a process.
+ *
+ * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
+ */
+msg_error_t MSG_process_set_data(msg_process_t process, void* data)
+{
+  xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
+  sg_actor_set_data(process, data);
+
+  return MSG_OK;
 }
-void MSG_zone_get_sons(sg_netzone_t zone, xbt_dict_t whereto)
+
+msg_process_t MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties)
 {
-  return sg_zone_get_sons(zone, whereto);
+  return sg_actor_attach(name, data, host, properties);
 }
-const char* MSG_zone_get_property_value(sg_netzone_t zone, const char* name)
+
+void MSG_process_detach()
 {
-  return sg_zone_get_property_value(zone, name);
+  sg_actor_detach();
 }
-void MSG_zone_set_property_value(sg_netzone_t zone, const char* name, char* value)
+aid_t MSG_process_self_PID()
 {
-  sg_zone_set_property_value(zone, name, value);
+  return sg_actor_self_get_pid();
 }
-void MSG_zone_get_hosts(sg_netzone_t zone, xbt_dynar_t whereto)
+
+/** @brief Return the PPID of the current process.
+ *
+ * This function returns the PID of the parent of the currently running #msg_process_t.
+ */
+aid_t MSG_process_self_PPID()
 {
-  sg_zone_get_hosts(zone, whereto);
+  return sg_actor_self_get_ppid();
 }
 
-/* ************************** Storages *************************** */
-const char* MSG_storage_get_name(sg_storage_t storage)
+/** @brief Return the name of the current process. */
+const char* MSG_process_self_name()
 {
-  return sg_storage_get_name(storage);
+  return sg_actor_self_get_name();
 }
-sg_storage_t MSG_storage_get_by_name(const char* name)
+/** @brief Return the current process.
+ *
+ * This function returns the currently running #msg_process_t.
+ */
+msg_process_t MSG_process_self()
 {
-  return sg_storage_get_by_name(name);
+  return sg_actor_self();
 }
-xbt_dict_t MSG_storage_get_properties(sg_storage_t storage)
+
+/** @brief Take an extra reference on that process to prevent it to be garbage-collected */
+void MSG_process_ref(const_sg_actor_t process)
 {
-  return sg_storage_get_properties(storage);
+  sg_actor_ref(process);
 }
-void MSG_storage_set_property_value(sg_storage_t storage, const char* name, const char* value)
+/** @brief Release a reference on that process so that it can get be garbage-collected */
+void MSG_process_unref(const_sg_actor_t process)
 {
-  sg_storage_set_property_value(storage, name, value);
+  sg_actor_unref(process);
 }
-const char* MSG_storage_get_property_value(sg_storage_t storage, const char* name)
+
+/* ************************** NetZones *************************** */
+sg_netzone_t MSG_zone_get_root()
 {
-  return sg_storage_get_property_value(storage, name);
+  return sg_zone_get_root();
 }
-xbt_dynar_t MSG_storages_as_dynar()
+const char* MSG_zone_get_name(const_sg_netzone_t zone)
 {
-  return sg_storages_as_dynar();
+  return sg_zone_get_name(zone);
 }
-void MSG_storage_set_data(sg_storage_t storage, void* data)
+sg_netzone_t MSG_zone_get_by_name(const char* name)
 {
-  sg_storage_set_data(storage, data);
+  return sg_zone_get_by_name(name);
 }
-void* MSG_storage_get_data(sg_storage_t storage)
+void MSG_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
 {
-  return sg_storage_get_data(storage);
+  return sg_zone_get_sons(zone, whereto);
 }
-const char* MSG_storage_get_host(sg_storage_t storage)
+const char* MSG_zone_get_property_value(const_sg_netzone_t zone, const char* name)
 {
-  return sg_storage_get_host(storage);
+  return sg_zone_get_property_value(zone, name);
 }
-sg_size_t MSG_storage_read(sg_storage_t storage, sg_size_t size)
+void MSG_zone_set_property_value(sg_netzone_t zone, const char* name, const char* value)
 {
-  return sg_storage_read(storage, size);
+  sg_zone_set_property_value(zone, name, value);
 }
-sg_size_t MSG_storage_write(sg_storage_t storage, sg_size_t size)
+void MSG_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
 {
-  return sg_storage_write(storage, size);
+  sg_zone_get_hosts(zone, whereto);
 }
 
 /* ************************** hosts *************************** */
-xbt_dynar_t MSG_hosts_as_dynar()
-{
-  return sg_hosts_as_dynar();
-}
 size_t MSG_get_host_number()
 {
   return sg_host_count();
@@ -217,43 +263,35 @@ sg_host_t MSG_host_by_name(const char* name)
 {
   return sg_host_by_name(name);
 }
-const char* MSG_host_get_name(sg_host_t host)
+const char* MSG_host_get_name(const_sg_host_t host)
 {
   return sg_host_get_name(host);
 }
-void* MSG_host_get_data(sg_host_t host)
+void* MSG_host_get_data(const_sg_host_t host)
 {
-  return sg_host_user(host);
+  return sg_host_get_data(host);
 }
 void MSG_host_set_data(sg_host_t host, void* data)
 {
-  return sg_host_user_set(host, data);
-}
-xbt_dict_t MSG_host_get_mounted_storage_list(sg_host_t host)
-{
-  return sg_host_get_mounted_storage_list(host);
-}
-xbt_dynar_t MSG_host_get_attached_storage_lists(sg_host_t host)
-{
-  return sg_host_get_attached_storage_list(host);
+  return sg_host_set_data(host, data);
 }
-double MSG_host_get_speed(sg_host_t host)
+double MSG_host_get_speed(const_sg_host_t host)
 {
-  return sg_host_speed(host);
+  return sg_host_get_speed(host);
 }
-double MSG_host_get_power_peak_at(sg_host_t host, int pstate_index)
+double MSG_host_get_power_peak_at(const_sg_host_t host, int pstate_index)
 {
   return sg_host_get_pstate_speed(host, pstate_index);
 }
-int MSG_host_get_core_number(sg_host_t host)
+int MSG_host_get_core_number(const_sg_host_t host)
 {
   return sg_host_core_count(host);
 }
-int MSG_host_get_nb_pstates(sg_host_t host)
+int MSG_host_get_nb_pstates(const_sg_host_t host)
 {
   return sg_host_get_nb_pstates(host);
 }
-int MSG_host_get_pstate(sg_host_t host)
+int MSG_host_get_pstate(const_sg_host_t host)
 {
   return sg_host_get_pstate(host);
 }
@@ -269,19 +307,15 @@ void MSG_host_off(sg_host_t h)
 {
   sg_host_turn_off(h);
 }
-int MSG_host_is_on(sg_host_t h)
+int MSG_host_is_on(const_sg_host_t h)
 {
   return sg_host_is_on(h);
 }
-int MSG_host_is_off(sg_host_t h)
-{
-  return sg_host_is_off(h);
-}
-xbt_dict_t MSG_host_get_properties(sg_host_t host)
+xbt_dict_t MSG_host_get_properties(const_sg_host_t host)
 {
   return sg_host_get_properties(host);
 }
-const char* MSG_host_get_property_value(sg_host_t host, const char* name)
+const char* MSG_host_get_property_value(const_sg_host_t host, const char* name)
 {
   return sg_host_get_property_value(host, name);
 }
@@ -289,7 +323,7 @@ void MSG_host_set_property_value(sg_host_t host, const char* name, const char* v
 {
   sg_host_set_property_value(host, name, value);
 }
-void MSG_host_get_process_list(sg_host_t host, xbt_dynar_t whereto)
+void MSG_host_get_process_list(const_sg_host_t host, xbt_dynar_t whereto)
 {
   sg_host_get_actor_list(host, whereto);
 }
@@ -298,9 +332,9 @@ sg_host_t MSG_host_self()
   return sg_host_self();
 }
 
-double MSG_host_get_load(sg_host_t host)
+double MSG_host_get_load(const_sg_host_t host)
 {
-  return sg_host_load(host);
+  return sg_host_get_load(host);
 }
 /* ************************** Virtual Machines *************************** */
 sg_vm_t MSG_vm_create_core(sg_host_t pm, const char* name)
@@ -311,19 +345,19 @@ sg_vm_t MSG_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
 {
   return sg_vm_create_multicore(pm, name, coreAmount);
 }
-int MSG_vm_is_created(sg_vm_t vm)
+int MSG_vm_is_created(const_sg_vm_t vm)
 {
   return sg_vm_is_created(vm);
 }
-int MSG_vm_is_running(sg_vm_t vm)
+int MSG_vm_is_running(const_sg_vm_t vm)
 {
   return sg_vm_is_running(vm);
 }
-int MSG_vm_is_suspended(sg_vm_t vm)
+int MSG_vm_is_suspended(const_sg_vm_t vm)
 {
   return sg_vm_is_suspended(vm);
 }
-const char* MSG_vm_get_name(sg_vm_t vm)
+const char* MSG_vm_get_name(const_sg_vm_t vm)
 {
   return sg_vm_get_name(vm);
 }
@@ -331,11 +365,11 @@ void MSG_vm_set_ramsize(sg_vm_t vm, size_t size)
 {
   sg_vm_set_ramsize(vm, size);
 }
-size_t MSG_vm_get_ramsize(sg_vm_t vm)
+size_t MSG_vm_get_ramsize(const_sg_vm_t vm)
 {
   return sg_vm_get_ramsize(vm);
 }
-sg_host_t MSG_vm_get_pm(sg_vm_t vm)
+sg_host_t MSG_vm_get_pm(const_sg_vm_t vm)
 {
   return sg_vm_get_pm(vm);
 }
@@ -369,7 +403,7 @@ sg_bar_t MSG_barrier_init(unsigned int count)
   return sg_barrier_init(count);
 }
 
-void MSG_barrier_destroy(sg_bar_t bar)
+void MSG_barrier_destroy(const_sg_bar_t bar)
 {
   sg_barrier_destroy(bar);
 }
@@ -395,15 +429,15 @@ void MSG_sem_release(sg_sem_t sem)
 {
   sg_sem_release(sem);
 }
-int MSG_sem_get_capacity(sg_sem_t sem)
+int MSG_sem_get_capacity(const_sg_sem_t sem)
 {
   return sg_sem_get_capacity(sem);
 }
-void MSG_sem_destroy(sg_sem_t sem)
+void MSG_sem_destroy(const_sg_sem_t sem)
 {
   sg_sem_destroy(sem);
 }
-int MSG_sem_would_block(sg_sem_t sem)
+int MSG_sem_would_block(const_sg_sem_t sem)
 {
   return sg_sem_would_block(sem);
 }