Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Put XBT_ATTRIB_DEPRECATED at proper place.
[simgrid.git] / include / simgrid / msg.h
index b66155e..29ce2e3 100644 (file)
 namespace simgrid {
 namespace msg {
 class Comm;
+class Task;
 }
 }
 typedef simgrid::msg::Comm sg_msg_Comm;
+/** @brief Task datatype.
+ *
+ *  Since most scheduling algorithms rely on a concept of task  that can be either <em>computed</em> locally or
+ *  <em>transferred</em> on another processor, it seems to be the right level of abstraction for our purposes.
+ *  A <em>task</em> may then be defined by a <em>computing amount</em>, a <em>message size</em> and
+ *  some <em>private data</em>.
+ */
+typedef simgrid::msg::Task* msg_task_t;
 #else
 typedef struct msg_Comm sg_msg_Comm;
+typedef struct msg_Task* msg_task_t;
 #endif
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/** @brief Return code of most MSG functions */
+/* Keep these code as binary values: java bindings manipulate | of these values */
+typedef enum {
+  MSG_OK               = 0, /**< @brief Everything is right. Keep on going this way ! */
+  MSG_TIMEOUT          = 1, /**< @brief nothing good happened before the timer you provided elapsed */
+  MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task
+    transfer. Either the network is down or the remote host has been
+    shutdown. */
+  MSG_HOST_FAILURE = 4,     /**< @brief System shutdown. The host on which you are
+    running has just been rebooted. Free your datastructures and
+    return now !*/
+  MSG_TASK_CANCELED = 8     /**< @brief Canceled task. This task has been canceled by somebody!*/
+} msg_error_t;
+
 /* *************************** Network Zones ******************************** */
 #define msg_as_t msg_netzone_t /* portability macro */
 
@@ -96,18 +120,18 @@ XBT_PUBLIC int MSG_host_get_pstate(sg_host_t host);
 XBT_PUBLIC void MSG_host_set_pstate(sg_host_t host, int pstate);
 /** @brief Start the host if it is off
  *
- * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
+ * See also #MSG_host_is_on() to test the current state of the host and @ref SURF_plugin_energy
  * for more info on DVFS.
  */
 XBT_PUBLIC void MSG_host_on(sg_host_t h);
 /** @brief Stop the host if it is on
  *
- * See also MSG_host_is_on() and MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
+ * See also MSG_host_is_on() to test the current state of the host and @ref SURF_plugin_energy
  * for more info on DVFS.
  */
 XBT_PUBLIC void MSG_host_off(sg_host_t h);
 XBT_PUBLIC int MSG_host_is_on(sg_host_t h);
-XBT_PUBLIC int MSG_host_is_off(sg_host_t h);
+XBT_ATTRIB_DEPRECATED_v325("Please use !MSG_host_is_on()") XBT_PUBLIC int MSG_host_is_off(sg_host_t h);
 XBT_PUBLIC xbt_dict_t MSG_host_get_properties(sg_host_t host);
 XBT_PUBLIC const char* MSG_host_get_property_value(sg_host_t host, const char* name);
 XBT_PUBLIC void MSG_host_set_property_value(sg_host_t host, const char* name, const char* value);
@@ -209,6 +233,8 @@ XBT_PUBLIC void MSG_process_killall();
 XBT_PUBLIC void MSG_process_set_kill_time(msg_process_t process, double kill_time);
 /** @brief Yield the current actor; let the other actors execute first */
 XBT_PUBLIC void MSG_process_yield();
+/*** @brief Sleep for the specified number of seconds */
+XBT_PUBLIC msg_error_t MSG_process_sleep(double nb_sec);
 
 /** @brief Object representing an ongoing communication between processes.
  *
@@ -220,43 +246,10 @@ typedef sg_msg_Comm* msg_comm_t;
 
 /* ******************************** Task ************************************ */
 
-typedef struct s_simdata_task_t* simdata_task_t;
-
-typedef struct msg_task {
-  char* name;             /**< @brief task name if any */
-  simdata_task_t simdata; /**< @brief simulator data */
-  void* data;             /**< @brief user data */
-  long long int counter;  /* task unique identifier for instrumentation */
-  char* category;         /* task category for instrumentation */
-} s_msg_task_t;
-
-/** @brief Task datatype.
- *
- *  Since most scheduling algorithms rely on a concept of task  that can be either <em>computed</em> locally or
- *  <em>transferred</em> on another processor, it seems to be the right level of abstraction for our purposes.
- *  A <em>task</em> may then be defined by a <em>computing amount</em>, a <em>message size</em> and
- *  some <em>private data</em>.
- */
-
-typedef struct msg_task* msg_task_t;
 
 /** @brief Default value for an uninitialized #msg_task_t. */
 #define MSG_TASK_UNINITIALIZED NULL
 
-/** @brief Return code of most MSG functions */
-/* Keep these code as binary values: java bindings manipulate | of these values */
-typedef enum {
-  MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
-  MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
-  MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
-      transfer. Either the network is down or the remote host has been
-      shutdown. */
-  MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
-      running has just been rebooted. Free your datastructures and
-      return now !*/
-  MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
-} msg_error_t;
-
 /************************** Global ******************************************/
 /** @brief set a configuration variable
  *
@@ -336,7 +329,7 @@ XBT_PUBLIC int MSG_process_get_number();
 XBT_PUBLIC void* MSG_process_get_data(msg_process_t process);
 XBT_PUBLIC msg_error_t MSG_process_set_data(msg_process_t process, void* data);
 
-XBT_PUBLIC void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void* data);
+XBT_PUBLIC void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data);
 
 XBT_PUBLIC void MSG_process_ref(msg_process_t process);
 XBT_PUBLIC void MSG_process_unref(msg_process_t process);
@@ -361,8 +354,6 @@ XBT_PUBLIC msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, d
 XBT_PUBLIC void MSG_task_set_priority(msg_task_t task, double priority);
 XBT_PUBLIC void MSG_task_set_bound(msg_task_t task, double bound);
 
-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_PUBLIC double MSG_task_get_flops_amount(msg_task_t task);
 XBT_PUBLIC double MSG_task_get_remaining_work_ratio(msg_task_t task);
@@ -450,9 +441,8 @@ XBT_PUBLIC int MSG_barrier_wait(msg_bar_t bar);
 
 /* ****************************************************************************************** */
 /* DO NOT USE this nasty pimple (unless if you're writing a binding) */
-XBT_PUBLIC smx_context_t
 XBT_ATTRIB_DEPRECATED_v323("MSG_process_get_smx_ctx is deprecated. Please contact us if you need it.")
-MSG_process_get_smx_ctx(msg_process_t process);
+    XBT_PUBLIC smx_context_t MSG_process_get_smx_ctx(msg_process_t process);
 
 #ifdef __cplusplus
 }