Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
code is now splint'able; add a MSG_task_get_name
[simgrid.git] / include / msg / msg.h
1 /*      $Id$     */
2
3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #ifndef MSG_H
9 #define MSG_H
10
11 #include "xbt/misc.h"
12 #include "xbt/sysdep.h"
13
14 BEGIN_DECL()
15 #include "msg/datatypes.h"
16
17 /************************** Global ******************************************/
18 void MSG_global_init(void);
19 void MSG_global_init_args(int *argc, char **argv);
20 void MSG_set_verbosity(MSG_outputmode_t mode);
21 MSG_error_t MSG_set_channel_number(int number);
22 MSG_error_t MSG_set_sharing_policy(MSG_sharing_t mode, double param);
23 int MSG_get_channel_number(void);
24 MSG_error_t MSG_main(void);
25 MSG_error_t MSG_clean(void);
26 void MSG_function_register(const char *name, m_process_code_t code);
27 m_process_code_t MSG_get_registered_function(const char *name);
28 void MSG_launch_application(const char *file);
29 void MSG_paje_output(const char *filename);
30
31 double MSG_getClock(void);
32
33 /************************** Host handling ***********************************/
34 MSG_error_t MSG_host_set_data(m_host_t host, void *data);
35 void *MSG_host_get_data(m_host_t host);
36 const char *MSG_host_get_name(m_host_t host);
37 m_host_t MSG_host_self(void);
38 int MSG_get_host_msgload(m_host_t host);
39 int MSG_get_msgload(void);
40
41 void MSG_create_environment(const char *file);
42
43 m_host_t MSG_get_host_by_name(const char *name);
44 int MSG_get_host_number(void);
45 m_host_t *MSG_get_host_table(void);
46
47 /************************** Process handling *********************************/
48 m_process_t MSG_process_create(const char *name,
49                                m_process_code_t code, void *data,
50                                m_host_t host);
51 m_process_t MSG_process_create_with_arguments(const char *name,
52                                               m_process_code_t code, void *data,
53                                               m_host_t host, int argc, char **argv);
54 void MSG_process_kill(m_process_t process);
55 int MSG_process_killall(int reset_PIDs);
56 MSG_error_t MSG_get_arguments(int *argc, char ***argv);
57 MSG_error_t MSG_set_arguments(m_process_t process,int argc, char *argv[]);
58
59 MSG_error_t MSG_process_change_host(m_process_t process, m_host_t host);
60
61 void *MSG_process_get_data(m_process_t process);
62 MSG_error_t MSG_process_set_data(m_process_t process, void *data);
63 m_host_t MSG_process_get_host(m_process_t process);
64 m_process_t MSG_process_from_PID(int PID);
65 int MSG_process_get_PID(m_process_t process);
66 int MSG_process_get_PPID(m_process_t process);
67 const char *MSG_process_get_name(m_process_t process);
68 int MSG_process_self_PID(void);
69 int MSG_process_self_PPID(void);
70 m_process_t MSG_process_self(void);
71
72 MSG_error_t MSG_process_suspend(m_process_t process);
73 MSG_error_t MSG_process_resume(m_process_t process);
74 int MSG_process_isSuspended(m_process_t process);
75
76 MSG_error_t MSG_process_start(m_process_t process);
77
78 /************************** Task handling ************************************/
79
80 m_task_t MSG_task_create(const char *name, double compute_duration,
81                          double message_size, void *data);
82 void *MSG_task_get_data(m_task_t task);
83 m_process_t MSG_task_get_sender(m_task_t task);
84 const char *MSG_task_get_name(m_task_t task);
85
86 MSG_error_t MSG_task_destroy(m_task_t task);
87
88 MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel);
89 MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, 
90                          m_channel_t channel);
91 MSG_error_t MSG_task_put_bounded(m_task_t task,
92                                  m_host_t dest, m_channel_t channel,
93                                  double max_rate);
94 MSG_error_t MSG_task_execute(m_task_t task);
95 int MSG_task_Iprobe(m_channel_t channel);
96 int MSG_task_probe_from(m_channel_t channel);
97 MSG_error_t MSG_process_sleep(double nb_sec);
98 MSG_error_t MSG_get_errno(void);
99
100 /************************** Deprecated ***************************************/
101 /* MSG_error_t MSG_routing_table_init(void); */
102 /* MSG_error_t MSG_routing_table_set(m_host_t host1, m_host_t host2, */
103 /*                                m_link_t link); */
104 /* m_link_t MSG_routing_table_get(m_host_t host1, m_host_t host2); */
105 /* m_host_t MSG_host_create(const char *name, */
106 /*                      char *trace_file, */
107 /*                      long double fixed_cpu, */
108 /*                      char* failure_trace, */
109 /*                      long double fixed_failure, */
110 /*                      void *data); */
111 /* m_host_t MSG_host_from_PID(int PID); */
112 /* MSG_error_t MSG_host_destroy(m_host_t host); */
113
114 /* void MSG_link_set_sharing_value(long double alpha); */
115 /* m_link_t MSG_link_create(const char *name, */
116 /*                       char *lat_trace_file, long double fixed_latency, */
117 /*                       char *bw_trace_file, long double fixed_bandwidth); */
118 /* MSG_error_t MSG_link_destroy(m_link_t link); */
119 /* m_link_t MSG_link_merge(const char *name, m_link_t src1, m_link_t src2); */
120 /* m_link_t MSG_get_link_by_name(const char *name); */
121 /* void MSG_tracelink(m_host_t dest, const char* **names, int *count); */
122 END_DECL()
123 #endif