Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid
[simgrid.git] / include / msg / msg.h
index 314269d..3be2d06 100644 (file)
@@ -28,12 +28,11 @@ typedef enum {
       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;
+} msg_error_t;
 /** @} */
 
-
 /************************** Global ******************************************/
-XBT_PUBLIC(void) MSG_config(const char *name, ...);
+XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
 /** \ingroup msg_simulation
  *  \brief Initialize the MSG internal data.
  *  \hideinitializer
@@ -56,8 +55,7 @@ XBT_PUBLIC(void) MSG_config(const char *name, ...);
        }
 
 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
-XBT_PUBLIC(MSG_error_t) MSG_main(void);
-XBT_PUBLIC(MSG_error_t) MSG_clean(void);
+XBT_PUBLIC(msg_error_t) MSG_main(void);
 XBT_PUBLIC(void) MSG_function_register(const char *name,
                                        xbt_main_func_t code);
 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
@@ -78,10 +76,18 @@ XBT_PUBLIC(size_t) MSG_file_write(const void* ptr, size_t size, size_t nmemb, ms
 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* mount, const char* path, const char* mode);
 XBT_PUBLIC(int) MSG_file_close(msg_file_t fp);
 XBT_PUBLIC(int) MSG_file_stat(msg_file_t fd, s_msg_stat_t *buf);
+XBT_PUBLIC(void) MSG_file_free_stat(s_msg_stat_t *stat);
+
+XBT_PUBLIC(int) MSG_file_unlink(msg_file_t fd);
+XBT_PUBLIC(xbt_dict_t) MSG_file_ls(const char *mount, const char *path);
 
+/************************** AS Router handling ************************************/
+XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
+XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
+XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
 
 /************************** Host handling ***********************************/
-XBT_PUBLIC(MSG_error_t) MSG_host_set_data(msg_host_t host, void *data);
+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);
 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
@@ -89,7 +95,7 @@ XBT_PUBLIC(int) MSG_get_host_msgload(msg_host_t host);
 /* int MSG_get_msgload(void); This function lacks specification; discard it */
 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
 XBT_PUBLIC(int) MSG_host_is_avail(msg_host_t h);
-XBT_PUBLIC(void) __MSG_host_destroy(msg_host_t host);
+XBT_PUBLIC(void) __MSG_host_destroy(msg_host_priv_t host);
 
 /*property handlers*/
 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
@@ -101,10 +107,10 @@ XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
 
 
 XBT_PUBLIC(void) MSG_create_environment(const char *file);
-XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file);
 
 XBT_PUBLIC(msg_host_t) MSG_get_host_by_name(const char *name);
 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
+XBT_PUBLIC(int) MSG_get_host_number(void);
 
 /************************** Process handling *********************************/
 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
@@ -129,10 +135,10 @@ XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
 
-XBT_PUBLIC(MSG_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
+XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
 
 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
-XBT_PUBLIC(MSG_error_t) MSG_process_set_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_set_data_cleanup(void_f_pvoid_t data_cleanup);
 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
@@ -144,7 +150,9 @@ XBT_PUBLIC(int) MSG_process_self_PID(void);
 XBT_PUBLIC(int) MSG_process_self_PPID(void);
 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
-XBT_PUBLIC(MSG_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
+XBT_PUBLIC(int) MSG_process_get_number(void);
+
+XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
 
 /*property handlers*/
 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
@@ -152,17 +160,19 @@ 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);
+XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
+XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_t fun, void *data);
 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
 
+XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
+
 /************************** Task handling ************************************/
 XBT_PUBLIC(msg_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,
+XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
                                      double compute_duration,
                                      double dispatch_latency,
                                      double collect_latency);
@@ -180,17 +190,17 @@ XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
-XBT_PUBLIC(MSG_error_t) MSG_task_cancel(msg_task_t task);
-XBT_PUBLIC(MSG_error_t) MSG_task_destroy(msg_task_t task);
+XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
+XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
 
-XBT_PUBLIC(MSG_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
+XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
                                        msg_host_t host);
 
-XBT_PUBLIC(MSG_error_t) MSG_task_execute(msg_task_t task);
-XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(msg_task_t task);
+XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
+XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
 
-XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
+XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
 
 XBT_PUBLIC(double) MSG_task_get_compute_duration(msg_task_t task);
 XBT_PUBLIC(void) MSG_task_set_compute_duration(msg_task_t task,
@@ -201,19 +211,20 @@ XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
 XBT_PUBLIC(double) MSG_task_get_data_size(msg_task_t task);
 
 
-XBT_PUBLIC(MSG_error_t)
+XBT_PUBLIC(msg_error_t)
     MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
                      msg_host_t host);
 
