Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
replace msg_io by a C sg_* interface to S4U
[simgrid.git] / include / simgrid / msg.h
index b3284ad..b885231 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2018. 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. */
@@ -6,9 +6,9 @@
 #ifndef MSG_H
 #define MSG_H
 
-#include "simgrid/datatypes.h"
 #include "simgrid/forward.h"
 #include "simgrid/host.h"
+#include "simgrid/plugins/live_migration.h"
 
 #include "xbt/base.h"
 #include "xbt/dict.h"
@@ -169,107 +169,33 @@ XBT_PUBLIC(const char*) MSG_zone_get_property_value(msg_netzone_t as, const char
 XBT_PUBLIC(void) MSG_zone_set_property_value(msg_netzone_t netzone, const char* name, char* value);
 XBT_PUBLIC(void) MSG_zone_get_hosts(msg_netzone_t zone, xbt_dynar_t whereto);
 
-XBT_ATTRIB_DEPRECATED_v319(
-    "Use MSG_zone_get_root() instead: v3.19 will turn this warning into an error.") static inline msg_netzone_t
-    MSG_environment_get_routing_root()
-{
-  return MSG_zone_get_root();
-}
-XBT_ATTRIB_DEPRECATED_v319(
-    "Use MSG_zone_get_name() instead: v3.19 will turn this warning into an error.") static inline const
-    char* MSG_environment_as_get_name(msg_netzone_t zone)
-{
-  return MSG_zone_get_name(zone);
-}
-XBT_ATTRIB_DEPRECATED_v319(
-    "Use MSG_zone_get_by_name() instead: v3.19 will turn this warning into an error.") static inline msg_netzone_t
-    MSG_environment_as_get_by_name(const char* name)
-{
-  return MSG_zone_get_by_name(name);
-}
-XBT_ATTRIB_DEPRECATED_v319(
-    "Use MSG_zone_get_sons() instead: v3.19 will turn this warning into an error.") static inline xbt_dict_t
-    MSG_environment_as_get_routing_sons(msg_netzone_t zone)
-{
-  xbt_dict_t res = xbt_dict_new_homogeneous(NULL);
-  MSG_zone_get_sons(zone, res);
-  return res;
-}
-XBT_ATTRIB_DEPRECATED_v319(
-    "Use MSG_zone_get_property_value() instead: v3.19 will turn this warning into an error.") static inline const
-    char* MSG_environment_as_get_property_value(msg_netzone_t zone, const char* name)
-{
-  return MSG_zone_get_property_value(zone, name);
-}
-XBT_ATTRIB_DEPRECATED_v319(
-    "Use MSG_zone_set_property_value() instead: v3.19 will remove MSG_environment_as_set_property_value() "
-    "completely.") static inline void MSG_environment_as_set_property_value(msg_netzone_t zone, const char* name,
-                                                                            char* value)
-{
-  MSG_zone_set_property_value(zone, name, value);
-}
-XBT_ATTRIB_DEPRECATED_v319("Use MSG_zone_get_hosts() instead: v3.19 will remove MSG_environment_as_get_hosts() "
-                           "completely.") static inline xbt_dynar_t MSG_environment_as_get_hosts(msg_netzone_t zone)
-{
-  xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), NULL);
-  MSG_zone_get_hosts(zone, res);
-  return res;
-}
-
-/************************** File handling ***********************************/
-XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
-XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
-XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
-XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
-XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
-XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
-XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
-XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
-XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
-XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin);
-XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
-XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t file);
-XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
-XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
-XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
 /************************** Storage handling ***********************************/
-XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
-XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
-XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
-XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
-XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
-XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char* name, char* value);
-XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
-XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar();
-XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
-XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
-XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
-XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
-XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
+XBT_PUBLIC(const char*) sg_storage_get_name(sg_storage_t storage);
+#define MSG_storage_get_name(storage) sg_storage_get_name(storage)
+XBT_PUBLIC(sg_storage_t) sg_storage_get_by_name(const char* name);
+#define MSG_storage_get_by_name(name) sg_storage_get_by_name(name)
+XBT_PUBLIC(xbt_dict_t) sg_storage_get_properties(sg_storage_t storage);
+#define MSG_storage_get_properties(storage) sg_storage_get_properties(storage)
+XBT_PUBLIC(void) sg_storage_set_property_value(sg_storage_t storage, const char* name, char* value);
+#define MSG_storage_set_property_value(storage, name, value) sg_storage_set_property_value(storage, name, value)
+XBT_PUBLIC(const char*) sg_storage_get_property_value(sg_storage_t storage, const char* name);
+#define MSG_storage_get_property_value(storage, name) sg_storage_get_property_value(storage, name)
+XBT_PUBLIC(xbt_dynar_t) sg_storages_as_dynar();
+#define MSG_storages_as_dynar() sg_storages_as_dynar()
+XBT_PUBLIC(void) sg_storage_set_data(sg_storage_t host, void* data);
+#define MSG_storage_set_data(storage, data) sg_storage_set_data(storage, data)
+XBT_PUBLIC(void*) sg_storage_get_data(sg_storage_t storage);
+#define MSG_storage_get_data(storage) sg_storage_get_data(storage)
+XBT_PUBLIC(const char*) sg_storage_get_host(sg_storage_t storage);
+#define MSG_storage_get_host(storage) sg_storage_get_host(storage)
+XBT_PUBLIC(sg_size_t) sg_storage_read(sg_storage_t storage, sg_size_t size);
+#define MSG_storage_read(storage, size) sg_storage_read(storage, size)
+XBT_PUBLIC(sg_size_t) sg_storage_write(sg_storage_t storage, sg_size_t size);
+#define MSG_storage_write(storage, size) sg_storage_write(storage, size)
 
 /************************** Host handling ***********************************/
-XBT_PUBLIC(msg_host_t) MSG_host_by_name(const char *name);
-#define MSG_get_host_by_name(n) MSG_host_by_name(n) /* Rewrite the old name into the new one transparently */
-XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
-XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
-/** \ingroup m_host_management
- *
- * \brief Return the name of the #msg_host_t. */
-#define MSG_host_get_name(host) sg_host_get_name(host)
-XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
-XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
-XBT_PUBLIC(msg_host_t) MSG_host_self();
-XBT_PUBLIC(double) MSG_host_get_speed(msg_host_t h);
-XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
 XBT_PUBLIC(void) MSG_host_get_process_list(msg_host_t h, xbt_dynar_t whereto);
-XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
-XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
 
-XBT_ATTRIB_DEPRECATED_v319("Use MSG_host_get_speed(): v3.19 will drop MSG_get_host_speed() "
-                           "completely.") static inline double MSG_get_host_speed(msg_host_t host)
-{
-  return MSG_host_get_speed(host);
-}
 XBT_ATTRIB_DEPRECATED_v320("Use MSG_host_get_speed(): v3.20 will drop MSG_host_get_current_power_peak() "
                            "completely.") static inline double MSG_host_get_current_power_peak(msg_host_t host)
 {
@@ -277,20 +203,6 @@ XBT_ATTRIB_DEPRECATED_v320("Use MSG_host_get_speed(): v3.20 will drop MSG_host_g
 }
 
 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
-XBT_PUBLIC(int)    MSG_host_get_nb_pstates(msg_host_t h);
-#define MSG_host_get_pstate(h) sg_host_get_pstate(h) /* users don't know that MSG is the C version of SimGrid */
-#define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate) /* (same here) */
-XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar();
-XBT_PUBLIC(int) MSG_get_host_number();
-XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
-XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
-XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
-
-/*property handlers*/
-XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
-XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
-                                                     const char *name);
-XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host, const char* name, char* value);
 
 XBT_PUBLIC(void) MSG_create_environment(const char *file);
 
@@ -333,9 +245,7 @@ XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double
 
 /*property handlers*/
 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
-XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
-                                                        process,
-                                                        const char *name);
+XBT_PUBLIC(const char*) MSG_process_get_property_value(msg_process_t process, const char* name);
 
 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
@@ -349,9 +259,7 @@ XBT_PUBLIC(void) MSG_process_ref(msg_process_t process);
 XBT_PUBLIC(void) MSG_process_unref(msg_process_t process);
 
 /************************** Task handling ************************************/
-XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
-                                     double flops_amount,
-                                     double bytes_amount, void *data);
+XBT_PUBLIC(msg_task_t) MSG_task_create(const char* name, double flops_amount, double bytes_amount, void* data);
 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
                                               int host_nb,
                                               const msg_host_t * host_list,
@@ -379,17 +287,12 @@ XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
 
 XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task, double flops_amount);
-XBT_ATTRIB_DEPRECATED_v321("Use MSG_task_get_initial_flops_amount if you want to get initial amounts of flops, or "
-                           "Use MSG_task_get_remaining_work_ratio to get task progress (in order "
-                           "to compute progress in flops)") XBT_PUBLIC(double)
-    MSG_task_get_flops_amount(msg_task_t task);
-XBT_PUBLIC(double) MSG_task_get_initial_flops_amount(msg_task_t task);
+XBT_PUBLIC(double) MSG_task_get_flops_amount(msg_task_t task);
 XBT_PUBLIC(double) MSG_task_get_remaining_work_ratio(msg_task_t task);
 XBT_PUBLIC(void) MSG_task_set_bytes_amount(msg_task_t task, double bytes_amount);
 
 
 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
-XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
 XBT_PUBLIC(double) MSG_task_get_bytes_amount(msg_task_t task);
 
 XBT_PUBLIC(msg_error_t) MSG_task_receive_ext(msg_task_t* task, const char* alias, double timeout, msg_host_t host);
@@ -485,36 +388,43 @@ XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
  *
  */
 
-XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t vm);
-XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t vm);
-XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t vm);
-XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t vm);
-
-XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t vm);
-XBT_PUBLIC(void) MSG_vm_get_params(msg_vm_t vm, vm_params_t params);
-XBT_PUBLIC(void) MSG_vm_set_params(msg_vm_t vm, vm_params_t params);
-
-// TODO add VDI later
-XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
-XBT_PUBLIC(msg_vm_t) MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount);
-XBT_PUBLIC(msg_vm_t)
-MSG_vm_create(msg_host_t ind_pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity);
-
-XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
-
-XBT_PUBLIC(void) MSG_vm_start(msg_vm_t vm);
-
-/* Shutdown the guest operating system. */
-XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
-
-XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
-
-/* Suspend the execution of the VM, but keep its state on memory. */
-XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
-XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
-
-XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
-XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
+XBT_PUBLIC(int) sg_vm_is_created(sg_vm_t vm);
+#define MSG_vm_is_created(vm) sg_vm_is_created(vm)
+XBT_PUBLIC(int) sg_vm_is_running(sg_vm_t vm);
+#define MSG_vm_is_running(vm) sg_vm_is_running(vm)
+XBT_PUBLIC(int) sg_vm_is_suspended(sg_vm_t vm);
+#define MSG_vm_is_suspended(vm) sg_vm_is_suspended(vm)
+
+XBT_PUBLIC(const char*) sg_vm_get_name(sg_vm_t vm);
+#define MSG_vm_get_name(vm) sg_vm_get_name(vm)
+XBT_PUBLIC(void) sg_vm_set_ramsize(sg_vm_t vm, size_t size);
+#define MSG_vm_set_ramsize(vm, size) sg_vm_set_ramsize(vm, size)
+XBT_PUBLIC(size_t) sg_vm_get_ramsize(sg_vm_t vm);
+#define MSG_vm_get_ramsize(vm) sg_vm_get_ramsize(vm)
+
+XBT_PUBLIC(sg_vm_t) sg_vm_create_core(sg_host_t pm, const char* name);
+#define MSG_vm_create_core(vm, name) sg_vm_create_core(vm, name)
+XBT_PUBLIC(sg_vm_t) sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount);
+#define MSG_vm_create_multicore(vm, name, coreAmount) sg_vm_create_multicore(vm, name, coreAmount)
+
+XBT_ATTRIB_DEPRECATED_v322("Use sg_vm_create_migratable() from the live migration plugin: "
+                           "v3.22 will drop MSG_vm_create() completely.") XBT_PUBLIC(msg_vm_t)
+    MSG_vm_create(msg_host_t ind_pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity);
+
+XBT_PUBLIC(void) sg_vm_start(msg_vm_t vm);
+#define MSG_vm_start(vm) sg_vm_start(vm)
+XBT_PUBLIC(void) sg_vm_suspend(msg_vm_t vm);
+#define MSG_vm_suspend(vm) sg_vm_suspend(vm)
+XBT_PUBLIC(void) sg_vm_resume(msg_vm_t vm);
+#define MSG_vm_resume(vm) sg_vm_resume(vm)
+XBT_PUBLIC(void) sg_vm_shutdown(msg_vm_t vm);
+#define MSG_vm_shutdown(vm) sg_vm_shutdown(vm)
+XBT_PUBLIC(void) sg_vm_destroy(msg_vm_t vm);
+#define MSG_vm_destroy(vm) sg_vm_destroy(vm)
+XBT_PUBLIC(sg_host_t) sg_vm_get_pm(sg_vm_t vm);
+#define MSG_vm_get_pm(vm) sg_vm_get_pm(vm)
+XBT_PUBLIC(void) sg_vm_set_bound(sg_vm_t vm, double bound);
+#define MSG_vm_set_bound(vm, bound) sg_vm_set_bound(vm, bound)
 
 #include "simgrid/instr.h"