Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Only adds the XBT_PUBLIC macro decoration a the begining of the public API functions.
[simgrid.git] / include / msg / msg.h
index ac4b7da..b5c21a7 100644 (file)
 #ifndef MSG_H
 #define MSG_H
 
-#include "msg/datatypes.h"
+#include "xbt/misc.h"
 
-/************************** MSG **********************************************/
-void MSG_global_init(void);
-void MSG_set_verbosity(MSG_outputmode_t mode);
-MSG_error_t MSG_set_channel_number(int number);
-MSG_error_t MSG_set_sharing_policy(MSG_sharing_t mode, long double param);
-int MSG_get_channel_number(void);
-MSG_error_t MSG_main(void);
-MSG_error_t MSG_clean(void);
-
-MSG_error_t MSG_routing_table_init(void);
-MSG_error_t MSG_routing_table_set(m_host_t host1, m_host_t host2,
-                                 m_link_t link);
-m_link_t MSG_routing_table_get(m_host_t host1, m_host_t host2);
-
-/************************** Management ***************************************/
-m_host_t MSG_host_create(const char *name,
-                                       char *trace_file,
-                                       long double fixed_cpu,
-                                       char* failure_trace,
-                                       long double fixed_failure,
-                                       void *data);
-
-MSG_error_t MSG_host_set_data(m_host_t host, void *data);
-void *MSG_host_get_data(m_host_t host);
-int MSG_host_get_PID(m_host_t host);
-int MSG_process_get_PPID(m_process_t process);
-const char *MSG_host_get_name(m_host_t host);
-m_host_t MSG_host_from_PID(int PID);
-m_host_t MSG_host_self(void);
-MSG_error_t MSG_host_destroy(m_host_t host);
-
-int MSG_get_host_msgload(m_host_t host);
-int MSG_get_msgload(void);
-
-
-void MSG_link_set_sharing_value(long double alpha);
-m_link_t MSG_link_create(const char *name,
-                        char *lat_trace_file, long double fixed_latency,
-                        char *bw_trace_file, long double fixed_bandwidth);
-MSG_error_t MSG_link_destroy(m_link_t link);
-m_link_t MSG_link_merge(const char *name, m_link_t src1, m_link_t src2);
-
-
-m_task_t MSG_task_create(const char *name, long double compute_duration,
-                        long double message_size, void *data);
-void *MSG_task_get_data(m_task_t task);
-MSG_error_t MSG_task_destroy(m_task_t task);
-
-m_process_t MSG_process_create(const char *name,
+#include "msg/datatypes.h"
+SG_BEGIN_DECL()
+
+
+/************************** 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_clean(void);
+XBT_PUBLIC void MSG_function_register(const char *name, m_process_code_t code);
+XBT_PUBLIC m_process_code_t MSG_get_registered_function(const char *name);
+XBT_PUBLIC void MSG_launch_application(const char *file);
+XBT_PUBLIC void MSG_paje_output(const char *filename);
+
+XBT_PUBLIC double MSG_get_clock(void);
+
+/************************** 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);
+XBT_PUBLIC const char *MSG_host_get_name(m_host_t host);
+XBT_PUBLIC m_host_t MSG_host_self(void);
+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_create_environment(const char *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);
+
+/************************** Process handling *********************************/
+XBT_PUBLIC m_process_t MSG_process_create(const char *name,
                               m_process_code_t code, void *data,
                               m_host_t host);
-
-MSG_error_t MSG_process_change_host(m_process_t process, m_host_t host);
-
-void *MSG_process_get_data(m_process_t process);
-MSG_error_t MSG_process_set_data(m_process_t process, void *data);
-m_host_t MSG_process_get_host(m_process_t process);
-m_process_t MSG_process_from_PID(int PID);
-int MSG_process_get_PID(m_process_t process);
-const char *MSG_process_get_name(m_process_t process);
-int MSG_process_self_PID(void);
-int MSG_process_self_PPID(void);
-m_process_t MSG_process_self(void);
-
-MSG_error_t MSG_process_suspend(m_process_t process);
-MSG_error_t MSG_process_resume(m_process_t process);
-int MSG_process_isSuspended(m_process_t process);
-
-MSG_error_t MSG_process_start(m_process_t process);
-
-
-/************************** GOS **********************************************/
-MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel);
-MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, 
+XBT_PUBLIC m_process_t MSG_process_create_with_arguments(const char *name,
+                                             m_process_code_t code, void *data,
+                                             m_host_t host, int argc, char **argv);
+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_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 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);
+XBT_PUBLIC int MSG_process_get_PPID(m_process_t process);
+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 MSG_error_t MSG_process_suspend(m_process_t process);
+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_task_t MSG_parallel_task_create(const char *name, 
+                                 int host_nb,
+                                 const m_host_t *host_list,
+                                 double *computation_amount,
+                                 double *communication_amount,
+                                 void *data);
+XBT_PUBLIC void *MSG_task_get_data(m_task_t task);
+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 MSG_error_t MSG_task_cancel(m_task_t task);
+XBT_PUBLIC MSG_error_t MSG_task_destroy(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_time_out(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_put(m_task_t task, m_host_t dest, 
                         m_channel_t channel);
-MSG_error_t MSG_task_execute(m_task_t task);
-int MSG_task_Iprobe(m_channel_t channel);
-void MSG_process_sleep(long double nb_sec);
-void MSG_tracelink(m_host_t dest, const char* **names, int *count);
-MSG_error_t MSG_get_errno(void);
-
-/************************** GIS **********************************************/
-void MSG_create_environment(const char *file);
-
-m_host_t MSG_get_host_by_name(const char *name);
-m_link_t MSG_get_link_by_name(const char *name);
-int MSG_get_host_number(void);
-m_host_t *MSG_get_host_table(void);
-void MSG_function_register(const char *name, m_process_code_t code);
-m_process_code_t MSG_get_registered_function(const char *name);
-void MSG_launch_application(const char *file);
-
-MSG_error_t MSG_get_arguments(int *argc, char ***argv);
-MSG_error_t MSG_set_arguments(m_process_t process,int argc, char *argv[]);
-
-long double MSG_getClock(void);
-
-/************************** FS **********************************************/
-/*  MSG_error_t MSG_get_cpu(m_host_t * h, long double time, long double *val); */
-/*  MSG_error_t MSG_get_bw(m_link_t * h, long double time, long double *val); */
-/*  MSG_error_t MSG_get_lat(m_link_t * h, long double time, long double *val); */
-
+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_channel_select_from(m_channel_t channel, double max_duration,
+                                   int *PID);
+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 double MSG_task_get_remaining_computation(m_task_t task);
+XBT_PUBLIC double MSG_task_get_data_size(m_task_t task);
+
+SG_END_DECL()
 #endif