-XBT_PUBLIC(MSG_error_t)
+XBT_PUBLIC(msg_error_t)
     MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
                               double timeout);
 
-XBT_PUBLIC(MSG_error_t)
+XBT_PUBLIC(msg_error_t)
     MSG_task_receive(msg_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(msg_task_t task, const char *alias);
+XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
                                                     const char *alias,
                                                     int (*match_fun)(void*,void*, smx_action_t),
@@ -224,26 +235,26 @@ XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_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(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(msg_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(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
 
 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
 
 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
                                           msg_host_t host);
 
-XBT_PUBLIC(MSG_error_t)
+XBT_PUBLIC(msg_error_t)
     MSG_task_send_with_timeout(msg_task_t task, const char *alias,
                            double timeout);
 
-XBT_PUBLIC(MSG_error_t)
+XBT_PUBLIC(msg_error_t)
     MSG_task_send(msg_task_t task, const char *alias);
 
-XBT_PUBLIC(MSG_error_t)
+XBT_PUBLIC(msg_error_t)
     MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
 
 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
@@ -252,23 +263,28 @@ XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
 
 /************************** Task handling ************************************/
-XBT_PUBLIC(MSG_error_t)
+XBT_PUBLIC(msg_error_t)
     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
                          msg_host_t host, double timeout);
 
-XBT_PUBLIC(MSG_error_t)
+XBT_PUBLIC(msg_error_t)
     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
                              double timeout);
 
+void MSG_mailbox_set_async(const char *alias);
+
+
 /************************** Action handling **********************************/
-MSG_error_t MSG_action_trace_run(char *path);
+XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
 
 #ifdef MSG_USE_DEPRECATED
+
+typedef msg_error_t MSG_error_t;
+
 #define MSG_global_init(argc, argv)      MSG_init(argc,argv)
 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
 
 /* 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(msg_host_t *) MSG_get_host_table(void);
 
 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
@@ -277,24 +293,26 @@ XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
         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_get_errno(void);
 
-XBT_PUBLIC(MSG_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
-XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(msg_task_t * task,
+XBT_PUBLIC(msg_error_t) MSG_clean(void);
+
+XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
+XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
                                                   m_channel_t channel,
                                                   double max_duration);
-XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(msg_task_t * task,
+XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
                                                int channel, msg_host_t host);
-XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
+XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
                                          double max_duration,
                                          msg_host_t host);
-XBT_PUBLIC(MSG_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
+XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
                                      m_channel_t channel);
-XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(msg_task_t task,
+XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
                                              msg_host_t dest,
                                              m_channel_t channel,
                                              double max_rate);
-XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(msg_task_t task,
+XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
                                                   msg_host_t dest,
                                                   m_channel_t channel,
                                                   double max_duration);
@@ -302,12 +320,10 @@ 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, msg_host_t host);
 
-XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
+XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
 XBT_PUBLIC(int) MSG_get_channel_number(void);
 #endif
 
-#include "instr/instr.h"
-
 /** @brief Opaque type describing a Virtual Machine.
  *  @ingroup msg_VMs
  *
@@ -316,9 +332,8 @@ XBT_PUBLIC(int) MSG_get_channel_number(void);
  * Usual lack of guaranty of any kind applies here, and is even increased.
  *
  */
-typedef struct msg_vm *msg_vm_t;
 /* This function should not be called directly, but rather from MSG_vm_start_from_template that does not exist yet*/
-XBT_PUBLIC(msg_vm_t) MSG_vm_start(msg_host_t location, int coreAmount);
+XBT_PUBLIC(msg_vm_t) MSG_vm_start(msg_host_t location, const char *name, int coreAmount);
 
 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
@@ -336,6 +351,8 @@ XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);  // Simulate the fact of reading th
 
 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm); // killall
 
+XBT_PUBLIC(void) MSG_vm_reboot(msg_vm_t vm);
+
 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
 
 XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
@@ -359,11 +376,19 @@ xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
 + des fonctions de filtrage sur les dynar
 */
+#include "instr/instr.h"
+
 
 
 /* ****************************************************************************************** */
 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
 
+/* ****************************************************************************************** */
+/* TUTORIAL: New API                                                                        */
+/* Declare all functions for the API                                                          */
+/* ****************************************************************************************** */
+XBT_PUBLIC(int) MSG_new_API_fct(const char* param1, double param2);
+
 SG_END_DECL()
 #endif