Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Got bored during a meeting: fix the copyright notice of several useless files (found...
[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.h"
12
13 #include "msg/datatypes.h"
14 SG_BEGIN_DECL()
15
16
17 /************************** Global ******************************************/
18 XBT_PUBLIC(void) MSG_config(const char *name, ...);
19 XBT_PUBLIC(void) MSG_global_init(int *argc, char **argv);
20 XBT_PUBLIC(void) MSG_global_init_args(int *argc, char **argv);
21 XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
22 XBT_PUBLIC(int) MSG_get_channel_number(void);
23 XBT_PUBLIC(MSG_error_t) MSG_main(void);
24 XBT_PUBLIC(MSG_error_t) MSG_clean(void);
25 XBT_PUBLIC(void) MSG_function_register(const char *name, xbt_main_func_t code);
26 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
27 XBT_PUBLIC(void) MSG_launch_application(const char *file);
28 XBT_PUBLIC(void) MSG_paje_output(const char *filename);
29
30 XBT_PUBLIC(double) MSG_get_clock(void);
31
32 /************************** Host handling ***********************************/
33 XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data);
34 XBT_PUBLIC(void*) MSG_host_get_data(m_host_t host);
35 XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host);
36 XBT_PUBLIC(m_host_t) MSG_host_self(void);
37 XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host);
38 /* int MSG_get_msgload(void); This function lacks specification; discard it */
39 XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h);
40 XBT_PUBLIC(int) MSG_host_is_avail (m_host_t h);
41
42 XBT_PUBLIC(void) MSG_create_environment(const char *file);
43
44 XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name);
45 XBT_PUBLIC(int) MSG_get_host_number(void);
46 XBT_PUBLIC(m_host_t *)MSG_get_host_table(void);
47
48 /************************** Process handling *********************************/
49 XBT_PUBLIC(m_process_t) MSG_process_create(const char *name,
50                                xbt_main_func_t code, void *data,
51                                m_host_t host);
52 XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name,
53                                               xbt_main_func_t code, void *data,
54                                               m_host_t host, int argc, char **argv);
55 XBT_PUBLIC(void) MSG_process_kill(m_process_t process);
56 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
57
58 XBT_PUBLIC(MSG_error_t) MSG_process_change_host(m_process_t process, m_host_t host);
59
60 XBT_PUBLIC(void*) MSG_process_get_data(m_process_t process);
61 XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process, void *data);
62 XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process);
63 XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID);
64 XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process);
65 XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process);
66 XBT_PUBLIC(const char *)MSG_process_get_name(m_process_t process);
67 XBT_PUBLIC(int) MSG_process_self_PID(void);
68 XBT_PUBLIC(int) MSG_process_self_PPID(void);
69 XBT_PUBLIC(m_process_t) MSG_process_self(void);
70
71 XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process);
72 XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process);
73 XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process);
74
75 /************************** Task handling ************************************/
76
77 XBT_PUBLIC(m_task_t) MSG_task_create(const char *name, double compute_duration,
78                          double message_size, void *data);
79 XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name, 
80                                   int host_nb,
81                                   const m_host_t *host_list,
82                                   double *computation_amount,
83                                   double *communication_amount,
84                                   void *data);
85 XBT_PUBLIC(void*) MSG_task_get_data(m_task_t task);
86 XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task);
87 XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task);
88 XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task);
89 XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task);
90 XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task);
91
92 XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
93 XBT_PUBLIC(MSG_error_t) MSG_task_get_with_time_out(m_task_t * task, m_channel_t channel,
94                                        double max_duration);
95 XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, int channel, 
96                                    m_host_t host);
97 XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest, 
98                          m_channel_t channel);
99 XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task,
100                                  m_host_t dest, m_channel_t channel,
101                                  double max_rate);
102 XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task, m_host_t dest, 
103                                       m_channel_t channel, double max_duration);
104 XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task);
105 XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task);
106 XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority);
107
108 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
109 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
110 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
111 XBT_PUBLIC(MSG_error_t) MSG_channel_select_from(m_channel_t channel, double max_duration,
112                                     int *PID);
113 XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec);
114 XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
115
116 XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task);
117 XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task);
118 XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task);
119
120 SG_END_DECL()
121 #endif