Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
I forgot to update my tree before commiting (once again), and got conflicts as punishment
[simgrid.git] / include / msg / msg.h
index 2805298..d28939b 100644 (file)
 #include "xbt.h"
 
 #include "msg/datatypes.h"
+#include "xbt/automaton.h"
+
+#include "simgrid/simix.h"
+
 SG_BEGIN_DECL()
 
+/** @brief Return code of most MSG functions
+    @ingroup msg_simulation
+    @{ */
+/* 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 ******************************************/
 XBT_PUBLIC(void) MSG_config(const char *name, ...);
 XBT_PUBLIC(void) MSG_global_init(int *argc, char **argv);
 XBT_PUBLIC(void) MSG_global_init_args(int *argc, char **argv);
-XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
-XBT_PUBLIC(int) MSG_get_channel_number(void);
 XBT_PUBLIC(MSG_error_t) MSG_main(void);
+XBT_PUBLIC(MSG_error_t) MSG_main_stateful(void);
+XBT_PUBLIC(MSG_error_t) MSG_main_liveness(xbt_automaton_t a, char *prgm);
 XBT_PUBLIC(MSG_error_t) MSG_clean(void);
 XBT_PUBLIC(void) MSG_function_register(const char *name,
                                        xbt_main_func_t code);
@@ -31,10 +52,18 @@ XBT_PUBLIC(void) MSG_set_function(const char *host_id,
                                   const char *function_name,
                                   xbt_dynar_t arguments);
 
-XBT_INLINE XBT_PUBLIC(double) MSG_get_clock(void);
+XBT_PUBLIC(double) MSG_get_clock(void);
 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
 
 
+/************************** File handling ***********************************/
+XBT_PUBLIC(size_t) MSG_file_read(const char* storage, void* ptr, size_t size, size_t nmemb, msg_file_t stream);
+XBT_PUBLIC(size_t) MSG_file_write(const char* storage, const void* ptr, size_t size, size_t nmemb, msg_file_t stream);
+XBT_PUBLIC(msg_file_t) MSG_file_open(const char* storage, const char* path, const char* mode);
+XBT_PUBLIC(int) MSG_file_close(const char* storage, msg_file_t fp);
+XBT_PUBLIC(int) MSG_file_stat(const char* storage, msg_file_t fd, s_msg_stat_t *buf);
+
+
 /************************** Host handling ***********************************/
 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
 XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host);
@@ -44,6 +73,7 @@ XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
 /* int MSG_get_msgload(void); This function lacks specification; discard it */
 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
 XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h);
+XBT_PUBLIC(void) __MSG_host_destroy(m_host_t host);
 
 /*property handlers*/
 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host);
@@ -54,8 +84,7 @@ XBT_PUBLIC(void) MSG_create_environment(const char *file);
 XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
 
 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
-XBT_PUBLIC(int) MSG_get_host_number(void);
-XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
+XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
 
 /************************** Process handling *********************************/
 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
@@ -73,6 +102,7 @@ XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char
                                                             code,
                                                             void *data,
                                                             m_host_t host,
+                                                            double kill_time,
                                                             int argc,
                                                             char **argv,
                                                             xbt_dict_t
@@ -80,11 +110,12 @@ XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char
 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
 
-XBT_PUBLIC(MSG_error_t) MSG_process_change_host(m_host_t host);
+XBT_PUBLIC(MSG_error_t) MSG_process_migrate(m_process_t process, m_host_t host);
 
 XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process);
 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process,
                                              void *data);
+XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
@@ -93,6 +124,7 @@ XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process);
 XBT_PUBLIC(int) MSG_process_self_PID(void);
 XBT_PUBLIC(int) MSG_process_self_PPID(void);
 XBT_PUBLIC(m_process_t) MSG_process_self(void);
+XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
 
 /*property handlers*/
 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process);
@@ -105,10 +137,13 @@ XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
 
 /************************** Task handling ************************************/
-
 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name,
                                      double compute_duration,
                                      double message_size, void *data);
+XBT_PUBLIC(m_gpu_task_t) MSG_gpu_task_create(const char *name,
+                                     double compute_duration,
+                                     double dispatch_latency,
+                                     double collect_latency);
 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name,
                                               int host_nb,
                                               const m_host_t * host_list,
@@ -117,46 +152,23 @@ XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name,
                                               void *data);
 XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task);
 XBT_PUBLIC(void) MSG_task_set_data(m_task_t task, void *data);
+XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
+    m_task_t task, m_process_t src, m_process_t dst));
 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
 XBT_PUBLIC(void) MSG_task_set_name(m_task_t task, const char *name);
 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
-XBT_PUBLIC(void) MSG_task_refcount_dec(m_task_t task);
 
-XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
-XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
-                                                  m_channel_t channel,
-                                                  double max_duration);
-XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task,
-                                               int channel, m_host_t host);
-MSG_error_t MSG_task_receive_from_host(m_task_t * task, const char *alias,
+XBT_PUBLIC(MSG_error_t) MSG_task_receive_from_host(m_task_t * task, const char *alias,
                                        m_host_t host);
-XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
-                                         double max_duration,
-                                         m_host_t host);
-
 
-XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
-                                     m_channel_t channel);
-XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
-                                             m_host_t dest,
-                                             m_channel_t channel,
-                                             double max_rate);
-XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
-                                                  m_host_t dest,
-                                                  m_channel_t channel,
-                                                  double max_duration);
 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
 
-XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
-XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
-XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
-XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
 
 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
 XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task,
@@ -177,16 +189,25 @@ XBT_PUBLIC(MSG_error_t)
 
 XBT_PUBLIC(MSG_error_t)
     MSG_task_receive(m_task_t * task, const char *alias);
+#define MSG_task_recv(t,a) MSG_task_receive(t,a)
 
 XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias);
+XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(m_task_t task,
+                                                    const char *alias,
+                                                    int (*match_fun)(void*,void*, smx_action_t),
+                                                    void *match_data);
+
+XBT_PUBLIC(void) MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup);
 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias);
 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
+XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
 XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
                                   double timeout);
 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
 XBT_PUBLIC(m_task_t) MSG_comm_get_task(msg_comm_t comm);
+XBT_PUBLIC(MSG_error_t) MSG_comm_get_status(msg_comm_t comm);
 
 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
 
@@ -205,6 +226,9 @@ XBT_PUBLIC(MSG_error_t)
 
 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
 
+XBT_PUBLIC(void) MSG_task_set_category (m_task_t task, const char *category);
+XBT_PUBLIC(const char *) MSG_task_get_category (m_task_t task);
+
 /************************** Task handling ************************************/
 XBT_PUBLIC(MSG_error_t)
     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
@@ -215,27 +239,56 @@ XBT_PUBLIC(MSG_error_t)
                              double timeout);
 
 /************************** Action handling **********************************/
-typedef void (*msg_action_fun) (xbt_dynar_t args);
+typedef void (*msg_action_fun) (const char *const *args);
 XBT_PUBLIC(void) MSG_action_register(const char *action_name,
                                      msg_action_fun function);
 XBT_PUBLIC(void) MSG_action_unregister(const char *action_name);
 MSG_error_t MSG_action_trace_run(char *path);
 
-
 #ifdef MSG_USE_DEPRECATED
 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
+XBT_PUBLIC(int) MSG_get_host_number(void);
+XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
+
 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
+#define MSG_TASK_CANCELLED MSG_TASK_CANCELED
 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
 
+#define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
+XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
+
+XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
+XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task,
+                                                  m_channel_t channel,
+                                                  double max_duration);
+XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task,
+                                               int channel, m_host_t host);
+XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel,
+                                         double max_duration,
+                                         m_host_t host);
+XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest,
+                                     m_channel_t channel);
+XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
+                                             m_host_t dest,
+                                             m_channel_t channel,
+                                             double max_rate);
+XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task,
+                                                  m_host_t dest,
+                                                  m_channel_t channel,
+                                                  double max_duration);
+XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
+XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
+XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
+
+XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
+XBT_PUBLIC(int) MSG_get_channel_number(void);
 #endif
 
 #include "instr/instr.h"
 
 /* Used only by the bindings */
-#include "simix/simix.h"
 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process);
 
-
 SG_END_DECL()
 #endif